Share via

Authorization Access Policy - Create Or Update

  • Reference
Service:
API Management
API Version:
2024-05-01

Creates or updates Authorization Access Policy.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}/accessPolicies/{authorizationAccessPolicyId}?api-version=2024-05-01

URI Parameters

Name In Required Type Description
authorizationAccessPolicyId
 path True

string

Identifier of the authorization access policy.

Regex pattern: ^[^*#&+:<>?]+$
authorizationId
 path True

string

Identifier of the authorization.

Regex pattern: ^[^*#&+:<>?]+$
authorizationProviderId
 path True

string

Identifier of the authorization provider.

Regex pattern: ^[^*#&+:<>?]+$
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

string

ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Request Body

Name Type Description
properties.appIds

string[]

The allowed Azure Active Directory Application IDs
properties.objectId

string

The Object Id
properties.tenantId

string

The Tenant Id

Responses

Name Type Description
200 OK

AuthorizationAccessPolicyContract

The existing Authorization access policy was successfully updated.

Headers

ETag: string
201 Created

AuthorizationAccessPolicyContract

Authorization access policy was successfully created.

Headers

ETag: string
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

ApiManagementCreateAuthorizationAccessPolicy

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies/fe0bed83-631f-4149-bd0b-0464b1bc7cab?api-version=2024-05-01

{
  "properties": {
    "appIds": [
      "d5f04bb0-ba78-4878-a43e-35a0b74fe315"
    ],
    "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff",
    "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab"
  }
}

Sample response

Status code:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies",
  "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies",
  "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab",
  "properties": {
    "appIds": [
      "d5f04bb0-ba78-4878-a43e-35a0b74fe315"
    ],
    "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff",
    "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab"
  }
}
Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1/accessPolicies",
  "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations/accessPolicies",
  "name": "fe0bed83-631f-4149-bd0b-0464b1bc7cab",
  "properties": {
    "appIds": [
      "d5f04bb0-ba78-4878-a43e-35a0b74fe315"
    ],
    "tenantId": "13932a0d-5c63-4d37-901d-1df9c97722ff",
    "objectId": "fe0bed83-631f-4149-bd0b-0464b1bc7cab"
  }
}

Definitions

Name Description
AuthorizationAccessPolicyContract

Authorization access policy contract.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

AuthorizationAccessPolicyContract

Authorization access policy contract.

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.appIds

string[]

The allowed Azure Active Directory Application IDs
properties.objectId

string

The Object Id
properties.tenantId

string

The Tenant Id
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.