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

Product - Get

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2020-12-01

URI 参数

Name In Required Type Description
productId
path True
  • string

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

resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要用于客户端请求的 API 的版本。

响应

Name Type Description
200 OK

响应正文包含指定的 Product 实体。

Headers

  • ETag: string
Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementGetProduct

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited?api-version=2020-12-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "unlimited",
  "properties": {
    "displayName": "Unlimited",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

定义

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

ProductContract

产品详细信息。

ProductState

产品是否发布。 开发人员门户的用户可发现已发布的产品。 非已发布产品仅对管理员可见。 产品的默认状态未发布。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

属性级错误的人类可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

错误的用户可读表示形式。

ProductContract

产品详细信息。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.approvalRequired
  • boolean

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

properties.description
  • string

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

properties.displayName
  • string

产品名称。

properties.state

产品是否发布。 开发人员门户的用户可发现已发布的产品。 非已发布产品仅对管理员可见。 产品的默认状态未发布。

properties.subscriptionRequired
  • boolean

访问此产品中包含的 API 是否需要产品订阅。 如果为 true,则产品称为“受保护”,并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false,则产品称为“打开”,并且无需订阅密钥即可请求产品中包含的 API。 如果在创建新产品时省略属性,则假定其值为 true。

properties.subscriptionsLimit
  • integer

用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许每个用户订阅不受限制。 仅当 subscriptionRequired 属性存在且值为 false 时,才可存在。

properties.terms
  • string

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

type
  • string

API 管理资源的资源类型。

ProductState

产品是否发布。 开发人员门户的用户可发现已发布的产品。 非已发布产品仅对管理员可见。 产品的默认状态未发布。

Name Type Description
notPublished
  • string
published
  • string