你当前正在访问 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 --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"
产品名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
API 管理服务实例的名称。
是否需要订阅审批。 如果为 false,则新订阅将自动获得批准,使开发人员能够在订阅后立即调用产品的 API。 如果为 true,管理员必须先手动批准订阅,然后开发人员才能使用任何产品的 API。 仅当 subscriptionRequired 属性存在且值为 false 时,才能存在。
产品说明。 可以包含 HTML 格式标记。
产品使用条款。 当开发人员尝试订阅此产品时,系统会显示这些条款,开发人员需接受这些条款才能完成订阅过程。
不等待长时间运行的操作完成。
产品标识符。 在当前API 管理服务实例中必须是唯一的。
产品是否发布。 已发布的产品可由开发人员门户的用户发现。 非已发布产品仅对管理员可见。 产品的默认状态未发布。 可能的值包括:“notPublished”、“published”。
访问此产品中包含的 API 是否需要产品订阅。
用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许每个用户订阅不受限制。 仅当 subscriptionRequired 属性存在且值为 false 时,才能存在。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
删除产品。
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
产品标识符。 在当前API 管理服务实例中必须是唯一的。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
API 管理服务实例的名称。
删除与产品关联的现有订阅。
实体的 ETag。
不等待长时间运行的操作完成。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
列出指定服务实例中的产品集合。
az apim product list --resource-group
--service-name
列出此 APIM 实例的所有产品。
az apim product list --resource-group MyResourceGroup --service-name MyServiceName
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
API 管理服务实例的名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
获取由其标识符指定的产品的详细信息。
az apim product show --product-id
--resource-group
--service-name
获取由其标识符指定的产品的详细信息。
az apim product show --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID
产品标识符。 在当前API 管理服务实例中必须是唯一的。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
API 管理服务实例的名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
更新现有产品详细信息。
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"
产品标识符。 在当前API 管理服务实例中必须是唯一的。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
API 管理服务实例的名称。
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
是否需要订阅审批。 如果为 false,则新订阅将自动获得批准,使开发人员能够在订阅后立即调用产品的 API。 如果为 true,管理员必须先手动批准订阅,然后开发人员才能使用任何产品的 API。 仅当 subscriptionRequired 属性存在且值为 false 时,才能存在。
产品说明。 可以包含 HTML 格式标记。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
实体的 ETag。
产品使用条款。 当开发人员尝试订阅此产品时,系统会显示这些条款,开发人员需接受这些条款才能完成订阅过程。
不等待长时间运行的操作完成。
产品名称。
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
产品是否发布。 已发布的产品可由开发人员门户的用户发现。 非已发布产品仅对管理员可见。 产品的默认状态未发布。 可能的值包括:“notPublished”、“published”。
访问此产品中包含的 API 是否需要产品订阅。
用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许每个用户订阅不受限制。 仅当 subscriptionRequired 属性存在且值为 false 时,才能存在。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
将 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
产品标识符。 在当前API 管理服务实例中必须是唯一的。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
API 管理服务实例的名称。
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到删除为止。
等待资源存在。
轮询间隔(以秒为单位)。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。