1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. EmailTemplate

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.apimanagement.EmailTemplate

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a API Management Email Template.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleService = new azure.apimanagement.Service("example", {
        name: "example-apim",
        location: example.location,
        resourceGroupName: example.name,
        publisherName: "My Company",
        publisherEmail: "company@terraform.io",
        skuName: "Developer_1",
    });
    const exampleEmailTemplate = new azure.apimanagement.EmailTemplate("example", {
        templateName: "ConfirmSignUpIdentityDefault",
        resourceGroupName: example.name,
        apiManagementName: exampleService.name,
        subject: "Customized confirmation email for your new $OrganizationName API account",
        body: `<!DOCTYPE html >
    <html>
    <head>
      <meta charset="UTF-8" />
      <title>Customized Letter Title</title>
    </head>
    <body>
      <p style="font-size:12pt;font-family:'Segoe UI'">Dear DevFirstName DevLastName,</p>
    </body>
    </html>
    `,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_service = azure.apimanagement.Service("example",
        name="example-apim",
        location=example.location,
        resource_group_name=example.name,
        publisher_name="My Company",
        publisher_email="company@terraform.io",
        sku_name="Developer_1")
    example_email_template = azure.apimanagement.EmailTemplate("example",
        template_name="ConfirmSignUpIdentityDefault",
        resource_group_name=example.name,
        api_management_name=example_service.name,
        subject="Customized confirmation email for your new $OrganizationName API account",
        body="""<!DOCTYPE html >
    <html>
    <head>
      <meta charset="UTF-8" />
      <title>Customized Letter Title</title>
    </head>
    <body>
      <p style="font-size:12pt;font-family:'Segoe UI'">Dear $DevFirstName $DevLastName,</p>
    </body>
    </html>
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
    			Name:              pulumi.String("example-apim"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			PublisherName:     pulumi.String("My Company"),
    			PublisherEmail:    pulumi.String("company@terraform.io"),
    			SkuName:           pulumi.String("Developer_1"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewEmailTemplate(ctx, "example", &apimanagement.EmailTemplateArgs{
    			TemplateName:      pulumi.String("ConfirmSignUpIdentityDefault"),
    			ResourceGroupName: example.Name,
    			ApiManagementName: exampleService.Name,
    			Subject:           pulumi.String("Customized confirmation email for your new $OrganizationName API account"),
    			Body: pulumi.String(`<!DOCTYPE html >
    <html>
    <head>
      <meta charset="UTF-8" />
      <title>Customized Letter Title</title>
    </head>
    <body>
      <p style="font-size:12pt;font-family:'Segoe UI'">Dear $DevFirstName $DevLastName,</p>
    </body>
    </html>
    `),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleService = new Azure.ApiManagement.Service("example", new()
        {
            Name = "example-apim",
            Location = example.Location,
            ResourceGroupName = example.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@terraform.io",
            SkuName = "Developer_1",
        });
    
        var exampleEmailTemplate = new Azure.ApiManagement.EmailTemplate("example", new()
        {
            TemplateName = "ConfirmSignUpIdentityDefault",
            ResourceGroupName = example.Name,
            ApiManagementName = exampleService.Name,
            Subject = "Customized confirmation email for your new $OrganizationName API account",
            Body = @"<!DOCTYPE html >
    <html>
    <head>
      <meta charset=""UTF-8"" />
      <title>Customized Letter Title</title>
    </head>
    <body>
      <p style=""font-size:12pt;font-family:'Segoe UI'"">Dear $DevFirstName $DevLastName,</p>
    </body>
    </html>
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.apimanagement.Service;
    import com.pulumi.azure.apimanagement.ServiceArgs;
    import com.pulumi.azure.apimanagement.EmailTemplate;
    import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()
                .name("example-apim")
                .location(example.location())
                .resourceGroupName(example.name())
                .publisherName("My Company")
                .publisherEmail("company@terraform.io")
                .skuName("Developer_1")
                .build());
    
            var exampleEmailTemplate = new EmailTemplate("exampleEmailTemplate", EmailTemplateArgs.builder()
                .templateName("ConfirmSignUpIdentityDefault")
                .resourceGroupName(example.name())
                .apiManagementName(exampleService.name())
                .subject("Customized confirmation email for your new $OrganizationName API account")
                .body("""
    <!DOCTYPE html >
    <html>
    <head>
      <meta charset="UTF-8" />
      <title>Customized Letter Title</title>
    </head>
    <body>
      <p style="font-size:12pt;font-family:'Segoe UI'">Dear $DevFirstName $DevLastName,</p>
    </body>
    </html>
                """)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleService:
        type: azure:apimanagement:Service
        name: example
        properties:
          name: example-apim
          location: ${example.location}
          resourceGroupName: ${example.name}
          publisherName: My Company
          publisherEmail: company@terraform.io
          skuName: Developer_1
      exampleEmailTemplate:
        type: azure:apimanagement:EmailTemplate
        name: example
        properties:
          templateName: ConfirmSignUpIdentityDefault
          resourceGroupName: ${example.name}
          apiManagementName: ${exampleService.name}
          subject: Customized confirmation email for your new $OrganizationName API account
          body: |
            <!DOCTYPE html >
            <html>
            <head>
              <meta charset="UTF-8" />
              <title>Customized Letter Title</title>
            </head>
            <body>
              <p style="font-size:12pt;font-family:'Segoe UI'">Dear $DevFirstName $DevLastName,</p>
            </body>
            </html>        
    

    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,
                      api_management_name: Optional[str] = None,
                      body: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      subject: Optional[str] = None,
                      template_name: 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:apimanagement:EmailTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EmailTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args EmailTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var emailTemplateResource = new Azure.ApiManagement.EmailTemplate("emailTemplateResource", new()
    {
        ApiManagementName = "string",
        Body = "string",
        ResourceGroupName = "string",
        Subject = "string",
        TemplateName = "string",
    });
    
    example, err := apimanagement.NewEmailTemplate(ctx, "emailTemplateResource", &apimanagement.EmailTemplateArgs{
    	ApiManagementName: pulumi.String("string"),
    	Body:              pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Subject:           pulumi.String("string"),
    	TemplateName:      pulumi.String("string"),
    })
    
    var emailTemplateResource = new EmailTemplate("emailTemplateResource", EmailTemplateArgs.builder()
        .apiManagementName("string")
        .body("string")
        .resourceGroupName("string")
        .subject("string")
        .templateName("string")
        .build());
    
    email_template_resource = azure.apimanagement.EmailTemplate("emailTemplateResource",
        api_management_name="string",
        body="string",
        resource_group_name="string",
        subject="string",
        template_name="string")
    
    const emailTemplateResource = new azure.apimanagement.EmailTemplate("emailTemplateResource", {
        apiManagementName: "string",
        body: "string",
        resourceGroupName: "string",
        subject: "string",
        templateName: "string",
    });
    
    type: azure:apimanagement:EmailTemplate
    properties:
        apiManagementName: string
        body: string
        resourceGroupName: string
        subject: string
        templateName: string
    

    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

    The EmailTemplate resource accepts the following input properties:

    ApiManagementName string
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Body string

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    ResourceGroupName string
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Subject string
    The subject of the Email.
    TemplateName string
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    ApiManagementName string
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Body string

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    ResourceGroupName string
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Subject string
    The subject of the Email.
    TemplateName string
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    apiManagementName String
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body String

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    resourceGroupName String
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject String
    The subject of the Email.
    templateName String
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    apiManagementName string
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body string

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    resourceGroupName string
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject string
    The subject of the Email.
    templateName string
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    api_management_name str
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body str

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    resource_group_name str
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject str
    The subject of the Email.
    template_name str
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    apiManagementName String
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body String

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    resourceGroupName String
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject String
    The subject of the Email.
    templateName String
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.

    Outputs

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

    Description string
    The description of the Email Template.
    Id string
    The provider-assigned unique ID for this managed resource.
    Title string
    The title of the Email Template.
    Description string
    The description of the Email Template.
    Id string
    The provider-assigned unique ID for this managed resource.
    Title string
    The title of the Email Template.
    description String
    The description of the Email Template.
    id String
    The provider-assigned unique ID for this managed resource.
    title String
    The title of the Email Template.
    description string
    The description of the Email Template.
    id string
    The provider-assigned unique ID for this managed resource.
    title string
    The title of the Email Template.
    description str
    The description of the Email Template.
    id str
    The provider-assigned unique ID for this managed resource.
    title str
    The title of the Email Template.
    description String
    The description of the Email Template.
    id String
    The provider-assigned unique ID for this managed resource.
    title String
    The title of the Email Template.

    Look up Existing EmailTemplate Resource

    Get an existing EmailTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EmailTemplateState, opts?: CustomResourceOptions): EmailTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_management_name: Optional[str] = None,
            body: Optional[str] = None,
            description: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            subject: Optional[str] = None,
            template_name: Optional[str] = None,
            title: Optional[str] = None) -> EmailTemplate
    func GetEmailTemplate(ctx *Context, name string, id IDInput, state *EmailTemplateState, opts ...ResourceOption) (*EmailTemplate, error)
    public static EmailTemplate Get(string name, Input<string> id, EmailTemplateState? state, CustomResourceOptions? opts = null)
    public static EmailTemplate get(String name, Output<String> id, EmailTemplateState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementName string
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Body string

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    Description string
    The description of the Email Template.
    ResourceGroupName string
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Subject string
    The subject of the Email.
    TemplateName string
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    Title string
    The title of the Email Template.
    ApiManagementName string
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Body string

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    Description string
    The description of the Email Template.
    ResourceGroupName string
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    Subject string
    The subject of the Email.
    TemplateName string
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    Title string
    The title of the Email Template.
    apiManagementName String
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body String

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    description String
    The description of the Email Template.
    resourceGroupName String
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject String
    The subject of the Email.
    templateName String
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    title String
    The title of the Email Template.
    apiManagementName string
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body string

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    description string
    The description of the Email Template.
    resourceGroupName string
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject string
    The subject of the Email.
    templateName string
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    title string
    The title of the Email Template.
    api_management_name str
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body str

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    description str
    The description of the Email Template.
    resource_group_name str
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject str
    The subject of the Email.
    template_name str
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    title str
    The title of the Email Template.
    apiManagementName String
    The name of the API Management Service in which the Email Template should exist. Changing this forces a new API Management Email Template to be created.
    body String

    The body of the Email. Its format has to be a well-formed HTML document.

    NOTE: In subject and body predefined parameters can be used. The available parameters depend on the template. Schema to use a parameter: $ followed by the parameter.name - $<parameter.name>. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.

    description String
    The description of the Email Template.
    resourceGroupName String
    The name of the Resource Group where the API Management Email Template should exist. Changing this forces a new API Management Email Template to be created.
    subject String
    The subject of the Email.
    templateName String
    The name of the Email Template. Possible values are AccountClosedDeveloper, ApplicationApprovedNotificationMessage, ConfirmSignUpIdentityDefault, EmailChangeIdentityDefault, InviteUserNotificationMessage, NewCommentNotificationMessage, NewDeveloperNotificationMessage, NewIssueNotificationMessage, PasswordResetByAdminNotificationMessage, PasswordResetIdentityDefault, PurchaseDeveloperNotificationMessage, QuotaLimitApproachingDeveloperNotificationMessage, RejectDeveloperNotificationMessage, RequestDeveloperNotificationMessage. Changing this forces a new API Management Email Template to be created.
    title String
    The title of the Email Template.

    Import

    API Management Email Templates can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/emailTemplate:EmailTemplate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/instance1/templates/template1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi