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

Delegation Settings - Update

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

Обновите параметры делегирования.

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

Параметры URI

Имя В Обязательно Тип Описание
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.subscriptions

SubscriptionsDelegationSettingsProperties

Параметры делегирования подписок.
properties.url

string

URL-адрес делегирования.
properties.userRegistration

RegistrationDelegationSettingsProperties

Параметры делегирования регистрации пользователей.
properties.validationKey

string

Ключ проверки в кодировке Base64 для проверки того, что запрос поступает из службы "Управление API Azure".

Ответы

Имя Тип Описание
204 No Content

Параметры делегирования были успешно обновлены.
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementPortalSettingsUpdateDelegation

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

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


{
  "properties": {
    "url": "http://contoso.com/delegation",
    "validationKey": "<validationKey>",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

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

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

Определения

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

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

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

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

Параметры делегирования для портала разработчика.
RegistrationDelegationSettingsProperties

Свойства параметров делегирования регистрации пользователей.
SubscriptionsDelegationSettingsProperties

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

ErrorAdditionalInfo

Object

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

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

object

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

string

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

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

Object

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

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

ErrorDetail

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

PortalDelegationSettings

Object

Параметры делегирования для портала разработчика.

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

string

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

string

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

SubscriptionsDelegationSettingsProperties

Параметры делегирования подписок.
properties.url

string

URL-адрес делегирования.
properties.userRegistration

RegistrationDelegationSettingsProperties

Параметры делегирования регистрации пользователей.
properties.validationKey

string

Ключ проверки в кодировке Base64 для проверки того, что запрос поступает из службы "Управление API Azure".
type

string

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

RegistrationDelegationSettingsProperties

Object

Свойства параметров делегирования регистрации пользователей.

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

boolean

Включение или отключение делегирования для регистрации пользователей.

SubscriptionsDelegationSettingsProperties

Object

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

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

boolean

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