Microsoft.ApiManagement service/templates
- 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/templates 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/templates resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/templates@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
body: 'string'
description: 'string'
parameters: [
{
description: 'string'
name: 'string'
title: 'string'
}
]
subject: 'string'
title: 'string'
}
}
Property Values
EmailTemplateParametersContractProperties
| Name | Description | Value |
|---|---|---|
| description | Template parameter description. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| name | Template parameter name. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| title | Template parameter title. | string Constraints: Min length = 1 Max length = 4096 |
EmailTemplateUpdateParameterPropertiesOrEmailTemplateContractProperties
| Name | Description | Value |
|---|---|---|
| body | Email Template Body. This should be a valid XDocument | string Constraints: Min length = 1 |
| description | Description of the Email Template. | string |
| parameters | Email Template Parameter values. | EmailTemplateParametersContractProperties[] |
| subject | Subject of the Template. | string Constraints: Min length = 1 Max length = 1000 |
| title | Title of the Template. | string |
Microsoft.ApiManagement/service/templates
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'accountClosedDeveloper' 'applicationApprovedNotificationMessage' 'confirmSignUpIdentityDefault' 'emailChangeIdentityDefault' 'inviteUserNotificationMessage' 'newCommentNotificationMessage' 'newDeveloperNotificationMessage' 'newIssueNotificationMessage' 'passwordResetByAdminNotificationMessage' 'passwordResetIdentityDefault' 'purchaseDeveloperNotificationMessage' 'quotaLimitApproachingDeveloperNotificationMessage' 'rejectDeveloperNotificationMessage' 'requestDeveloperNotificationMessage' (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 | Email Template Update contract properties. | EmailTemplateUpdateParameterPropertiesOrEmailTemplateContractProperties |
ARM template resource definition
The service/templates 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/templates resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/templates",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"body": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"title": "string"
}
],
"subject": "string",
"title": "string"
}
}
Property Values
EmailTemplateParametersContractProperties
| Name | Description | Value |
|---|---|---|
| description | Template parameter description. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| name | Template parameter name. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| title | Template parameter title. | string Constraints: Min length = 1 Max length = 4096 |
EmailTemplateUpdateParameterPropertiesOrEmailTemplateContractProperties
| Name | Description | Value |
|---|---|---|
| body | Email Template Body. This should be a valid XDocument | string Constraints: Min length = 1 |
| description | Description of the Email Template. | string |
| parameters | Email Template Parameter values. | EmailTemplateParametersContractProperties[] |
| subject | Subject of the Template. | string Constraints: Min length = 1 Max length = 1000 |
| title | Title of the Template. | string |
Microsoft.ApiManagement/service/templates
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | 'accountClosedDeveloper' 'applicationApprovedNotificationMessage' 'confirmSignUpIdentityDefault' 'emailChangeIdentityDefault' 'inviteUserNotificationMessage' 'newCommentNotificationMessage' 'newDeveloperNotificationMessage' 'newIssueNotificationMessage' 'passwordResetByAdminNotificationMessage' 'passwordResetIdentityDefault' 'purchaseDeveloperNotificationMessage' 'quotaLimitApproachingDeveloperNotificationMessage' 'rejectDeveloperNotificationMessage' 'requestDeveloperNotificationMessage' (required) |
| properties | Email Template Update contract properties. | EmailTemplateUpdateParameterPropertiesOrEmailTemplateContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/templates' |
Usage Examples
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@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
body = "string"
description = "string"
parameters = [
{
description = "string"
name = "string"
title = "string"
}
]
subject = "string"
title = "string"
}
})
}
Property Values
EmailTemplateParametersContractProperties
| Name | Description | Value |
|---|---|---|
| description | Template parameter description. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| name | Template parameter name. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| title | Template parameter title. | string Constraints: Min length = 1 Max length = 4096 |
EmailTemplateUpdateParameterPropertiesOrEmailTemplateContractProperties
| Name | Description | Value |
|---|---|---|
| body | Email Template Body. This should be a valid XDocument | string Constraints: Min length = 1 |
| description | Description of the Email Template. | string |
| parameters | Email Template Parameter values. | EmailTemplateParametersContractProperties[] |
| subject | Subject of the Template. | string Constraints: Min length = 1 Max length = 1000 |
| title | Title of the Template. | string |
Microsoft.ApiManagement/service/templates
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'accountClosedDeveloper' 'applicationApprovedNotificationMessage' 'confirmSignUpIdentityDefault' 'emailChangeIdentityDefault' 'inviteUserNotificationMessage' 'newCommentNotificationMessage' 'newDeveloperNotificationMessage' 'newIssueNotificationMessage' 'passwordResetByAdminNotificationMessage' 'passwordResetIdentityDefault' 'purchaseDeveloperNotificationMessage' 'quotaLimitApproachingDeveloperNotificationMessage' 'rejectDeveloperNotificationMessage' 'requestDeveloperNotificationMessage' (required) |
| 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. | EmailTemplateUpdateParameterPropertiesOrEmailTemplateContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/templates@2024-06-01-preview" |