az apim api versionset

Azure API Management API バージョン セットを管理します。

コマンド

名前	説明	型	状態
az apim api versionset create	API バージョン セットを作成します。	Core	GA
az apim api versionset delete	特定の API バージョン セットを削除します。	Core	GA
az apim api versionset list	指定したサービス インスタンス内の API バージョン セットのコレクションを一覧表示します。	Core	GA
az apim api versionset show	識別子で指定された API バージョン セットの詳細を取得します。	Core	GA
az apim api versionset update	識別子で指定された Api VersionSet の詳細を更新します。	Core	GA

az apim api versionset create

API バージョン セットを作成します。

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

例

バージョン スキーマをヘッダーとして使用して API バージョン セットを作成します。

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

バージョン スキーマをクエリとして使用して API バージョン セットを作成します。

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

必須のパラメーター

--display-name

Required. API バージョン セットの名前。

--resource-group -g

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

--service-name -n

API Management サービス インスタンスの名前。

--versioning-scheme

Required. API バージョン識別子が HTTP 要求内の場所を決定する値。 指定できる値は、'Segment'、'Query'、'Header' です。

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

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

--description

API バージョン セットの説明。

--if-match

エンティティの ETag。

--version-header-name

versioningScheme が headerに設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。

--version-query-name

versioningScheme が queryに設定されている場合に API バージョンを示すクエリ パラメーターの名前。

--version-set-id

関連する ApiVersionSet のリソース識別子。

グローバル パラメーター

--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 apim api versionset delete

特定の API バージョン セットを削除します。

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

例

特定の API バージョン セットを削除します。

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

必須のパラメーター

--resource-group -g

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

--service-name -n

API Management サービス インスタンスの名前。

--version-set-id

関連する ApiVersionSet のリソース識別子。

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

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

--if-match

エンティティの ETag。

グローバル パラメーター

--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 apim api versionset list

指定したサービス インスタンス内の API バージョン セットのコレクションを一覧表示します。

az apim api versionset list --resource-group
                            --service-name

例

指定したサービス インスタンス内の API バージョン セットのコレクションを一覧表示します。

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

必須のパラメーター

--resource-group -g

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

--service-name -n

API Management サービス インスタンスの名前。

グローバル パラメーター

--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 apim api versionset show

識別子で指定された API バージョン セットの詳細を取得します。

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

例

識別子で指定された API バージョン セットの詳細を取得します。

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

必須のパラメーター

--resource-group -g

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

--service-name -n

API Management サービス インスタンスの名前。

--version-set-id

関連する ApiVersionSet のリソース識別子。

グローバル パラメーター

--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 apim api versionset update

識別子で指定された Api VersionSet の詳細を更新します。

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

例

識別子で指定された Api VersionSet の説明、表示名を更新します。

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

識別子で指定された Api VersionSet のバージョン スキーマを更新します。

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

必須のパラメーター

--resource-group -g

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

--service-name -n

API Management サービス インスタンスの名前。

--version-set-id

関連する ApiVersionSet のリソース識別子。

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

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

--add

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

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

--description

API バージョン セットの説明。

--display-name

Required. API バージョン セットの名前。

--force-string

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

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

--if-match

エンティティの ETag。

--remove

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

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

--set

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

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

--version-header-name

versioningScheme が headerに設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。

--version-query-name

versioningScheme が queryに設定されている場合に API バージョンを示すクエリ パラメーターの名前。

--versioning-scheme

Required. API バージョン識別子が HTTP 要求内の場所を決定する値。 指定できる値は、'Segment'、'Query'、'Header' です。

グローバル パラメーター

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