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

az apic api

Note

此参考是 Azure CLI（版本 2.57.0 或更高版本）的 apic-extension 扩展的一部分。该扩展将在首次运行 az apic api 命令时自动安装。了解更多关于扩展的信息。

用于在 API 中心管理 API 的命令。

命令

名称	说明	类型	Status
az apic api create	注册新 API 或更新现有 API。	Extension	GA
az apic api definition	用于在 API 中心管理 API 定义的命令。	Extension	GA
az apic api definition create	创建新的 API 定义或更新现有的 API 定义。	Extension	GA
az apic api definition delete	删除指定的 API 定义。	Extension	GA
az apic api definition export-specification	导出 API 规范。	Extension	GA
az apic api definition import-specification	导入 API 规范。	Extension	GA
az apic api definition list	列出 API 定义的集合。	Extension	GA
az apic api definition show	获取 API 定义的详细信息。	Extension	GA
az apic api definition update	更新现有 API 定义。	Extension	GA
az apic api delete	删除指定的 API。	Extension	GA
az apic api deployment	用于在 API 中心管理 API 部署的命令。	Extension	GA
az apic api deployment create	创建新的 API 部署或更新现有 API 部署。	Extension	GA
az apic api deployment delete	删除 API 部署。	Extension	GA
az apic api deployment list	列出 API 部署的集合。	Extension	GA
az apic api deployment show	获取 API 部署的详细信息。	Extension	GA
az apic api deployment update	更新现有 API 部署。	Extension	GA
az apic api list	列出 API 集合。	Extension	GA
az apic api register	使用规范文件将新的 API 注册到版本、定义和关联的部署，作为事实来源。目前，我们仅支持 OpenAPI JSON/YAML 格式。	Extension	Preview
az apic api show	获取 API 的详细信息。	Extension	GA
az apic api update	更新现有 API。	Extension	GA
az apic api version	用于在 API 中心管理 API 版本的命令。	Extension	GA
az apic api version create	创建新的 API 版本或更新现有 API 版本。	Extension	GA
az apic api version delete	删除指定的 API 版本。	Extension	GA
az apic api version list	列出 API 版本的集合。	Extension	GA
az apic api version show	获取 API 版本的详细信息。	Extension	GA
az apic api version update	更新现有 API 版本。	Extension	GA

az apic api create

注册新 API 或更新现有 API。

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

示例

创建 API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

使用自定义属性创建 API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

使用 json 文件创建自定义属性的 API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

必需参数

--api-id

API 的 ID。

--resource-group -g

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

--service-name -n

Azure API 中心服务的名称。

--title

API 标题。

属性	值
Parameter group:	Properties Arguments

--type

API 的类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	graphql, grpc, rest, soap, webhook, websocket

可选参数

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

--contacts

API 的联系信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--custom-properties

为 API 目录实体定义的自定义元数据。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--description

API 的说明。

属性	值
Parameter group:	Properties Arguments

--external-documentation

此外，API 的外部文档。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--license

API 的许可证信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--summary

API 的简短说明。

属性	值
Parameter group:	Properties Arguments

全局参数

--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 apic api delete

删除指定的 API。

az apic api delete [--api-id]
                   [--ids]
                   [--resource-group]
                   [--service-name]
                   [--subscription]
                   [--yes]

示例

删除 API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

可选参数

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

--api-id

API 的 ID。

属性	值
Parameter group:	Resource Id Arguments

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--service-name -n

Azure API 中心服务的名称。

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

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

--verbose

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

属性	值
默认值:	False

az apic api list

列出 API 集合。

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

示例

列出 API

az apic api list -g contoso-resources -n contoso

使用筛选器列出 API

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

必需参数

--resource-group -g

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

--service-name -n

Azure API 中心服务的名称。

可选参数

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

--filter

OData 筛选器参数。

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

全局参数

--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 apic api register

预览

此命令处于预览阶段，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

使用规范文件将新的 API 注册到版本、定义和关联的部署，作为事实来源。目前，我们仅支持 OpenAPI JSON/YAML 格式。

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

示例

通过提供规范文件注册 API。

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

通过提供规范 URL 注册 API。

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

必需参数

--api-location -l

规范文件的位置。

--resource-group -g

资源组名称。

--service-name -n

APICenter 目录或服务名称。

可选参数

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

--environment-id

之前创建的环境 ID。

全局参数

--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 apic api show

获取 API 的详细信息。

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

示例

显示 API 详细信息

az apic api show -g contoso-resources -n contoso --api-id echo-api

可选参数

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

--api-id

API 的 ID。

属性	值
Parameter group:	Resource Id Arguments

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--service-name -n

Azure API 中心服务的名称。

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

az apic api update

更新现有 API。

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

示例

更新 API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

更新自定义属性

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

使用 json 文件更新自定义属性

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

更新单个自定义元数据

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

可选参数

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

--api-id

API 的 ID。

属性	值
Parameter group:	Resource Id Arguments

--contacts

API 的联系信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--custom-properties

为 API 目录实体定义的自定义元数据。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--description

API 的说明。

属性	值
Parameter group:	Properties Arguments

--external-documentation

此外，API 的外部文档。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--force-string

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

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--license

API 的许可证信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--remove

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

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--service-name -n

Azure API 中心服务的名称。

属性	值
Parameter group:	Resource Id Arguments

--set

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

属性	值
Parameter group:	Generic Update Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--summary

API 的简短说明。

属性	值
Parameter group:	Properties Arguments

--title

API 标题。

属性	值
Parameter group:	Properties Arguments

--type

API 的类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	graphql, grpc, rest, soap, webhook, websocket

全局参数

--debug

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

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性	值
默认值:	False

--output -o

输出格式。

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

反馈

此页面是否有帮助？