Policy Restriction - Update

Служба:: API Management

Версия API:: 2024-05-01

Обновляет конфигурацию ограничений политики службы управления API.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions/{policyRestrictionId}?api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
policyRestrictionId	path	True	string minLength: 1 maxLength: 80	Ограничения политики после уровня сущности
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, используемая для этой операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-Match	True	string	ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или оно должно быть * для безусловного обновления.

Текст запроса

Имя	Тип	Описание
properties.requireBase	PolicyRestrictionRequireBase	Указывает, должна ли применяться базовая политика для документа политики.
properties.scope	string	Путь к документу политики.

Ответы

Имя	Тип	Описание
200 OK	PolicyRestrictionContract	Конфигурация ограничений политики службы управления API успешно обновлена. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

PolicyRestrictionContract

Конфигурация ограничений политики службы управления API успешно обновлена.

Заголовки

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	олицетворения учетной записи пользователя

Примеры

ApiManagementUpdatePolicyRestriction

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

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1?api-version=2024-05-01


{
  "properties": {
    "scope": "Sample Path 2 to the policy document."
  }
}

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

Код состояния:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1",
  "type": "Microsoft.ApiManagement/service/policyRestrictions",
  "name": "policyRestriction1",
  "properties": {
    "scope": "Sample Path 2 to the policy document.",
    "requireBase": "true"
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PolicyRestrictionContract	Сведения о контракте ограничения политики.
PolicyRestrictionRequireBase	Указывает, должна ли применяться базовая политика для документа политики.
PolicyRestrictionUpdateContract	Сведения о контракте ограничения политики.

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

PolicyRestrictionContract

Object

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

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Имя ресурса
properties.requireBase	PolicyRestrictionRequireBase	false	Указывает, должна ли применяться базовая политика для документа политики.
properties.scope	string		Путь к документу политики.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PolicyRestrictionRequireBase

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

Указывает, должна ли применяться базовая политика для документа политики.

Значение	Описание
true	Политика требуется для базовой политики
false	Политика не требует наличия базовой политики

PolicyRestrictionUpdateContract

Object

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

Имя	Тип	Default value	Описание
properties.requireBase	PolicyRestrictionRequireBase	false	Указывает, должна ли применяться базовая политика для документа политики.
properties.scope	string		Путь к документу политики.