Share via

Policy Restriction - Create Or Update

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

Creates or updates the policy restriction configuration of the Api Management service.

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

URI Parameters

Name In Required Type Description
policyRestrictionId
 path True

string

Policy restrictions after an entity level
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.requireBase

PolicyRestrictionRequireBase

Indicates if base policy should be enforced for the policy document.
properties.scope

string

Path to the policy document.

Responses

Name Type Description
200 OK

PolicyRestrictionContract

Policy restriction configuration of the Api Management service was successfully updated.

Headers

ETag: string
201 Created

PolicyRestrictionContract

Policy restriction configuration 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

ApiManagementCreatePolicyRestriction

Sample request

PUT 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 to the policy document.",
    "requireBase": "true"
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyRestrictions1",
  "properties": {
    "scope": "Sample Path to the policy document.",
    "requireBase": "true"
  }
}
Status code:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyRestrictions2",
  "properties": {
    "scope": "Sample Path to the policy document.",
    "requireBase": "true"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
PolicyRestrictionContract

Policy restriction contract details.
PolicyRestrictionRequireBase

Indicates if base policy should be enforced for the policy document.

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.

PolicyRestrictionContract

Policy restriction contract details.

Name Type Default value 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.requireBase

PolicyRestrictionRequireBase

false

Indicates if base policy should be enforced for the policy document.
properties.scope

string

Path to the policy document.
type

string

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

PolicyRestrictionRequireBase

Indicates if base policy should be enforced for the policy document.

Name Type Description
false

string

The policy does not require to have base policy
true

string

The policy is required to have base policy