Share via

Microsoft.ApiManagement service/policyRestrictions 2023-05-01-preview

  • Article

Bicep resource definition

The service/policyRestrictions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/policyRestrictions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/policyRestrictions@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    requireBase: 'string'
    scope: 'string'
  }
}

Property values

Microsoft.ApiManagement/service/policyRestrictions

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: service
properties Properties of the Policy Restriction. PolicyRestrictionContractProperties

PolicyRestrictionContractProperties

Name Description Value
requireBase Indicates if base policy should be enforced for the policy document. 'false'
'true'
scope Path to the policy document. string

ARM template resource definition

The service/policyRestrictions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/policyRestrictions resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/policyRestrictions",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "requireBase": "string",
    "scope": "string"
  }
}

Property values

Microsoft.ApiManagement/service/policyRestrictions

Name Description Value
apiVersion The api version '2023-05-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
properties Properties of the Policy Restriction. PolicyRestrictionContractProperties
type The resource type 'Microsoft.ApiManagement/service/policyRestrictions'

PolicyRestrictionContractProperties

Name Description Value
requireBase Indicates if base policy should be enforced for the policy document. 'false'
'true'
scope Path to the policy document. string

Terraform (AzAPI provider) resource definition

The service/policyRestrictions resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/policyRestrictions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/policyRestrictions@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      requireBase = "string"
      scope = "string"
    }
  })
}

Property values

Microsoft.ApiManagement/service/policyRestrictions

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Properties of the Policy Restriction. PolicyRestrictionContractProperties
type The resource type "Microsoft.ApiManagement/service/policyRestrictions@2023-05-01-preview"

PolicyRestrictionContractProperties

Name Description Value
requireBase Indicates if base policy should be enforced for the policy document. 'false'
'true'
scope Path to the policy document. string