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

az apim api release

管理 Azure API 管理 API 版本。

命令

名称	说明	类型	Status
az apim api release create	为 API 创建新版本。	Core	GA
az apim api release delete	删除 API 中的指定版本。	Core	GA
az apim api release list	列出 API 的所有版本。	Core	GA
az apim api release show	返回 API 版本的详细信息。	Core	GA
az apim api release update	更新由其标识符指定的 API 版本的详细信息。	Core	GA

az apim api release create

编辑

为 API 创建新版本。

az apim api release create --api-id
                           --api-revision
                           --resource-group
                           --service-name
                           [--if-match]
                           [--notes]
                           [--release-id]

示例

为 API 创建新版本。

az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes

必需参数

--api-id

API identifier. 当前 API 管理服务实例中必须是唯一的。非当前修订有;rev=n 作为后缀，其中 n 是修订号。

属性	值
Parameter group:	API Arguments

--api-revision

API 修订号。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

实体的 ETag。

--notes

Release Notes.

--release-id

API 中的发布标识符。当前 API 管理服务实例中必须是唯一的。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 release delete

编辑

删除 API 中的指定版本。

az apim api release delete --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--if-match]

示例

删除 API 中的指定版本。

az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

必需参数

--api-id

API identifier. 当前 API 管理服务实例中必须是唯一的。非当前修订有;rev=n 作为后缀，其中 n 是修订号。

属性	值
Parameter group:	API Arguments

--release-id

API 中的发布标识符。当前 API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

实体的 ETag。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 release list

编辑

列出 API 的所有版本。

az apim api release list --api-id
                         --resource-group
                         --service-name

示例

列出 API 的所有版本。

az apim api release list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

必需参数

--api-id

API identifier. 当前 API 管理服务实例中必须是唯一的。非当前修订有;rev=n 作为后缀，其中 n 是修订号。

属性	值
Parameter group:	API Arguments

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 release show

编辑

返回 API 版本的详细信息。

az apim api release show --api-id
                         --release-id
                         --resource-group
                         --service-name

示例

返回 API 版本的详细信息。

az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

必需参数

--api-id

API identifier. 当前 API 管理服务实例中必须是唯一的。非当前修订有;rev=n 作为后缀，其中 n 是修订号。

属性	值
Parameter group:	API Arguments

--release-id

API 中的发布标识符。当前 API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 release update

编辑

更新由其标识符指定的 API 版本的详细信息。

az apim api release update --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--add]
                           [--force-string]
                           [--if-match]
                           [--notes]
                           [--remove]
                           [--set]

示例

更新由其标识符指定的 API 版本的说明。

az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes

必需参数

--api-id

API identifier. 当前 API 管理服务实例中必须是唯一的。非当前修订有;rev=n 作为后缀，其中 n 是修订号。

属性	值
Parameter group:	API Arguments

--release-id

API 中的发布标识符。当前 API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

属性	值
Parameter group:	Generic Update Arguments
默认值:	[]

--force-string

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

属性	值
Parameter group:	Generic Update Arguments
默认值:	False

--if-match

实体的 ETag。

--notes

Release Notes.

--remove

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

属性	值
Parameter group:	Generic Update Arguments
默认值:	[]

--set

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

属性	值
Parameter group:	Generic Update Arguments
默认值:	[]

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	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 release

命令

az apim api release create

示例

必需参数

可选参数

az apim api release delete

示例

必需参数

可选参数

az apim api release list

示例

必需参数

az apim api release show

示例

必需参数

az apim api release update

示例

必需参数

可选参数

反馈