com.pulumi.azure.apimanagement.kotlin.EmailTemplateArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.apimanagement.kotlin
import com.pulumi.azure.apimanagement.EmailTemplateArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Manages a API Management Email Template.
* ## Example Usage
*
* ```typescript
* 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: "[email protected]",
* 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: `
*
*
*
* Customized Letter Title
*
*
* Dear DevFirstName DevLastName,
*
*
* `,
* });
* ```
* ```python
* 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="[email protected]",
* 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="""
*
*
*
* Customized Letter Title
*
*
* Dear $DevFirstName $DevLastName,
*
*
* """)
* ```
* ```csharp
* 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 = "[email protected]",
* 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 = @"
*
*
*
* Customized Letter Title
*
*
* Dear $DevFirstName $DevLastName,
*
*
* ",
* });
* });
* ```
* ```go
* 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("[email protected]"),
* 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(`
*
*
*
* Customized Letter Title
*
*
* Dear $DevFirstName $DevLastName,
*
*
* `),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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("[email protected]")
* .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("""
*
*
*
*
* Customized Letter Title
*
*
* Dear $DevFirstName $DevLastName,
*
*
* """)
* .build());
* }
* }
* ```
* ```yaml
* 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: [email protected]
* 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: |
*
*
*
*
* Customized Letter Title
*
*
* Dear $DevFirstName $DevLastName,
*
*
* ```
*
* ## Import
* API Management Email Templates can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/emailTemplate:EmailTemplate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/instance1/templates/template1
* ```
* @property apiManagementName 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.
* @property body 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` - `$`. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.
* @property resourceGroupName 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.
* @property subject The subject of the Email.
* @property templateName 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.
*/
public data class EmailTemplateArgs(
public val apiManagementName: Output? = null,
public val body: Output? = null,
public val resourceGroupName: Output? = null,
public val subject: Output? = null,
public val templateName: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.apimanagement.EmailTemplateArgs =
com.pulumi.azure.apimanagement.EmailTemplateArgs.builder()
.apiManagementName(apiManagementName?.applyValue({ args0 -> args0 }))
.body(body?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.subject(subject?.applyValue({ args0 -> args0 }))
.templateName(templateName?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [EmailTemplateArgs].
*/
@PulumiTagMarker
public class EmailTemplateArgsBuilder internal constructor() {
private var apiManagementName: Output? = null
private var body: Output? = null
private var resourceGroupName: Output? = null
private var subject: Output? = null
private var templateName: Output? = null
/**
* @param value 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.
*/
@JvmName("tyljyxvllytjfkwh")
public suspend fun apiManagementName(`value`: Output) {
this.apiManagementName = value
}
/**
* @param value 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` - `$`. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.
*/
@JvmName("wigjhqkyyhnlpxsa")
public suspend fun body(`value`: Output) {
this.body = value
}
/**
* @param value 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.
*/
@JvmName("necbfxsqkwkwjaud")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The subject of the Email.
*/
@JvmName("gtgjqkbhxdfxrojc")
public suspend fun subject(`value`: Output) {
this.subject = value
}
/**
* @param value 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.
*/
@JvmName("gkviandluhdbjjju")
public suspend fun templateName(`value`: Output) {
this.templateName = value
}
/**
* @param value 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.
*/
@JvmName("omqyqjynrosvkehn")
public suspend fun apiManagementName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiManagementName = mapped
}
/**
* @param value 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` - `$`. The available parameters can be seen in the Notification templates section of the API-Management Service instance within the Azure Portal.
*/
@JvmName("maeypwfhmhwbbsok")
public suspend fun body(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.body = mapped
}
/**
* @param value 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.
*/
@JvmName("qcknepivgiftlmol")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The subject of the Email.
*/
@JvmName("pelxwbqimghlmnwq")
public suspend fun subject(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subject = mapped
}
/**
* @param value 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.
*/
@JvmName("hjwuaogmpklaiksc")
public suspend fun templateName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.templateName = mapped
}
internal fun build(): EmailTemplateArgs = EmailTemplateArgs(
apiManagementName = apiManagementName,
body = body,
resourceGroupName = resourceGroupName,
subject = subject,
templateName = templateName,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy