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

az apim product

参考

管理 Azure API 管理产品。

命令

名称	说明	类型	状态
az apim product api	管理 Azure API 管理产品的 API。	核心	GA
az apim product api add	将 API 添加到指定产品。	核心	GA
az apim product api check	检查由标识符指定的 API 实体是否与 Product 实体相关联。	核心	GA
az apim product api delete	从指定的产品中删除指定的 API。	核心	GA
az apim product api list	列出与产品关联的 API 集合。	核心	GA
az apim product create	创建产品。	核心	GA
az apim product delete	删除产品。	核心	GA
az apim product list	列出指定服务实例中的产品集合。	核心	GA
az apim product show	获取由其标识符指定的产品的详细信息。	核心	GA
az apim product update	更新现有产品详细信息。	核心	GA
az apim product wait	将 CLI 置于等待状态，直到满足 apim 产品的条件。	核心	GA

az apim product create

编辑

创建产品。

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

示例

创建产品。

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

必需参数

--product-name

产品名称。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--approval-required

是否需要订阅审批。如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。如果为 true，管理员必须先手动批准订阅，然后开发人员才能使用任何产品的 API。仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。

接受的值: false, true

--description

产品说明。可以包含 HTML 格式标记。

--legal-terms

产品使用条款。当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。

--no-wait

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

默认值: False

--product-id

产品标识符。在当前API 管理服务实例中必须是唯一的。

--state

产品是否发布。已发布的产品可由开发人员门户的用户发现。非已发布产品仅对管理员可见。产品的默认状态未发布。可能的值包括：“notPublished”、“published”。

接受的值: notPublished, published

--subscription-required -s

访问此产品中包含的 API 是否需要产品订阅。

接受的值: false, true

--subscriptions-limit

用户是否可以同时拥有此产品的订阅数。设置为 null 或省略以允许每个用户订阅不受限制。仅当 subscriptionRequired 属性存在且值为 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 apim product delete

编辑

删除产品。

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

示例

删除具有此产品的所有订阅的产品。

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

必需参数

--product-id

产品标识符。在当前API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--delete-subscriptions

删除与产品关联的现有订阅。

--if-match

实体的 ETag。

--no-wait

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

默认值: False

--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 apim product list

编辑

列出指定服务实例中的产品集合。

az apim product list --resource-group
                     --service-name

示例

列出此 APIM 实例的所有产品。

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

必需参数

--resource-group -g

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

--service-name -n

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

编辑

获取由其标识符指定的产品的详细信息。

az apim product show --product-id
                     --resource-group
                     --service-name

示例

获取由其标识符指定的产品的详细信息。

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

必需参数

--product-id

产品标识符。在当前API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

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

编辑

更新现有产品详细信息。

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

示例

更新现有产品详细信息。

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

必需参数

--product-id

产品标识符。在当前API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--add

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

默认值: []

--approval-required

接受的值: false, true

--description

产品说明。可以包含 HTML 格式标记。

--force-string

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

默认值: False

--if-match

实体的 ETag。

--legal-terms

产品使用条款。当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。

--no-wait

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

默认值: False

--product-name

产品名称。

--remove

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

默认值: []

--set

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

默认值: []

--state

接受的值: notPublished, published

--subscription-required -s

访问此产品中包含的 API 是否需要产品订阅。

接受的值: false, true

--subscriptions-limit

用户是否可以同时拥有此产品的订阅数。设置为 null 或省略以允许每个用户订阅不受限制。仅当 subscriptionRequired 属性存在且值为 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 apim product wait

编辑

将 CLI 置于等待状态，直到满足 apim 产品的条件。

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

示例

将 CLI 置于等待状态，直到满足 apim 的条件。（自动生成）

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

必需参数

--product-id

产品标识符。在当前API 管理服务实例中必须是唯一的。

--resource-group -g

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

--service-name -n

API 管理服务实例的名称。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--interval

轮询间隔（以秒为单位）。

默认值: 30

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: 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 apim product

命令

az apim product create

示例

必需参数

可选参数

az apim product delete

示例

必需参数

可选参数

az apim product list

示例

必需参数

az apim product show

示例

必需参数

az apim product update

示例

必需参数

可选参数

az apim product wait

示例

必需参数

可选参数

其他资源