通过

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

az apim api

管理 Azure API 管理 API。

命令

名称 说明 类型 Status
az apim api create

创建 API 管理 API。

 Core GA
az apim api delete

删除 API 管理 API。

 Core GA
az apim api export

导出 API 管理 API。

 Core GA
az apim api import

导入 API 管理 API。

 Core GA
az apim api list

列出 API 管理 API。

 Core GA
az apim api operation

管理 Azure API 管理 API作。

 Core GA
az apim api operation create

在 API 中创建一个新作。

 Core GA
az apim api operation delete

删除 API 中的指定作。

 Core GA
az apim api operation list

列出指定 API 的作的集合。

 Core GA
az apim api operation show

获取由其标识符指定的 API作的详细信息。

 Core GA
az apim api operation update

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

 Core GA
az apim api release

管理 Azure API 管理 API 版本。

 Core GA
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 revision

管理 Azure API 管理 API 修订版。

 Core GA
az apim api revision create

创建 API 修订。

 Core GA
az apim api revision list

列出 API 的所有修订。

 Core GA
az apim api schema

管理 Azure API 管理 API 架构。

 Core GA
az apim api schema create

创建 API 管理 API 架构。

 Core GA
az apim api schema delete

删除 API 管理 API 架构。

 Core GA
az apim api schema get-etag

获取 API 管理 API 架构的 etag。

 Core GA
az apim api schema list

列出 API 管理 API 架构。

 Core GA
az apim api schema show

显示 API 管理 API 架构的详细信息。

 Core GA
az apim api schema wait

将 CLI 置于等待状态，直到满足 apim API 架构的条件。

 Core GA
az apim api show

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

 Core GA
az apim api update

更新 API 管理 API。

 Core GA
az apim api versionset

管理 Azure API 管理 API 版本集。

 Core GA
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 wait

将 CLI 置于等待状态，直到满足 apim API 的条件。

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

要创建的 API 的唯一名称。

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

属性 值
参数组: API Arguments
--display-name

要创建的 API 的显示名称。

属性 值
参数组: API Arguments
--path

API 的路径。

属性 值
参数组: API Arguments
--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

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

--api-type

API 的类型。

属性 值
参数组: API Arguments
接受的值: graphql, http, soap, websocket
--authorization-scope

指定 OAuth作范围。

--authorization-server-id

指定 OAuth 授权服务器 ID。

--bearer-token-sending-methods

指定持有者令牌的发送方法。

--description

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

属性 值
参数组: API Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--open-id-provider-id

指定身份验证设置中的 openid。

--protocols

描述可以调用此 API 中的作的协议。

属性 值
参数组: API Arguments
接受的值: http, https, ws, wss
--service-url

实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。

属性 值
参数组: API Arguments
--subscription-key-header-name

指定订阅密钥标头名称。

属性 值
参数组: API Arguments
--subscription-key-query-param-name

指定订阅密钥查询字符串参数名称。

属性 值
参数组: API Arguments
--subscription-key-required

指定在调用此 API 期间是否需要订阅密钥，true - API 仅包含在关闭的产品中，false - API 仅包含在开放产品中，null - 产品混合使用。

--subscription-required

如果为 true，则 API 需要请求的订阅密钥。

属性 值
参数组: API Arguments
默认值: False
接受的值: false, true
全局参数
--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 delete

编辑

删除 API 管理 API。

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

必需参数

--api-id

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

属性 值
参数组: API Arguments
--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

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

--delete-revisions

删除 Api 的所有修订。

--if-match

实体的 ETag。

--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--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 api export

编辑

导出 API 管理 API。

