構成でのタイプ プロバイダの呼び出し

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

このページでは、Deployment Manager で作成したタイプ プロバイダの使用方法について説明します。タイプ プロバイダの作成方法については説明しません。タイプ プロバイダの作成方法については、タイプ プロバイダの作成をご覧ください。

始める前に

• このガイドのコマンドラインの例を使用する場合、gcloud コマンドライン ツールをインストールします。
• このガイドの API の例を使用する場合は、API アクセスを設定します。

タイプ プロバイダへのアクセス

タイプ プロバイダはプロジェクトごとのリソースで、アクセス制御のドキュメントに記載されている権限に従い、アクセスが可能です。つまり、次のようになります。

• プロジェクトの編集者と閲覧者は、そのプロジェクトで使用できるタイプを作成して使用できます。
• タイプの閲覧者は、そのプロジェクトで使用できるタイプの一覧を取得し、タイプを使用できます。

タイプ閲覧者として別のプロジェクトを追加し、タイプにアクセスできるようにすることもできます。詳しくは、プロジェクト間でのタイプの共有をご覧ください。

タイプ プロバイダの使用

タイプ プロバイダによって公開されたタイプを構成で使用するには、次の構文を使用します。

type: [PROJECT_ID]/[TYPE_NAME]:[COLLECTION]

• この API が OpenAPI 仕様に基づく場合、[COLLECTION] がリソースへのパスの REST 識別子になります。次に例を示します。

  type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people
  

• API が Google Discovery ドキュメントに基づくものである場合、[COLLECTION] は API 内の目的のリソースへのパスです。たとえば、サービス アカウント キーを作成するには、コレクションは次のようになります。

  type: my-project/example-type-provider:projects.serviceAccounts.keys
  

ここで、基盤の API で必要とされるタイプの構成を続行します。

resources:
- name: Jane
  type: my-project/emailAddressesTypeProvider:emailAddresses/v1beta/people
  properties:
  - displayName: Jane
    email: jane@example.com
    ...

次のステップ

• 設定の作成について読みます。
• デプロイを作成します。
• タイプ プロバイダを作成する方法について学びます。
• API 詳細オプションの詳細について学びます。