Поделиться через

Product Policy - Get

  • Ссылка
Служба:
API Management
Версия API:
2024-05-01

Получите конфигурацию политики на уровне продукта.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/policy?api-version=2024-05-01
С использованием необязательных параметров: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/policy?format={format}&api-version=2024-05-01

Параметры URI

Имя В Обязательно Тип Описание
policyId
 path True

PolicyIdName

Идентификатор политики.
productId
 path True

string

minLength: 1
maxLength: 256

Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы управления API.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.
subscriptionId
 path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.
format
 query

PolicyExportFormat

Формат экспорта политики.

Ответы

Имя Тип Описание
200 OK

PolicyContract

Сведения о политике продукта.

Заголовки

ETag: string
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementGetProductPolicy

Образец запроса

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy?api-version=2024-05-01

Пример ответа

Код состояния:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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>"
  }
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
PolicyContentFormat

Формат политикиContent.
PolicyContract

Сведения о контракте политики.
PolicyExportFormat

Формат экспорта политики.
PolicyIdName

Идентификатор политики.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

PolicyContentFormat

Перечисление

Формат политикиContent.

Значение Описание
rawxml

Содержимое является встроенным, а тип контента — это документ политики, не закодированный в формате XML.
rawxml-link

Документ политики не кодируется в формате XML и размещается в конечной точке HTTP, доступной из службы управления API.
xml

Содержимое является встроенным и типом контента является XML-документом.
xml-link

XML-документ политики размещается в конечной точке HTTP, доступной из службы управления API.

PolicyContract

Object

Сведения о контракте политики.

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.format

PolicyContentFormat

xml

Формат политикиContent.
properties.value

string

Содержимое политики в соответствии с форматом.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PolicyExportFormat

Перечисление

Формат экспорта политики.

Значение Описание
rawxml

Содержимое является встроенным, а тип контента — это документ политики, не закодированный в формате XML.
xml

Содержимое является встроенным и типом контента является XML-документом.

PolicyIdName

Перечисление

Идентификатор политики.

Значение Описание
policy