Delegation Settings - Update

Reference

Service:: API Management

API Version:: 2024-05-01

Update Delegation settings.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name	Type	Description
properties.subscriptions	SubscriptionsDelegationSettingsProperties	Subscriptions delegation settings.
properties.url	string	A delegation Url.
properties.userRegistration	RegistrationDelegationSettingsProperties	User registration delegation settings.
properties.validationKey	string	A base64-encoded validation key to validate, that a request is coming from Azure API Management.

Responses

Name	Type	Description
204 No Content		Delegation settings was updated successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

ApiManagementPortalSettingsUpdateDelegation

Sample request

HTTP

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
    }
  }
}

Sample response

Status code:: 204

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PortalDelegationSettings	Delegation settings for a developer portal.
RegistrationDelegationSettingsProperties	User registration delegation settings properties.
SubscriptionsDelegationSettingsProperties	Subscriptions delegation settings properties.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

PortalDelegationSettings

Delegation settings for a developer portal.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.subscriptions	SubscriptionsDelegationSettingsProperties	Subscriptions delegation settings.
properties.url	string	A delegation Url.
properties.userRegistration	RegistrationDelegationSettingsProperties	User registration delegation settings.
properties.validationKey	string	A base64-encoded validation key to validate, that a request is coming from Azure API Management.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RegistrationDelegationSettingsProperties

User registration delegation settings properties.

Name	Type	Description
enabled	boolean	Enable or disable delegation for user registration.

SubscriptionsDelegationSettingsProperties

Subscriptions delegation settings properties.

Name	Type	Description
enabled	boolean	Enable or disable delegation for subscriptions.

Share via