az apic api version

Note

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

API Center で API バージョンを管理するコマンド。

コマンド

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

az apic api version create

新しい API バージョンを作成するか、既存の API バージョンを更新します。

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service-name
                           --title
                           --version-id

例

API バージョンの作成

az apic api version create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01" --lifecycle-stage production

必須のパラメーター

--api-id

API の ID。

--lifecycle-stage

API の現在のライフサイクルステージ。

プロパティ	値
パラメーターグループ:	Properties Arguments
指定可能な値:	deprecated, design, development, preview, production, retired, testing

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--title

API バージョン。

プロパティ	値
パラメーターグループ:	Properties Arguments

--version-id

API バージョンの ID。

グローバルパラメーター

--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 version delete

指定した API バージョンを削除します。

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

例

API バージョンの削除

az apic api version delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--api-id

API の ID。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--ids

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--version-id

API バージョンの ID。

プロパティ	値
パラメーターグループ:	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 version list

API バージョンのコレクションを一覧表示します。

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

例

API バージョンの一覧表示

az apic api version list -g api-center-test -n contosoeuap --api-id echo-api

必須のパラメーター

--api-id

API の ID。

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--filter

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

--max-items

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

プロパティ	値
パラメーターグループ:	Pagination Arguments

--next-token

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

プロパティ	値
パラメーターグループ:	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 version show

API バージョンの詳細を取得します。

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

例

API バージョンの詳細を表示する

az apic api version show -g api-center-test -n contoso --api-id echo-api --version-id 2023-01-01

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--api-id

API の ID。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--version-id

API バージョンの ID。

プロパティ	値
パラメーターグループ:	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 version update

既存の API バージョンを更新します。

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

例

API バージョンの更新

az apic api version update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--api-id

API の ID。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--force-string

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--lifecycle-stage

API の現在のライフサイクルステージ。

プロパティ	値
パラメーターグループ:	Properties Arguments
指定可能な値:	deprecated, design, development, preview, production, retired, testing

--remove

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--resource-group -g

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--set

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--subscription

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--title

API バージョン。

プロパティ	値
パラメーターグループ:	Properties Arguments

--version-id

API バージョンの ID。

プロパティ	値
パラメーターグループ:	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 version

コマンド

az apic api version create

例

必須のパラメーター

az apic api version delete

例

オプションのパラメーター

az apic api version list

例

必須のパラメーター

オプションのパラメーター

az apic api version show

例

オプションのパラメーター

az apic api version update

例

オプションのパラメーター

フィードバック