Microsoft.ApiManagement service/policies 2023-09-01-preview
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@2023-09-01-preview' = {
name: 'policy'
parent: resourceSymbolicName
properties: {
format: 'string'
value: 'string'
}
}
Property values
service/policies
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
'policy' |
| 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 |
|---|---|---|
| format | Format of the policyContent. | 'rawxml' 'rawxml-link' 'xml' 'xml-link' |
| value | Contents of the Policy as defined by the format. | string (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |
| 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": "2023-09-01-preview",
"name": "policy",
"properties": {
"format": "string",
"value": "string"
}
}
Property values
service/policies
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/policies' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'policy' |
| 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) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |
| 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@2023-09-01-preview"
name = "policy"
parent_id = "string"
body = jsonencode({
properties = {
format = "string"
value = "string"
}
})
}
Property values
service/policies
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/policies@2023-09-01-preview" |
| name | The resource name | "policy" |
| 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 |
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) |