通过

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

az apic integration

Note

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

管理 Azure API 中心中的集成。

命令

名称 说明 类型 Status
az apic integration create

管理 Azure API 中心中的集成。

 Extension GA
az apic integration create apim

将 Azure APIM 添加为 API 源。

 Extension GA
az apic integration create aws

将 Amazon API 网关添加为 API 源。

 Extension GA
az apic integration delete

删除指定的 API 源。

 Extension GA
az apic integration list

列出 API 源的集合。

 Extension GA
az apic integration show

获取 API 源的详细信息。

 Extension GA

az apic integration delete

删除指定的 API 源。

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

可选参数

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

--ids

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

属性 值
Parameter group: Resource Id Arguments
--integration-name -i

集成的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

Azure API 中心资源组的名称。 可以使用 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 integration list

列出 API 源的集合。

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

必需参数

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

获取 API 源的详细信息。

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

可选参数

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

--ids

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

属性 值
Parameter group: Resource Id Arguments
--integration-name -i

集成的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

Azure API 中心资源组的名称。 可以使用 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