Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. EmailTemplate
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.EmailTemplate

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Email Template details.

Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.

Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Example Usage

ApiManagementCreateTemplate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var emailTemplate = new AzureNative.ApiManagement.EmailTemplate("emailTemplate", new()
    {
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        Subject = "Your request for $IssueName was successfully received.",
        TemplateName = "newIssueNotificationMessage",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewEmailTemplate(ctx, "emailTemplate", &apimanagement.EmailTemplateArgs{
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			Subject:           pulumi.String("Your request for $IssueName was successfully received."),
			TemplateName:      pulumi.String("newIssueNotificationMessage"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.EmailTemplate;
import com.pulumi.azurenative.apimanagement.EmailTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var emailTemplate = new EmailTemplate("emailTemplate", EmailTemplateArgs.builder()
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .subject("Your request for $IssueName was successfully received.")
            .templateName("newIssueNotificationMessage")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const emailTemplate = new azure_native.apimanagement.EmailTemplate("emailTemplate", {
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    subject: "Your request for $IssueName was successfully received.",
    templateName: "newIssueNotificationMessage",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

email_template = azure_native.apimanagement.EmailTemplate("emailTemplate",
    resource_group_name="rg1",
    service_name="apimService1",
    subject="Your request for $IssueName was successfully received.",
    template_name="newIssueNotificationMessage")
Copy
resources:
  emailTemplate:
    type: azure-native:apimanagement:EmailTemplate
    properties:
      resourceGroupName: rg1
      serviceName: apimService1
      subject: Your request for $IssueName was successfully received.
      templateName: newIssueNotificationMessage
Copy

Create EmailTemplate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EmailTemplate(name: string, args: EmailTemplateArgs, opts?: CustomResourceOptions);
@overload
def EmailTemplate(resource_name: str,
                  args: EmailTemplateArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def EmailTemplate(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  resource_group_name: Optional[str] = None,
                  service_name: Optional[str] = None,
                  body: Optional[str] = None,
                  description: Optional[str] = None,
                  parameters: Optional[Sequence[EmailTemplateParametersContractPropertiesArgs]] = None,
                  subject: Optional[str] = None,
                  template_name: Optional[str] = None,
                  title: Optional[str] = None)
func NewEmailTemplate(ctx *Context, name string, args EmailTemplateArgs, opts ...ResourceOption) (*EmailTemplate, error)
public EmailTemplate(string name, EmailTemplateArgs args, CustomResourceOptions? opts = null)
public EmailTemplate(String name, EmailTemplateArgs args)
public EmailTemplate(String name, EmailTemplateArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:EmailTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EmailTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EmailTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EmailTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EmailTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EmailTemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var emailTemplateResource = new AzureNative.ApiManagement.EmailTemplate("emailTemplateResource", new()
{
    ResourceGroupName = "string",
    ServiceName = "string",
    Body = "string",
    Description = "string",
    Parameters = new[]
    {
        new AzureNative.ApiManagement.Inputs.EmailTemplateParametersContractPropertiesArgs
        {
            Description = "string",
            Name = "string",
            Title = "string",
        },
    },
    Subject = "string",
    TemplateName = "string",
    Title = "string",
});
Copy
example, err := apimanagement.NewEmailTemplate(ctx, "emailTemplateResource", &apimanagement.EmailTemplateArgs{
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Body:              pulumi.String("string"),
	Description:       pulumi.String("string"),
	Parameters: apimanagement.EmailTemplateParametersContractPropertiesArray{
		&apimanagement.EmailTemplateParametersContractPropertiesArgs{
			Description: pulumi.String("string"),
			Name:        pulumi.String("string"),
			Title:       pulumi.String("string"),
		},
	},
	Subject:      pulumi.String("string"),
	TemplateName: pulumi.String("string"),
	Title:        pulumi.String("string"),
})
Copy
var emailTemplateResource = new EmailTemplate("emailTemplateResource", EmailTemplateArgs.builder()
    .resourceGroupName("string")
    .serviceName("string")
    .body("string")
    .description("string")
    .parameters(EmailTemplateParametersContractPropertiesArgs.builder()
        .description("string")
        .name("string")
        .title("string")
        .build())
    .subject("string")
    .templateName("string")
    .title("string")
    .build());
Copy
email_template_resource = azure_native.apimanagement.EmailTemplate("emailTemplateResource",
    resource_group_name="string",
    service_name="string",
    body="string",
    description="string",
    parameters=[{
        "description": "string",
        "name": "string",
        "title": "string",
    }],
    subject="string",
    template_name="string",
    title="string")
Copy
const emailTemplateResource = new azure_native.apimanagement.EmailTemplate("emailTemplateResource", {
    resourceGroupName: "string",
    serviceName: "string",
    body: "string",
    description: "string",
    parameters: [{
        description: "string",
        name: "string",
        title: "string",
    }],
    subject: "string",
    templateName: "string",
    title: "string",
});
Copy
type: azure-native:apimanagement:EmailTemplate
properties:
    body: string
    description: string
    parameters:
        - description: string
          name: string
          title: string
    resourceGroupName: string
    serviceName: string
    subject: string
    templateName: string
    title: string
Copy

EmailTemplate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EmailTemplate resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Body string
Email Template Body. This should be a valid XDocument
Description string
Description of the Email Template.
Parameters List<Pulumi.AzureNative.ApiManagement.Inputs.EmailTemplateParametersContractProperties>
Email Template Parameter values.
Subject string
Subject of the Template.
TemplateName Changes to this property will trigger replacement. string
Email Template Name Identifier.
Title string
Title of the Template.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
Body string
Email Template Body. This should be a valid XDocument
Description string
Description of the Email Template.
Parameters []EmailTemplateParametersContractPropertiesArgs
Email Template Parameter values.
Subject string
Subject of the Template.
TemplateName Changes to this property will trigger replacement. string
Email Template Name Identifier.
Title string
Title of the Template.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
body String
Email Template Body. This should be a valid XDocument
description String
Description of the Email Template.
parameters List<EmailTemplateParametersContractProperties>
Email Template Parameter values.
subject String
Subject of the Template.
templateName Changes to this property will trigger replacement. String
Email Template Name Identifier.
title String
Title of the Template.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
body string
Email Template Body. This should be a valid XDocument
description string
Description of the Email Template.
parameters EmailTemplateParametersContractProperties[]
Email Template Parameter values.
subject string
Subject of the Template.
templateName Changes to this property will trigger replacement. string
Email Template Name Identifier.
title string
Title of the Template.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
body str
Email Template Body. This should be a valid XDocument
description str
Description of the Email Template.
parameters Sequence[EmailTemplateParametersContractPropertiesArgs]
Email Template Parameter values.
subject str
Subject of the Template.
template_name Changes to this property will trigger replacement. str
Email Template Name Identifier.
title str
Title of the Template.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
body String
Email Template Body. This should be a valid XDocument
description String
Description of the Email Template.
parameters List<Property Map>
Email Template Parameter values.
subject String
Subject of the Template.
templateName Changes to this property will trigger replacement. String
Email Template Name Identifier.
title String
Title of the Template.

Outputs

All input properties are implicitly available as output properties. Additionally, the EmailTemplate resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsDefault bool
Whether the template is the default template provided by API Management or has been edited.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsDefault bool
Whether the template is the default template provided by API Management or has been edited.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isDefault Boolean
Whether the template is the default template provided by API Management or has been edited.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
isDefault boolean
Whether the template is the default template provided by API Management or has been edited.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
is_default bool
Whether the template is the default template provided by API Management or has been edited.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
isDefault Boolean
Whether the template is the default template provided by API Management or has been edited.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

EmailTemplateParametersContractProperties
, EmailTemplateParametersContractPropertiesArgs

Description string
Template parameter description.
Name string
Template parameter name.
Title string
Template parameter title.
Description string
Template parameter description.
Name string
Template parameter name.
Title string
Template parameter title.
description String
Template parameter description.
name String
Template parameter name.
title String
Template parameter title.
description string
Template parameter description.
name string
Template parameter name.
title string
Template parameter title.
description str
Template parameter description.
name str
Template parameter name.
title str
Template parameter title.
description String
Template parameter description.
name String
Template parameter name.
title String
Template parameter title.

EmailTemplateParametersContractPropertiesResponse
, EmailTemplateParametersContractPropertiesResponseArgs

Description string
Template parameter description.
Name string
Template parameter name.
Title string
Template parameter title.
Description string
Template parameter description.
Name string
Template parameter name.
Title string
Template parameter title.
description String
Template parameter description.
name String
Template parameter name.
title String
Template parameter title.
description string
Template parameter description.
name string
Template parameter name.
title string
Template parameter title.
description str
Template parameter description.
name str
Template parameter name.
title str
Template parameter title.
description String
Template parameter description.
name String
Template parameter name.
title String
Template parameter title.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:EmailTemplate NewIssueNotificationMessage /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native