このページでは、プロジェクトのタイプの記述、一覧表示、削除の方法について説明します。
始める前に
- このガイドのコマンドラインの例を使用する場合、gcloud コマンドライン ツールをインストールします。
- このガイドの API の例を使用する場合は、API アクセスを設定します。
- このガイドの API の例を使用する場合、v2beta API アクセスを設定します。
タイプ プロバイダの記述
タイプ プロバイダは、タイプとして Deployment Manager に統合された API です。1 つのタイプ プロバイダについて記述したり、すべてのタイプ プロバイダのリストを取得したり、タイプ プロバイダで提供されるすべてのタイプのリストを取得したりできます。
1 つのタイプ プロバイダの記述
記述子ドキュメントの URL やこの API に設定された拡張 API オプションなどの情報を取得するためのタイプ プロバイダについて記述できます。
デフォルトの Google Cloud タイプ プロバイダのリストをご覧ください。
gcloud
type-providers describe コマンドを実行してタイプ プロバイダを記述します。
gcloud beta deployment-manager type-providers describe PROVIDER_NAME --project PROJECT_ID
たとえば、次のコマンドを使用して、Pub/Sub タイプ プロバイダを記述します。
gcloud beta deployment-manager type-providers describe pubsub-v1 --project gcp-types
API
次の URI に GET リクエストを送信します。
https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/typeProviders/[PROVIDER_NAME]
たとえば、次の URI を Pub/Sub タイプ プロバイダに使用します。
https://www.googleapis.com/deploymentmanager/v2beta/projects/gcp-types/global/typeProviders/pubsub-v1
タイプ プロバイダで提供されているすべてのタイプのリストの取得
タイプ プロバイダは基本タイプとして基盤 API のすべてのリソースを公開します。タイプ プロバイダで提供される基本タイプのリストを取得できます。
gcloud
タイプ プロバイダで提供される基本タイプのリストを取得するには:
gcloud beta deployment-manager types list --provider [TYPE_PROVIDER] --project [PROJECT_ID]
たとえば、Compute Engine タイプ プロバイダの基本タイプのリストを取得するには、次のコマンドを実行します。
gcloud beta deployment-manager types list --provider compute-v1 --project gcp-types
API
次の URI に GET リクエストを送信します。
GET https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/typeProviders/[PROVIDER_NAME]/types
たとえば、Compute Engine タイプ プロバイダのタイプのリストでは、次の URI を使用します。
GET https://www.googleapis.com/deploymentmanager/v2beta/projects/gcp-types/global/typeProviders/compute-v1/types
タイプ プロバイダの一覧表示
gcloud CLI または API を使用してタイプ プロバイダのリストを取得できます。
gcloud
タイプ プロバイダを一覧表示するには、type-providers list リクエストを行います。
gcloud beta deployment-manager type-providers list
API
API で、グローバル タイプ プロバイダ リストに対する GET リクエストを行います。
GET https://www.googleapis.com/deploymentmanager/v2/projects/[PROJECT_ID]/global/typeProviders
詳細については、list メソッドのドキュメントをご覧ください。
複合タイプの記述
複合タイプは、タイプとして Deployment Manager に永続的に追加された一連のテンプレートです。1 つの複合タイプを記述したり、プロジェクトで使用できる複合タイプのリストを取得したりできます。
1 つの複合タイプの記述
1 つの複合タイプを記述して、そのタイプに関する情報を取得できます。
gcloud
types describe コマンドを実行してタイプを記述します。
gcloud beta deployment-manager types describe [COMPOSITE_TYPE_NAME] --provider composite
API
次の URI に GET リクエストを送信します。
https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/compositeTypes/[COMPOSITE_TYPE_NAME]
複合タイプの一覧表示
gcloud CLI または API を使用して、複合タイプのリストを取得できます。
gcloud
複合タイプを一覧表示するには、types list リクエストを行います。
gcloud beta deployment-manager types list --provider composite
API
API で、グローバル タイプリストに対する GET リクエストを行います。
GET https://www.googleapis.com/deploymentmanager/v2/projects/[PROJECT_ID]/global/types
詳細については、list メソッドのドキュメントをご覧ください。
タイプ プロバイダの削除
gcloud
タイプ プロバイダを削除するには、type-providers delete リクエストを行います。例:
gcloud beta deployment-manager type-providers delete [TYPE_PROVIDER]
API
API で、削除するタイプ プロバイダに対する DELETE リクエストを行います。
DELETE https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/typeProviders/[TYPE_PROVIDER]
詳細については、delete メソッドのドキュメントをご覧ください。
複合タイプの削除
gcloud
複合タイプを削除するには、types delete リクエストを行います。例:
gcloud beta deployment-manager types delete [COMPOSITE_TYPE]
API
API で、削除するタイプに対する DELETE リクエストを行います。
DELETE https://www.googleapis.com/deploymentmanager/v2beta/projects/[PROJECT_ID]/global/compositeTypes/[COMPOSITE_TYPE]
詳細については、delete メソッドのドキュメントをご覧ください。
次のステップ
- タイプ プロバイダを使用する方法について学びます。
- 設定の作成について学びます。
- デプロイを作成します。
- タイプ プロバイダを作成する方法を学習する。