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

az apim product api

  • 参考

管理 Azure API 管理产品的 API。

命令

名称 说明 类型 状态
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 api add

编辑

将 API 添加到指定产品。

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

示例

将 API 添加到指定产品。

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

--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 api check

编辑

检查由标识符指定的 API 实体是否与 Product 实体相关联。

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

示例

检查 API 是否与产品相关联。

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

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

编辑

从指定的产品中删除指定的 API。

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

示例

从指定的产品中删除指定的 API。

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必需参数

--api-id

API 标识符。 在当前API 管理服务实例中必须是唯一的。 非当前修订有;rev=n 作为后缀，其中 n 是修订号。

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

编辑

列出与产品关联的 API 集合。

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

示例

列出与产品关联的所有 API。

az apim product api list --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 获取完整的调试日志。