1. Packages
  2. Azure Classic
  3. API Docs
  4. communication
  5. EmailService

We recommend using Azure Native.

Azure Classic v6.5.0 published on Monday, Oct 14, 2024 by Pulumi

azure.communication.EmailService

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.5.0 published on Monday, Oct 14, 2024 by Pulumi

    Manages an Email Communication Service.

    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 exampleEmailService = new azure.communication.EmailService("example", {
        name: "example-emailcommunicationservice",
        resourceGroupName: example.name,
        dataLocation: "United States",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_email_service = azure.communication.EmailService("example",
        name="example-emailcommunicationservice",
        resource_group_name=example.name,
        data_location="United States")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/communication"
    	"github.com/pulumi/pulumi-azure/sdk/v6/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
    		}
    		_, err = communication.NewEmailService(ctx, "example", &communication.EmailServiceArgs{
    			Name:              pulumi.String("example-emailcommunicationservice"),
    			ResourceGroupName: example.Name,
    			DataLocation:      pulumi.String("United States"),
    		})
    		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 exampleEmailService = new Azure.Communication.EmailService("example", new()
        {
            Name = "example-emailcommunicationservice",
            ResourceGroupName = example.Name,
            DataLocation = "United States",
        });
    
    });
    
    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.communication.EmailService;
    import com.pulumi.azure.communication.EmailServiceArgs;
    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 exampleEmailService = new EmailService("exampleEmailService", EmailServiceArgs.builder()
                .name("example-emailcommunicationservice")
                .resourceGroupName(example.name())
                .dataLocation("United States")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleEmailService:
        type: azure:communication:EmailService
        name: example
        properties:
          name: example-emailcommunicationservice
          resourceGroupName: ${example.name}
          dataLocation: United States
    

    Create EmailService Resource

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

    Constructor syntax

    new EmailService(name: string, args: EmailServiceArgs, opts?: CustomResourceOptions);
    @overload
    def EmailService(resource_name: str,
                     args: EmailServiceArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailService(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     data_location: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewEmailService(ctx *Context, name string, args EmailServiceArgs, opts ...ResourceOption) (*EmailService, error)
    public EmailService(string name, EmailServiceArgs args, CustomResourceOptions? opts = null)
    public EmailService(String name, EmailServiceArgs args)
    public EmailService(String name, EmailServiceArgs args, CustomResourceOptions options)
    
    type: azure:communication:EmailService
    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 EmailServiceArgs
    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 EmailServiceArgs
    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 EmailServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailServiceArgs
    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 emailServiceResource = new Azure.Communication.EmailService("emailServiceResource", new()
    {
        DataLocation = "string",
        ResourceGroupName = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := communication.NewEmailService(ctx, "emailServiceResource", &communication.EmailServiceArgs{
    	DataLocation:      pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var emailServiceResource = new EmailService("emailServiceResource", EmailServiceArgs.builder()
        .dataLocation("string")
        .resourceGroupName("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    email_service_resource = azure.communication.EmailService("emailServiceResource",
        data_location="string",
        resource_group_name="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const emailServiceResource = new azure.communication.EmailService("emailServiceResource", {
        dataLocation: "string",
        resourceGroupName: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:communication:EmailService
    properties:
        dataLocation: string
        name: string
        resourceGroupName: string
        tags:
            string: string
    

    EmailService 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 EmailService resource accepts the following input properties:

    DataLocation string
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    ResourceGroupName string
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    Name string
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Email Communication Service.
    DataLocation string
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    ResourceGroupName string
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    Name string
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Email Communication Service.
    dataLocation String
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    resourceGroupName String
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    name String
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Email Communication Service.
    dataLocation string
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    resourceGroupName string
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    name string
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Email Communication Service.
    data_location str
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    resource_group_name str
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    name str
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Email Communication Service.
    dataLocation String
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    resourceGroupName String
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    name String
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Email Communication Service.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EmailService Resource

    Get an existing EmailService 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?: EmailServiceState, opts?: CustomResourceOptions): EmailService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            data_location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> EmailService
    func GetEmailService(ctx *Context, name string, id IDInput, state *EmailServiceState, opts ...ResourceOption) (*EmailService, error)
    public static EmailService Get(string name, Input<string> id, EmailServiceState? state, CustomResourceOptions? opts = null)
    public static EmailService get(String name, Output<String> id, EmailServiceState 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:
    DataLocation string
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    Name string
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    ResourceGroupName string
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Email Communication Service.
    DataLocation string
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    Name string
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    ResourceGroupName string
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Email Communication Service.
    dataLocation String
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    name String
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    resourceGroupName String
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Email Communication Service.
    dataLocation string
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    name string
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    resourceGroupName string
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Email Communication Service.
    data_location str
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    name str
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    resource_group_name str
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Email Communication Service.
    dataLocation String
    The location where the Email Communication service stores its data at rest. Possible values are Africa, Asia Pacific, Australia, Brazil, Canada, Europe, France, Germany, India, Japan, Korea, Norway, Switzerland, UAE, UK and United States. Changing this forces a new Email Communication Service to be created.
    name String
    The name of the Email Communication Service resource. Changing this forces a new Email Communication Service to be created.
    resourceGroupName String
    The name of the Resource Group where the Email Communication Service should exist. Changing this forces a new Email Communication Service to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Email Communication Service.

    Import

    Communication Services can be imported using the resource id, e.g.

    $ pulumi import azure:communication/emailService:EmailService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Communication/emailServices/emailCommunicationService1
    

    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 v6.5.0 published on Monday, Oct 14, 2024 by Pulumi