Microsoft.ApiManagement service/products/policies 2025-03-01-preview

Bicep resource definition

The service/products/policies 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/products/policies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/products/policies@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    format: 'string'
    value: 'string'
  }
}

Property Values

Microsoft.ApiManagement/service/products/policies

Name Description Value
name The resource name 'policy' (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/products
properties Properties of the Policy. PolicyContractProperties

PolicyContractProperties

Name Description Value
format Format of the policyContent. 'rawxml'
'rawxml-link'
'xml'
'xml-link'
value Contents of the Policy as defined by the format. string (required)

Usage Examples

Bicep Samples

A basic example of deploying API Management Service Products Policies.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
  sku: {
    capacity: 0
    name: 'Consumption'
  }
}

resource product 'Microsoft.ApiManagement/service/products@2021-08-01' = {
  parent: service
  name: resourceName
  properties: {
    description: ''
    displayName: 'Test Product'
    state: 'notPublished'
    subscriptionRequired: false
    terms: ''
  }
}

resource policy2 'Microsoft.ApiManagement/service/products/policies@2021-08-01' = {
  parent: product
  name: 'policy'
  properties: {
    format: 'rawxml-link'
    value: 'https://gist.githubusercontent.com/riordanp/ca22f8113afae0eb38cc12d718fd048d/raw/d6ac89a2f35a6881a7729f8cb4883179dc88eea1/example.xml'
  }
}

ARM template resource definition

The service/products/policies 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/products/policies resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/products/policies",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "properties": {
    "format": "string",
    "value": "string"
  }
}

Property Values

Microsoft.ApiManagement/service/products/policies

Name Description Value
apiVersion The api version '2025-03-01-preview'
name The resource name 'policy' (required)
properties Properties of the Policy. PolicyContractProperties
type The resource type 'Microsoft.ApiManagement/service/products/policies'

PolicyContractProperties

Name Description Value
format Format of the policyContent. 'rawxml'
'rawxml-link'
'xml'
'xml-link'
value Contents of the Policy as defined by the format. string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The service/products/policies 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/products/policies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products/policies@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      format = "string"
      value = "string"
    }
  }
}

Property Values

Microsoft.ApiManagement/service/products/policies

Name Description Value
name The resource name 'policy' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/products
properties Properties of the Policy. PolicyContractProperties
type The resource type "Microsoft.ApiManagement/service/products/policies@2025-03-01-preview"

PolicyContractProperties

Name Description Value
format Format of the policyContent. 'rawxml'
'rawxml-link'
'xml'
'xml-link'
value Contents of the Policy as defined by the format. string (required)

Usage Examples

Terraform Samples

A basic example of deploying API Management Service Products Policies.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "product" {
  type      = "Microsoft.ApiManagement/service/products@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description          = ""
      displayName          = "Test Product"
      state                = "notPublished"
      subscriptionRequired = false
      terms                = ""
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "policy2" {
  type      = "Microsoft.ApiManagement/service/products/policies@2021-08-01"
  parent_id = azapi_resource.product.id
  name      = "policy"
  body = {
    properties = {
      format = "rawxml-link"
      value  = "https://gist.githubusercontent.com/riordanp/ca22f8113afae0eb38cc12d718fd048d/raw/d6ac89a2f35a6881a7729f8cb4883179dc88eea1/example.xml"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on