次の方法で共有

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 バージョンを更新します。

 拡張子 GA
az apic api version delete

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

 拡張子 GA
az apic api version list

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

 拡張子 GA
az apic api version show

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

 拡張子 GA
az apic api version update

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

 拡張子 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 の現在のライフサイクル ステージ。

指定可能な値: deprecated, design, development, preview, production, retired, testing
--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--title

API バージョン。

--version-id

API バージョンの 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 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

省略可能のパラメーター

--api-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 を使用して、既定のサブスクリプションを構成できます。

--version-id

API バージョンの 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 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 サービスの名前。

省略可能のパラメーター

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

省略可能のパラメーター

--api-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 を使用して、既定のサブスクリプションを構成できます。

--version-id

API バージョンの 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 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"

省略可能のパラメーター

--add

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

--api-id

API の 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' 引数を指定する必要があります。

--lifecycle-stage

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

指定可能な値: deprecated, design, development, preview, production, retired, testing
--remove

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--set

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

--subscription

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

--title

API バージョン。

--version-id

API バージョンの 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 を使います。