通过

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

az apic environment

Note

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

用于管理 API 中心中的环境的命令。

命令

名称 说明 类型 Status
az apic environment create

创建新环境或更新现有环境。

 Extension GA
az apic environment delete

删除环境。

 Extension GA
az apic environment list

列出环境的集合。

 Extension GA
az apic environment show

获取环境的详细信息。

 Extension GA
az apic environment update

更新现有环境。

 Extension GA

az apic environment create

创建新环境或更新现有环境。

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

示例

创建环境

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

必需参数

--environment-id

环境的 ID。

--resource-group -g

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

--service-name -n

Azure API 中心服务的名称。

--title

环境标题。

属性 值
参数组: Properties Arguments
--type

环境类型。

属性 值
参数组: Properties Arguments
接受的值: development, production, staging, testing

可选参数

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

--custom-properties

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

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

环境说明。

属性 值
参数组: Properties Arguments
--onboarding

提供与环境相关的载入文档，例如 {developerPortalUri：['https://developer.contoso.com']，instructions：'instructions markdown'} 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--server

环境的服务器信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: 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 environment delete

删除环境。

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

示例

删除环境

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

可选参数

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

--environment-id

环境的 ID。

属性 值
参数组: Resource Id Arguments
--ids

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

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

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

属性 值
参数组: Resource Id Arguments
--service-name -n

Azure API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: 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 environment list

列出环境的集合。

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

示例

列出环境

az apic environment list -g api-center-test -n contosoeuap

必需参数

--resource-group -g

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

--service-name -n

Azure API 中心服务的名称。

可选参数

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

--filter

OData 筛选器参数。

--max-items

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

属性 值
参数组: Pagination Arguments
--next-token

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

属性 值
参数组: 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 environment show

获取环境的详细信息。

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

示例

显示环境详细信息

az apic environment show -g api-center-test -n contosoeuap --environment-id public

可选参数

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

--environment-id

环境的 ID。

属性 值
参数组: Resource Id Arguments
--ids

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

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

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

属性 值
参数组: Resource Id Arguments
--service-name -n

Azure API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: 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 environment update

更新现有环境。

az apic environment update [--add]
                           [--custom-properties]
                           [--description]
                           [--environment-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--onboarding]
                           [--remove]
                           [--resource-group]
                           [--server]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--type {development, production, staging, testing}]

示例

更新环境

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

可选参数

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

--add

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

属性 值
参数组: Generic Update Arguments
--custom-properties

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

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

Description.

属性 值
参数组: Properties Arguments
--environment-id

环境的 ID。

属性 值
参数组: Resource Id Arguments
--force-string

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

属性 值
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

属性 值
参数组: Resource Id Arguments
--onboarding

{developerPortalUri：['https://developer.contoso.com']，instructions：'instructions markdown'}支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--remove

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

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

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

属性 值
参数组: Resource Id Arguments
--server

环境的服务器信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--service-name -n

Azure API 中心服务的名称。

属性 值
参数组: Resource Id Arguments
--set

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

属性 值
参数组: Generic Update Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--title

环境标题。

属性 值
参数组: Properties Arguments
--type

环境类型。

属性 值
参数组: Properties Arguments
接受的值: development, production, staging, testing
全局参数
--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