az apim api export --api-id
                   --ef --export-format {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-id

API 标识符。 当前 API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。 正则表达式模式： ^[^*#&+：<>？]+$.

属性 值
参数组: API Arguments
--ef --export-format

指定导出 API 的格式。

属性 值
接受的值: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

资源组的名称。 名称不区分大小写。

--service-name -n

API 管理服务实例的名称。

可选参数

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

--file-path -f

指定要导出 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 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

必需参数

--path

Required. 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。

属性 值
参数组: API Arguments
--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

--specification-format

指定导入的 API 的格式。

属性 值
接受的值: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

可选参数

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

--api-id

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

属性 值
参数组: API Arguments
--api-revision

描述 API 的修订。 如果未提供任何值，则会创建默认修订版 1。

属性 值
参数组: API Arguments
--api-type

API 的类型。

属性 值
参数组: API Arguments
接受的值: graphql, http, soap, websocket
--api-version

描述 Api 的版本。 如果将版本添加到非版本控制 API，则会自动创建原始版本，并在默认 URL 上做出响应。

属性 值
参数组: API Arguments
--api-version-set-id

描述要用于 API 的版本集。

属性 值
参数组: API Arguments
--description

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

属性 值
参数组: API Arguments
--display-name

此 API 的显示名称。

属性 值
参数组: API Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--protocols

描述可以调用此 API 中的作的协议（一个或多个）。

属性 值
参数组: API Arguments
接受的值: http, https, ws, wss
--service-url

实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。

属性 值
参数组: API Arguments
--soap-api-type

文件格式为 WSDL 时 API 的类型。

--specification-path

指定用于导入 API 的文件路径。

--specification-url

指定用于导入 API 的 URL。

--subscription-key-header-name

指定订阅密钥标头名称。

属性 值
参数组: API Arguments
--subscription-key-query-param-name

指定订阅密钥查询字符串参数名称。

属性 值
参数组: API Arguments
--subscription-required

如果为 true，则 API 需要请求的订阅密钥。

属性 值
参数组: API Arguments
接受的值: false, true
--wsdl-endpoint-name

要导入的 WSDL 终结点（端口）的本地名称。

--wsdl-service-name

要导入的 WSDL 服务的本地名称。

全局参数
--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 list

编辑

列出 API 管理 API。

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

必需参数

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

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

--filter-display-name

按 displayName 筛选 API。

属性 值
参数组: API Arguments
--skip

要跳过的记录数。

--top

要返回的记录数。

全局参数
--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 show

编辑

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

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

必需参数

--api-id

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

属性 值
参数组: API Arguments
--resource-group -g

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

--service-name

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

要创建的 API 的唯一名称。

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

属性 值
参数组: API Arguments
--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

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

--add

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

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

API 的类型。

属性 值
参数组: API Arguments
接受的值: graphql, http, soap, websocket
--description

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

属性 值
参数组: API Arguments
--display-name

API 名称。 长度必须为 1 到 300 个字符。

属性 值
参数组: API Arguments
--force-string

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

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

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

--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--path

Required. 相对 URL 唯一标识此 API 及其所有资源路径在 API 管理服务实例中。

属性 值
参数组: API Arguments
--protocols

描述可以调用此 API 中的作的协议。

属性 值
参数组: API Arguments
接受的值: http, https, ws, wss
--remove

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

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

实现此 API 的后端服务的绝对 URL。 长度不能超过 2000 个字符。

属性 值
参数组: API Arguments
--set

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

属性 值
参数组: Generic Update Arguments
默认值: []
--subscription-key-header-name

指定订阅密钥标头名称。

属性 值
参数组: API Arguments
--subscription-key-query-param-name

指定订阅密钥查询字符串参数名称。

属性 值
参数组: API Arguments
--subscription-required

如果为 true，则 API 需要请求的订阅密钥。

属性 值
参数组: API Arguments
接受的值: false, true
--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数
--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 wait

编辑

将 CLI 置于等待状态，直到满足 apim API 的条件。

az apim api wait --api-id
                 --name
                 --resource-group
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--timeout]
                 [--updated]

示例

将 CLI 置于等待状态，直到满足 apim API 的条件。 (autogenerated)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

必需参数

--api-id

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

--name -n

API 管理服务实例的名称。

--resource-group -g

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

可选参数

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

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--interval

轮询间隔（以秒为单位）。

属性 值
参数组: Wait Condition Arguments
默认值: 30
--timeout

最大等待（以秒为单位）。

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: Wait Condition Arguments
默认值: 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