你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
az apim api
管理 Azure API 管理 API。
命令
| 名称 | 说明 | 类型 | 状态 |
|---|---|---|---|
| az apim api create |
创建API 管理 API。 |
核心 | GA |
| az apim api delete |
删除API 管理 API。 |
核心 | GA |
| az apim api export |
导出API 管理 API。 |
核心 | GA |
| az apim api import |
导入API 管理 API。 |
核心 | GA |
| az apim api list |
列出API 管理 API。 |
核心 | GA |
| az apim api operation |
管理 Azure API 管理 API 操作。 |
核心 | GA |
| az apim api operation create |
在 API 中创建一个新操作。 |
核心 | GA |
| az apim api operation delete |
删除 API 中的指定操作。 |
核心 | GA |
| az apim api operation list |
列出指定 API 的操作的集合。 |
核心 | GA |
| az apim api operation show |
获取由其标识符指定的 API 操作的详细信息。 |
核心 | GA |
| az apim api operation update |
汇报 API 中由其标识符指定的操作的详细信息。 |
核心 | GA |
| az apim api release |
管理 Azure API 管理 API 发布。 |
核心 | GA |
| az apim api release create |
为 API 创建新版本。 |
核心 | GA |
| az apim api release delete |
删除 API 中的指定版本。 |
核心 | GA |
| az apim api release list |
列出 API 的所有版本。 |
核心 | GA |
| az apim api release show |
返回 API 版本的详细信息。 |
核心 | GA |
| az apim api release update |
汇报由其标识符指定的 API 发布的详细信息。 |
核心 | GA |
| az apim api revision |
管理 Azure API 管理 API 修订版。 |
核心 | GA |
| az apim api revision create |
创建 API 修订。 |
核心 | GA |
| az apim api revision list |
列出 API 的所有修订版。 |
核心 | GA |
| az apim api schema |
管理 Azure API 管理 API 架构。 |
核心 | GA |
| az apim api schema create |
创建API 管理 API 架构。 |
核心 | GA |
| az apim api schema delete |
删除API 管理 API 架构。 |
核心 | GA |
| az apim api schema get-etag |
获取API 管理 API 架构的 etag。 |
核心 | GA |
| az apim api schema list |
列出API 管理 API 架构。 |
核心 | GA |
| az apim api schema show |
显示API 管理 API 架构的详细信息。 |
核心 | GA |
| az apim api schema wait |
将 CLI 置于等待状态，直到满足 apim API 架构的条件。 |
核心 | GA |
| az apim api show |
显示API 管理 API 的详细信息。 |
核心 | GA |
| az apim api update |
更新API 管理 API。 |
核心 | GA |
| az apim api versionset |
管理 Azure API 管理 API 版本集。 |
核心 | GA |
| 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 wait |
将 CLI 置于等待状态，直到满足 apim API 的条件。 |
核心 | GA |
az apim api create
创建API 管理 API。
az apim api create --api-id
--display-name
--path
--resource-group
--service-name
[--api-type {graphql, http, soap, websocket}]
[--authorization-scope]
[--authorization-server-id]
[--bearer-token-sending-methods]
[--description]
[--no-wait]
[--open-id-provider-id]
[--protocols {http, https, ws, wss}]
[--service-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-key-required]
[--subscription-required {false, true}]示例
创建基本 API。
az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'必需参数
要创建的 API 的唯一名称。
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
要创建的 API 的显示名称。
API 的路径。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
API 管理服务实例的名称。
可选参数
API 的类型。
指定 OAuth 操作范围。
指定 OAuth 授权服务器 ID。
指定持有者令牌的发送方法。
API 的说明。 可以包含 HTML 格式标记。
不等待长时间运行的操作完成。
指定身份验证设置中的 openid。
说明可在哪些协议上调用此 API 中的操作。
实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。
指定订阅密钥标头名称。
指定订阅密钥查询字符串参数名称。
指定在调用此 API 期间是否需要订阅密钥，true - API 仅包含在关闭的产品中，false - API 仅包含在开放产品中，null - 产品混合使用。
如果为 true，则 API 需要请求的订阅密钥。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api delete
删除API 管理 API。
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]必需参数
API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
API 管理服务实例的名称。
可选参数
删除 Api 的所有修订。
实体的 ETag。
不等待长时间运行的操作完成。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api export
导出API 管理 API。
az apim api export --api-id
--ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]示例
将API 管理 API 导出到文件或返回包含导出链接的响应。
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path必需参数
API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。 正则表达式模式： ^[^*#&+：<>？]+$.
指定导出 API 的格式。
资源组的名称。 此名称不区分大小写。
API 管理服务实例的名称。
可选参数
指定要导出 API 的文件路径。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api import
导入API 管理 API。
az apim api import --path
--resource-group
--service-name
--specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
[--api-id]
[--api-revision]
[--api-type {graphql, http, soap, websocket}]
[--api-version]
[--api-version-set-id]
[--description]
[--display-name]
[--no-wait]
[--protocols {http, https, ws, wss}]
[--service-url]
[--soap-api-type]
[--specification-path]
[--specification-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--wsdl-endpoint-name]
[--wsdl-service-name]示例
从文件或 URL 导入API 管理 API
az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson必需参数
必需。 相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
API 管理服务实例的名称。
指定导入的 API 的格式。
可选参数
API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
描述 API 的修订。 如果未提供任何值，则会创建默认修订版 1。
API 的类型。
描述 Api 的版本。 如果将版本添加到非版本控制 API，则会自动创建原始版本，并在默认 URL 上做出响应。
描述要用于 API 的版本集。
API 的说明。 可以包含 HTML 格式标记。
此 API 的显示名称。
不等待长时间运行的操作完成。
描述可以调用此 API 中的操作的协议（一个或多个）。
实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。
文件格式为 WSDL 时 API 的类型。
指定用于导入 API 的文件路径。
指定用于导入 API 的 URL。
指定订阅密钥标头名称。
指定订阅密钥查询字符串参数名称。
如果为 true，则 API 需要请求的订阅密钥。
要导入的 WSDL 终结点（端口）的本地名称。
要导入的 WSDL 服务的本地名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api list
列出API 管理 API。
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]必需参数
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
API 管理服务实例的名称。
可选参数
按 displayName 筛选 API。
要跳过的记录数。
要返回的记录数。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api show
显示API 管理 API 的详细信息。
az apim api show --api-id
--resource-group
--service-name必需参数
API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
API 管理服务实例的名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api update
更新API 管理 API。
az apim api update --api-id
--resource-group
--service-name
[--add]
[--api-type {graphql, http, soap, websocket}]
[--description]
[--display-name]
[--force-string]
[--if-match]
[--no-wait]
[--path]
[--protocols {http, https, ws, wss}]
[--remove]
[--service-url]
[--set]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--tags]示例
创建基本 API。
az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo必需参数
要创建的 API 的唯一名称。
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
API 管理服务实例的名称。
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。
API 的类型。
API 的说明。 可以包含 HTML 格式标记。
API 名称。 长度必须为 1 到 300 个字符。
使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。
实体的 ETag。 创建实体时不需要，但在更新实体时是必需的。 默认值为 None。
不等待长时间运行的操作完成。
必需。 相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。
说明可在哪些协议上调用此 API 中的操作。
从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.
实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。
通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。
指定订阅密钥标头名称。
指定订阅密钥查询字符串参数名称。
如果为 true，则 API 需要请求的订阅密钥。
空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az apim api wait
将 CLI 置于等待状态，直到满足 apim API 的条件。
az apim api wait --api-id
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]示例
将 CLI 置于等待状态，直到满足 apim API 的条件。 （自动生成）
az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup必需参数
API 修订标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。 必需。
API 管理服务实例的名称。
资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。
可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。
等到删除为止。
等待资源存在。
轮询间隔（以秒为单位）。
最大等待（以秒为单位）。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误，取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