Microsoft.ApiManagement service/templates 2021-08-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiManagement/service/templates@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    body: 'string'
    description: 'string'
    parameters: [
      {
        description: 'string'
        name: 'string'
        title: 'string'
      }
    ]
    subject: 'string'
    title: 'string'
  }
}

Property values

service/templates

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
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 Email Template Update contract properties. EmailTemplateUpdateParameterPropertiesOrEmailTemplat...

EmailTemplateUpdateParameterPropertiesOrEmailTemplat...

Name Description Value
body Email Template Body. This should be a valid XDocument string
description Description of the Email Template. string
parameters Email Template Parameter values. EmailTemplateParametersContractProperties[]
subject Subject of the Template. string
title Title of the Template. string

EmailTemplateParametersContractProperties

Name Description Value
description Template parameter description. string
name Template parameter name. string
title Template parameter title. string

ARM template resource definition

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

{
  "type": "Microsoft.ApiManagement/service/templates",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "body": "string",
    "description": "string",
    "parameters": [
      {
        "description": "string",
        "name": "string",
        "title": "string"
      }
    ],
    "subject": "string",
    "title": "string"
  }
}

Property values

service/templates

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/templates'
apiVersion The resource api version '2021-08-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
properties Email Template Update contract properties. EmailTemplateUpdateParameterPropertiesOrEmailTemplat...

EmailTemplateUpdateParameterPropertiesOrEmailTemplat...

Name Description Value
body Email Template Body. This should be a valid XDocument string
description Description of the Email Template. string
parameters Email Template Parameter values. EmailTemplateParametersContractProperties[]
subject Subject of the Template. string
title Title of the Template. string

EmailTemplateParametersContractProperties

Name Description Value
description Template parameter description. string
name Template parameter name. string
title Template parameter title. string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/templates@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      body = "string"
      description = "string"
      parameters = [
        {
          description = "string"
          name = "string"
          title = "string"
        }
      ]
      subject = "string"
      title = "string"
    }
  })
}

Property values

service/templates

Name Description Value
type The resource type "Microsoft.ApiManagement/service/templates@2021-08-01"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics and hyphens.

Start with letter and end with alphanumeric.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Email Template Update contract properties. EmailTemplateUpdateParameterPropertiesOrEmailTemplat...

EmailTemplateUpdateParameterPropertiesOrEmailTemplat...

Name Description Value
body Email Template Body. This should be a valid XDocument string
description Description of the Email Template. string
parameters Email Template Parameter values. EmailTemplateParametersContractProperties[]
subject Subject of the Template. string
title Title of the Template. string

EmailTemplateParametersContractProperties

Name Description Value
description Template parameter description. string
name Template parameter name. string
title Template parameter title. string