Microsoft.ApiManagement service/policies 2018-01-01
- Latest
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
Bicep resource definition
The service/policies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/policies resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/policies@2018-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
contentFormat: 'string'
policyContent: 'string'
}
}
Property values
Microsoft.ApiManagement/service/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 |
| properties | Properties of the Policy. | PolicyContractProperties |
PolicyContractProperties
| Name | Description | Value |
|---|---|---|
| contentFormat | Format of the policyContent. | 'rawxml' 'rawxml-link' 'xml' 'xml-link' |
| policyContent | Json escaped Xml Encoded contents of the Policy. | string (required) |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Front Door Standard/Premium with API Management origin | This template creates a Front Door Premium and an API Management instance, and uses an NSG and global API Management policy to validate that traffic has come through the Front Door origin. |
ARM template resource definition
The service/policies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/policies resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/policies",
"apiVersion": "2018-01-01",
"name": "string",
"properties": {
"contentFormat": "string",
"policyContent": "string"
}
}
Property values
Microsoft.ApiManagement/service/policies
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-01-01' |
| name | The resource name | 'policy' (required) |
| properties | Properties of the Policy. | PolicyContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/policies' |
PolicyContractProperties
| Name | Description | Value |
|---|---|---|
| contentFormat | Format of the policyContent. | 'rawxml' 'rawxml-link' 'xml' 'xml-link' |
| policyContent | Json escaped Xml Encoded contents of the Policy. | string (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Front Door Standard/Premium with API Management origin |
This template creates a Front Door Premium and an API Management instance, and uses an NSG and global API Management policy to validate that traffic has come through the Front Door origin. |
Terraform (AzAPI provider) resource definition
The service/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/policies resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/policies@2018-01-01"
name = "string"
body = jsonencode({
properties = {
contentFormat = "string"
policyContent = "string"
}
})
}
Property values
Microsoft.ApiManagement/service/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 |
| properties | Properties of the Policy. | PolicyContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/policies@2018-01-01" |
PolicyContractProperties
| Name | Description | Value |
|---|---|---|
| contentFormat | Format of the policyContent. | 'rawxml' 'rawxml-link' 'xml' 'xml-link' |
| policyContent | Json escaped Xml Encoded contents of the Policy. | string (required) |