az apim api

命令

名称	说明	类型	Status
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-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'

必需参数

可选参数

全局参数

--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 delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

必需参数

可选参数

全局参数

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

必需参数

可选参数

全局参数

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

必需参数

可选参数

全局参数

--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 list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

必需参数

可选参数

全局参数

--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 show --api-id
                 --resource-group
                 --service-name

必需参数

全局参数

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

必需参数

可选参数

全局参数

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

必需参数

可选参数

全局参数

--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 获取完整的调试日志。