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

Product Policy - Get

获取产品级别的策略配置。

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

URI 参数

Name In Required Type Description
policyId
path True

策略的标识符。

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 的版本。

format
query

策略导出格式。

响应

Name Type Description
200 OK

产品策略信息。

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 模拟用户帐户

示例

ApiManagementGetProductPolicy

Sample Request

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

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy",
  "type": "Microsoft.ApiManagement/service/products/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound>\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <base />\r\n  </outbound>\r\n  <on-error>\r\n    <base />\r\n  </on-error>\r\n</policies>"
  }
}

定义

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

PolicyContentFormat

policyContent 的格式。

PolicyContract

策略协定详细信息。

PolicyExportFormat

策略导出格式。

PolicyIdName

策略的标识符。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

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

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

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

error.details

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

error.message
  • string

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

PolicyContentFormat

policyContent 的格式。

Name Type Description
rawxml
  • string

内容是内联的,内容类型是非 XML 编码策略文档。

rawxml-link
  • string

策略文档不是 Xml 编码的,托管在可从 API 管理 服务访问的 http 终结点上。

xml
  • string

内容是内联的,内容类型是 XML 文档。

xml-link
  • string

策略 XML 文档托管在可从API 管理服务访问的 http 终结点上。

PolicyContract

策略协定详细信息。

Name Type Default Value Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.format xml

policyContent 的格式。

properties.value
  • string

由格式定义的策略内容。

type
  • string

API 管理资源的资源类型。

PolicyExportFormat

策略导出格式。

Name Type Description
rawxml
  • string

内容是内联的,内容类型是非 XML 编码策略文档。

xml
  • string

内容是内联的,内容类型是 XML 文档。

PolicyIdName

策略的标识符。

Name Type Description
policy
  • string