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

az apic

参考

注意

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

管理 Azure API 中心服务。

命令

名称	说明	类型	Status
az apic api	用于在 API 中心管理 API 的命令。	扩展	GA
az apic api create	注册新 API 或更新现有 API。	扩展	GA
az apic api definition	用于在 API 中心管理 API 定义的命令。	扩展	GA
az apic api definition create	创建新的 API 定义或更新现有的 API 定义。	扩展	GA
az apic api definition delete	删除指定的 API 定义。	扩展	GA
az apic api definition export-specification	导出 API 规范。	扩展	GA
az apic api definition import-specification	导入 API 规范。	扩展	GA
az apic api definition list	列出 API 定义的集合。	扩展	GA
az apic api definition show	获取 API 定义的详细信息。	扩展	GA
az apic api definition update	更新现有 API 定义。	扩展	GA
az apic api delete	删除指定的 API。	扩展	GA
az apic api deployment	用于在 API 中心管理 API 部署的命令。	扩展	GA
az apic api deployment create	创建新的 API 部署或更新现有 API 部署。	扩展	GA
az apic api deployment delete	删除 API 部署。	扩展	GA
az apic api deployment list	列出 API 部署的集合。	扩展	GA
az apic api deployment show	获取 API 部署的详细信息。	扩展	GA
az apic api deployment update	更新现有 API 部署。	扩展	GA
az apic api list	列出 API 集合。	扩展	GA
az apic api register	使用规范文件将新的 API 注册到版本、定义和关联的部署，作为事实来源。目前，我们仅支持 OpenAPI JSON/YAML 格式。	扩展	预览
az apic api show	获取 API 的详细信息。	扩展	GA
az apic api update	更新现有 API。	扩展	GA
az apic api version	用于在 API 中心管理 API 版本的命令。	扩展	GA
az apic api version create	创建新的 API 版本或更新现有 API 版本。	扩展	GA
az apic api version delete	删除指定的 API 版本。	扩展	GA
az apic api version list	列出 API 版本的集合。	扩展	GA
az apic api version show	获取 API 版本的详细信息。	扩展	GA
az apic api version update	更新现有 API 版本。	扩展	GA
az apic create	创建实例或更新 Azure API 中心服务的现有实例。	扩展	GA
az apic delete	删除 Azure API 中心服务的实例。	扩展	GA
az apic environment	用于管理 API 中心中的环境的命令。	扩展	GA
az apic environment create	创建新环境或更新现有环境。	扩展	GA
az apic environment delete	删除环境。	扩展	GA
az apic environment list	列出环境的集合。	扩展	GA
az apic environment show	获取环境的详细信息。	扩展	GA
az apic environment update	更新现有环境。	扩展	GA
az apic import-from-apim	从 Azure API 管理服务实例导入 API。	扩展	GA
az apic list	列出 Azure 订阅中的 Azure API 中心服务。	扩展	GA
az apic metadata	用于在 API 中心管理元数据架构的命令。	扩展	GA
az apic metadata create	创建新的元数据架构或更新现有元数据架构。	扩展	GA
az apic metadata delete	删除指定的元数据架构。	扩展	GA
az apic metadata export	导出元数据架构。	扩展	GA
az apic metadata list	列出元数据架构的集合。	扩展	GA
az apic metadata show	获取元数据架构的详细信息。	扩展	GA
az apic metadata update	更新现有元数据架构。	扩展	GA
az apic show	显示 Azure API 中心服务实例的详细信息。	扩展	GA
az apic update	更新 Azure API 中心服务的实例。	扩展	GA

az apic create

创建实例或更新 Azure API 中心服务的现有实例。

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

示例

创建服务示例 1

az apic create -g contoso-resources -n contoso -l eastus

创建服务示例 2

az apic create --resource-group contoso-resources --name contoso --location eastus

必需参数

--name -n

API 中心服务的名称。

--resource-group -g

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

可选参数

--identity

分配给此资源的托管服务标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

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

删除 Azure API 中心服务的实例。

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

示例

删除服务

az apic delete -n contoso -g contoso-resources

可选参数

--ids

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

--name -n

API 中心服务的名称。

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--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 apic import-from-apim

从 Azure API 管理服务实例导入 API。

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

示例

从同一资源组中的 APIM 导入所有 API

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

从同一资源组中的 APIM 导入所选 API

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

从其他订阅和资源组中的 APIM 导入所有 API

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

必需参数

--apim-apis

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

--apim-name

源 APIM 实例的名称。

可选参数

--apim-resource-group

源 APIM 实例的资源组。

--apim-subscription

源 APIM 实例的订阅 ID。

--ids

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

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service-name -n

Azure API 中心服务的名称。

--subscription

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

全局参数

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

列出 Azure 订阅中的 Azure API 中心服务。

存在一个已知问题，即列出订阅下的所有资源不起作用。请按资源组列出资源。

az apic list [--max-items]
             [--next-token]
             [--resource-group]

示例

列出资源组中的服务

az apic list -g contoso-resources

可选参数

--max-items

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

--next-token

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

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 apic show

显示 Azure API 中心服务实例的详细信息。

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

示例

显示服务详细信息

az apic show -g contoso-resources -n contoso

可选参数

--ids

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

--name -n

API 中心服务的名称。

--resource-group -g

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

--subscription

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

全局参数

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

更新 Azure API 中心服务的实例。

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

示例

更新服务详细信息

az apic update -g contoso-resources -n contoso

可选参数

--add

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

--force-string

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--identity

分配给此资源的托管服务标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--ids

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

--name -n

API 中心服务的名称。

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

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

命令

az apic create

示例

必需参数

可选参数

az apic delete

示例

可选参数

az apic import-from-apim

示例

必需参数

可选参数

az apic list

示例

可选参数

az apic show

示例

可选参数

az apic update

示例

可选参数

其他资源