次の方法で共有

az apic api deployment

  • リファレンス

手記

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

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

コマンド

名前 説明 型 状態
az apic api deployment create

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

 延長 ジョージア 州
az apic api deployment delete

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

 延長 ジョージア 州
az apic api deployment list

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

 延長 ジョージア 州
az apic api deployment show

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

 延長 ジョージア 州
az apic api deployment update

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

 延長 ジョージア 州

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。

--deployment-id

API デプロイの ID。

--environment-id

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

--resource-group -g

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

--server

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

--service-name -n

Azure API Center サービスの名前。

--title

デプロイ タイトル。

省略可能のパラメーター

--custom-properties

API カタログ エンティティに対して定義されたカスタム メタデータ。 json-file と yaml-file をサポートします。

--description

デプロイの説明。

グローバル パラメーター
--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

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

--subscription

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

--verbose

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

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

省略可能のパラメーター

--api-id

API の ID。

--deployment-id

API デプロイの ID。

--ids

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--subscription

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

--yes -y

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

規定値: False
グローバル パラメーター
--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

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

--subscription

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

--verbose

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

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 サービスの名前。

省略可能のパラメーター

--filter

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

--max-items

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

--next-token

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

グローバル パラメーター
--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

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

--subscription

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

--verbose

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

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

省略可能のパラメーター

--api-id

API の ID。

--deployment-id

API デプロイの ID。

--ids

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--subscription

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

グローバル パラメーター
--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

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

--subscription

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

--verbose

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

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

省略可能のパラメーター

--add

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

--api-id

API の ID。

--custom-properties

API カタログ エンティティに対して定義されたカスタム メタデータ。 json-file と yaml-file をサポートします。

--definition-id

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

--deployment-id

API デプロイの ID。

--description

デプロイの説明。

--environment-id

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

--force-string

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

--remove

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

--resource-group -g

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

--server

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

--service-name -n

Azure API Center サービスの名前。

--set

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

--subscription

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

--title

タイトル。

グローバル パラメーター
--debug

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

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

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

--subscription

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

--verbose

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