az apic api deployment

Note

このリファレンスは、Azure CLI (バージョン 2.57.0 以降) の apic-extension 拡張機能の一部です。 az apic api deployment コマンドを初めて実行すると、拡張機能が自動的にインストールされます。拡張機能の詳細については、を参照してください。

API Center で API デプロイを管理するコマンド。

コマンド

名前	説明	型	状態
az apic api deployment create	新しい API デプロイを作成するか、既存の API デプロイを更新します。	Extension	GA
az apic api deployment delete	API デプロイを削除します。	Extension	GA
az apic api deployment list	API デプロイのコレクションを一覧表示します。	Extension	GA
az apic api deployment show	API デプロイの詳細を取得します。	Extension	GA
az apic api deployment update	既存の API デプロイを更新します。	Extension	GA

az apic api deployment create

新しい API デプロイを作成するか、既存の API デプロイを更新します。

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

例

デプロイメントの作成

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

サーバー json ファイルを使用してデプロイを作成する

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

必須のパラメーター

--api-id

API の ID。

--definition-id

API センタースコープの定義リソース ID。

プロパティ	値
Parameter group:	Properties Arguments

--deployment-id

API デプロイの ID。

--environment-id

API センタースコープの環境リソース ID。

プロパティ	値
Parameter group:	Properties Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--server

Server Support shorthand-syntax, json-file and yaml-file. 詳細を表示するには、"??" を試してください。

プロパティ	値
Parameter group:	Properties Arguments

--service-name -n

Azure API Center サービスの名前。

--title

デプロイタイトル。

プロパティ	値
Parameter group:	Properties Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--custom-properties

API カタログエンティティに対して定義されたカスタムメタデータ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

プロパティ	値
Parameter group:	Properties Arguments

--description

デプロイの説明。

プロパティ	値
Parameter group:	Properties Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic api deployment delete

API デプロイを削除します。

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

例

API デプロイの削除

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

API の ID。

プロパティ	値
Parameter group:	Resource Id Arguments

--deployment-id

API デプロイの ID。

プロパティ	値
Parameter group:	Resource Id Arguments

--ids

1 つ以上のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
Parameter group:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
Parameter group:	Resource Id Arguments

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic api deployment list

API デプロイのコレクションを一覧表示します。

az apic api deployment list --api-id
                            --resource-group
                            --service-name
                            [--filter]
                            [--max-items]
                            [--next-token]

例

API デプロイを一覧表示する

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

必須のパラメーター

--api-id

API の ID。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

Azure API Center サービスの名前。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

OData フィルターパラメーター。

--max-items

コマンドの出力で返される項目の合計数。使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ	値
Parameter group:	Pagination Arguments

--next-token

ページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられた応答からのトークン値です。

プロパティ	値
Parameter group:	Pagination Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic api deployment show

API デプロイの詳細を取得します。

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]

例

API デプロイの詳細を表示する

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

API の ID。

プロパティ	値
Parameter group:	Resource Id Arguments

--deployment-id

API デプロイの ID。

プロパティ	値
Parameter group:	Resource Id Arguments

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
Parameter group:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
Parameter group:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
Parameter group:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic api deployment update

既存の API デプロイを更新します。

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

例

API のデプロイを更新する

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
Parameter group:	Generic Update Arguments

--api-id

API の ID。

プロパティ	値
Parameter group:	Resource Id Arguments

--custom-properties

プロパティ	値
Parameter group:	Properties Arguments

--definition-id

サービススコープの定義リソース ID。

プロパティ	値
Parameter group:	Properties Arguments

--deployment-id

API デプロイの ID。

プロパティ	値
Parameter group:	Resource Id Arguments

--description

デプロイの説明。

プロパティ	値
Parameter group:	Properties Arguments

--environment-id

サービススコープの環境リソース ID。

プロパティ	値
Parameter group:	Properties Arguments

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
Parameter group:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--ids

プロパティ	値
Parameter group:	Resource Id Arguments

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
Parameter group:	Generic Update Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
Parameter group:	Resource Id Arguments

--server

Server Support shorthand-syntax, json-file and yaml-file. 詳細を表示するには、"??" を試してください。

プロパティ	値
Parameter group:	Properties Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
Parameter group:	Resource Id Arguments

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

プロパティ	値
Parameter group:	Generic Update Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
Parameter group:	Resource Id Arguments

--title

Title.

プロパティ	値
Parameter group:	Properties Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az apic api deployment

コマンド

az apic api deployment create

例

必須のパラメーター

省略可能のパラメーター

az apic api deployment delete

例

省略可能のパラメーター

az apic api deployment list

例

必須のパラメーター

省略可能のパラメーター

az apic api deployment show

例

省略可能のパラメーター

az apic api deployment update

例

省略可能のパラメーター

フィードバック