Delegation Settings - Update

Update Delegation settings.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

api-version
query True
  • string

Version of the API to be used with the client request.

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

Subscriptions delegation settings.

properties.url
  • string

A delegation Url.

properties.userRegistration

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

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

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation?api-version=2019-01-01
If-Match: *
{
  "properties": {
    "url": "http://contoso.com/delegation",
    "validationKey": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

Sample Response

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

PortalDelegationSettings

Delegation settings for a developer portal.

RegistrationDelegationSettingsProperties

User registration delegation settings properties.

SubscriptionsDelegationSettingsProperties

Subscriptions delegation settings properties.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

PortalDelegationSettings

Delegation settings for a developer portal.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.subscriptions

Subscriptions delegation settings.

properties.url
  • string

A delegation Url.

properties.userRegistration

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

Resource type for API Management resource.

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.