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

az apim backend

管理Azure API 管理后端。

命令

名称	说明	类型	Status
az apim backend create	创建或更新 API 管理后端。	核心	GA
az apim backend delete	删除 API 管理后端。	核心	GA
az apim backend list	列出 API 管理后端。	核心	GA
az apim backend show	显示 API 管理后端的详细信息。	核心	GA
az apim backend update	更新 API 管理后端。	核心	GA

az apim backend create

编辑

创建或更新 API 管理后端。

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

示例

创建后端。

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

必需参数

--backend-id

要创建或更新后端的唯一名称。

在当前 API 管理服务实例中必须是唯一的。

属性	值
参数组:	Backend Arguments

--protocol

用于与后端服务通信的协议。

属性	值
接受的值:	http, soap

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

--url

后端服务的 URL。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性	值
参数组:	Global Policy Arguments

--change-reference

此资源操作的相关更改引用 ID。

属性	值
参数组:	Global Policy Arguments

--description

后端的说明。可能包括 HTML 格式标记。

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

编辑

删除 API 管理后端。

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

示例

删除 APIM 实例中的后端。

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

必需参数

--backend-id

后端的标识符。

属性	值
参数组:	Backend Arguments

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性	值
参数组:	Global Policy Arguments

--change-reference

此资源操作的相关更改引用 ID。

属性	值
参数组:	Global Policy Arguments

--if-match

实体的 ETag。

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

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az apim backend list

编辑

列出 API 管理后端。

az apim backend list --resource-group
                     --service-name

示例

列出 APIM 实例中的所有后端。

az apim backend list --resource-group MyResourceGroup --service-name MyServiceName

必需参数

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

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

编辑

显示 API 管理后端的详细信息。

az apim backend show --backend-id
                     --resource-group
                     --service-name

示例

显示 APIM 实例中后端的详细信息。

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

必需参数

--backend-id

后端的标识符。

属性	值
参数组:	Backend Arguments

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

全局参数

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

编辑

更新 API 管理后端。

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

示例

更新后端。

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

必需参数

--backend-id

要更新的后端的唯一名称。

在当前 API 管理服务实例中必须是唯一的。

属性	值
参数组:	Backend Arguments

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性	值
参数组:	Global Policy Arguments

--add

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

属性	值
参数组:	Generic Update Arguments
默认值:	[]

--change-reference

此资源操作的相关更改引用 ID。

属性	值
参数组:	Global Policy Arguments

--description

后端的说明。可能包括 HTML 格式标记。

--force-string

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

属性	值
参数组:	Generic Update Arguments
默认值:	False

--if-match

实体的 ETag。创建实体时不需要，但更新实体时需要。默认值为无。

--protocol

用于与后端服务通信的协议。可能的值包括： http、 soap。

属性	值
接受的值:	http, soap

--remove

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

属性	值
参数组:	Generic Update Arguments
默认值:	[]

--set

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

属性	值
参数组:	Generic Update Arguments
默认值:	[]

--url

后端服务 URL。

全局参数

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

反馈

此页面是否有帮助？