你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az apim api versionset

参考

管理 Azure API 管理 API 版本集。

命令

名称	说明	类型	状态
az apim api versionset create	创建 Api 版本集。	核心	GA
az apim api versionset delete	删除特定的 API 版本集。	核心	GA
az apim api versionset list	列出指定服务实例中的 API 版本集集合。	核心	GA
az apim api versionset show	获取由标识符指定的 Api 版本集的详细信息。	核心	GA
az apim api versionset update	汇报其标识符指定的 Api VersionSet 的详细信息。	核心	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

必需。 API 版本集的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--service-name -n

API 管理服务实例的名称。

--versioning-scheme

必需。一个值，该值确定 API 版本标识器将位于 HTTP 请求中的位置。可能的值包括：“Segment”、“Query”、“Header”。

可选参数

--description

API 版本集的说明。

--if-match

实体的 ETag。

--version-header-name

如果 versioningScheme 设置为 header，则指示 API 版本的 HTTP 标头参数的名称。

--version-query-name

如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。

--version-set-id

相关 ApiVersionSet 的资源标识符。

全局参数

--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 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 管理服务实例的名称。

--version-set-id

相关 ApiVersionSet 的资源标识符。

可选参数

--if-match

实体的 ETag。

全局参数

--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 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 管理服务实例的名称。

全局参数

--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 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 管理服务实例的名称。

--version-set-id

相关 ApiVersionSet 的资源标识符。

全局参数

--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 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 管理服务实例的名称。

--version-set-id

相关 ApiVersionSet 的资源标识符。

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

默认值: []

--description

API 版本集的说明。

--display-name

必需。 API 版本集的名称。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

默认值: False

--if-match

实体的 ETag。

--remove

从列表中删除属性或元素。示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

默认值: []

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

默认值: []

--version-header-name

如果 versioningScheme 设置为 header，则指示 API 版本的 HTTP 标头参数的名称。

--version-query-name

如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。

--versioning-scheme

必需。一个值，该值确定 API 版本标识器将位于 HTTP 请求中的位置。可能的值包括：“Segment”、“Query”、“Header”。

全局参数

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

命令

az apim api versionset create

示例

必需参数

可选参数

az apim api versionset delete

示例

必需参数

可选参数

az apim api versionset list

示例

必需参数

az apim api versionset show

示例

必需参数

az apim api versionset update

示例

必需参数

可选参数

其他资源