Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. bot
  5. ChannelEmail

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.bot.ChannelEmail

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Email integration for a Bot Channel

    Note A bot can only have a single Email Channel associated with it.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleChannelsRegistration = new azure.bot.ChannelsRegistration("example", {
    name: "example",
    location: "global",
    resourceGroupName: example.name,
    sku: "F0",
    microsoftAppId: current.then(current => current.clientId),
});
const exampleChannelEmail = new azure.bot.ChannelEmail("example", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: example.name,
    emailAddress: "example.com",
    emailPassword: "123456",
});

    import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_channels_registration = azure.bot.ChannelsRegistration("example",
    name="example",
    location="global",
    resource_group_name=example.name,
    sku="F0",
    microsoft_app_id=current.client_id)
example_channel_email = azure.bot.ChannelEmail("example",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example.name,
    email_address="example.com",
    email_password="123456")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/bot"
	"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 {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleChannelsRegistration, err := bot.NewChannelsRegistration(ctx, "example", &bot.ChannelsRegistrationArgs{
			Name:              pulumi.String("example"),
			Location:          pulumi.String("global"),
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("F0"),
			MicrosoftAppId:    pulumi.String(current.ClientId),
		})
		if err != nil {
			return err
		}
		_, err = bot.NewChannelEmail(ctx, "example", &bot.ChannelEmailArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: example.Name,
			EmailAddress:      pulumi.String("example.com"),
			EmailPassword:     pulumi.String("123456"),
		})
		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 current = Azure.Core.GetClientConfig.Invoke();

    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleChannelsRegistration = new Azure.Bot.ChannelsRegistration("example", new()
    {
        Name = "example",
        Location = "global",
        ResourceGroupName = example.Name,
        Sku = "F0",
        MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
    });

    var exampleChannelEmail = new Azure.Bot.ChannelEmail("example", new()
    {
        BotName = exampleChannelsRegistration.Name,
        Location = exampleChannelsRegistration.Location,
        ResourceGroupName = example.Name,
        EmailAddress = "example.com",
        EmailPassword = "123456",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.bot.ChannelsRegistration;
import com.pulumi.azure.bot.ChannelsRegistrationArgs;
import com.pulumi.azure.bot.ChannelEmail;
import com.pulumi.azure.bot.ChannelEmailArgs;
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) {
        final var current = CoreFunctions.getClientConfig();

        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleChannelsRegistration = new ChannelsRegistration("exampleChannelsRegistration", ChannelsRegistrationArgs.builder()
            .name("example")
            .location("global")
            .resourceGroupName(example.name())
            .sku("F0")
            .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
            .build());

        var exampleChannelEmail = new ChannelEmail("exampleChannelEmail", ChannelEmailArgs.builder()
            .botName(exampleChannelsRegistration.name())
            .location(exampleChannelsRegistration.location())
            .resourceGroupName(example.name())
            .emailAddress("example.com")
            .emailPassword("123456")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleChannelsRegistration:
    type: azure:bot:ChannelsRegistration
    name: example
    properties:
      name: example
      location: global
      resourceGroupName: ${example.name}
      sku: F0
      microsoftAppId: ${current.clientId}
  exampleChannelEmail:
    type: azure:bot:ChannelEmail
    name: example
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${example.name}
      emailAddress: example.com
      emailPassword: '123456'
variables:
  current:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

    Create ChannelEmail Resource

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

    Constructor syntax

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

@overload
def ChannelEmail(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bot_name: Optional[str] = None,
                 email_address: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 email_password: Optional[str] = None,
                 location: Optional[str] = None,
                 magic_code: Optional[str] = None)
    func NewChannelEmail(ctx *Context, name string, args ChannelEmailArgs, opts ...ResourceOption) (*ChannelEmail, error)
    public ChannelEmail(string name, ChannelEmailArgs args, CustomResourceOptions? opts = null)
    public ChannelEmail(String name, ChannelEmailArgs args)
public ChannelEmail(String name, ChannelEmailArgs args, CustomResourceOptions options)

    type: azure:bot:ChannelEmail
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 ChannelEmailArgs
    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 ChannelEmailArgs
    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 ChannelEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelEmailArgs
    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 channelEmailResource = new Azure.Bot.ChannelEmail("channelEmailResource", new()
{
    BotName = "string",
    EmailAddress = "string",
    ResourceGroupName = "string",
    EmailPassword = "string",
    Location = "string",
    MagicCode = "string",
});

    example, err := bot.NewChannelEmail(ctx, "channelEmailResource", &bot.ChannelEmailArgs{
	BotName:           pulumi.String("string"),
	EmailAddress:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	EmailPassword:     pulumi.String("string"),
	Location:          pulumi.String("string"),
	MagicCode:         pulumi.String("string"),
})

    var channelEmailResource = new ChannelEmail("channelEmailResource", ChannelEmailArgs.builder()
    .botName("string")
    .emailAddress("string")
    .resourceGroupName("string")
    .emailPassword("string")
    .location("string")
    .magicCode("string")
    .build());

    channel_email_resource = azure.bot.ChannelEmail("channelEmailResource",
    bot_name="string",
    email_address="string",
    resource_group_name="string",
    email_password="string",
    location="string",
    magic_code="string")

    const channelEmailResource = new azure.bot.ChannelEmail("channelEmailResource", {
    botName: "string",
    emailAddress: "string",
    resourceGroupName: "string",
    emailPassword: "string",
    location: "string",
    magicCode: "string",
});

    type: azure:bot:ChannelEmail
properties:
    botName: string
    emailAddress: string
    emailPassword: string
    location: string
    magicCode: string
    resourceGroupName: string

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

    BotName string
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    EmailAddress string
    The email address that the Bot will authenticate with.
    ResourceGroupName string
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    EmailPassword string
    The email password that the Bot will authenticate with.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MagicCode string
    The magic code used to set up OAUTH authentication.
    BotName string
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    EmailAddress string
    The email address that the Bot will authenticate with.
    ResourceGroupName string
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    EmailPassword string
    The email password that the Bot will authenticate with.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MagicCode string
    The magic code used to set up OAUTH authentication.
    botName String
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    emailAddress String
    The email address that the Bot will authenticate with.
    resourceGroupName String
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    emailPassword String
    The email password that the Bot will authenticate with.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magicCode String
    The magic code used to set up OAUTH authentication.
    botName string
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    emailAddress string
    The email address that the Bot will authenticate with.
    resourceGroupName string
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    emailPassword string
    The email password that the Bot will authenticate with.
    location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magicCode string
    The magic code used to set up OAUTH authentication.
    bot_name str
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    email_address str
    The email address that the Bot will authenticate with.
    resource_group_name str
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    email_password str
    The email password that the Bot will authenticate with.
    location str
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magic_code str
    The magic code used to set up OAUTH authentication.
    botName String
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    emailAddress String
    The email address that the Bot will authenticate with.
    resourceGroupName String
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    emailPassword String
    The email password that the Bot will authenticate with.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magicCode String
    The magic code used to set up OAUTH authentication.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ChannelEmail 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 ChannelEmail Resource

    Get an existing ChannelEmail 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?: ChannelEmailState, opts?: CustomResourceOptions): ChannelEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bot_name: Optional[str] = None,
        email_address: Optional[str] = None,
        email_password: Optional[str] = None,
        location: Optional[str] = None,
        magic_code: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> ChannelEmail
    func GetChannelEmail(ctx *Context, name string, id IDInput, state *ChannelEmailState, opts ...ResourceOption) (*ChannelEmail, error)
    public static ChannelEmail Get(string name, Input<string> id, ChannelEmailState? state, CustomResourceOptions? opts = null)
    public static ChannelEmail get(String name, Output<String> id, ChannelEmailState 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:
    BotName string
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    EmailAddress string
    The email address that the Bot will authenticate with.
    EmailPassword string
    The email password that the Bot will authenticate with.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MagicCode string
    The magic code used to set up OAUTH authentication.
    ResourceGroupName string
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    BotName string
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    EmailAddress string
    The email address that the Bot will authenticate with.
    EmailPassword string
    The email password that the Bot will authenticate with.
    Location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MagicCode string
    The magic code used to set up OAUTH authentication.
    ResourceGroupName string
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    botName String
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    emailAddress String
    The email address that the Bot will authenticate with.
    emailPassword String
    The email password that the Bot will authenticate with.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magicCode String
    The magic code used to set up OAUTH authentication.
    resourceGroupName String
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    botName string
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    emailAddress string
    The email address that the Bot will authenticate with.
    emailPassword string
    The email password that the Bot will authenticate with.
    location string
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magicCode string
    The magic code used to set up OAUTH authentication.
    resourceGroupName string
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    bot_name str
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    email_address str
    The email address that the Bot will authenticate with.
    email_password str
    The email password that the Bot will authenticate with.
    location str
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magic_code str
    The magic code used to set up OAUTH authentication.
    resource_group_name str
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.
    botName String
    The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
    emailAddress String
    The email address that the Bot will authenticate with.
    emailPassword String
    The email password that the Bot will authenticate with.
    location String
    The supported Azure location where the resource exists. Changing this forces a new resource to be created.
    magicCode String
    The magic code used to set up OAUTH authentication.
    resourceGroupName String
    The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

    Import

    The Email Integration for a Bot Channel can be imported using the resource id, e.g.

    $ pulumi import azure:bot/channelEmail:ChannelEmail example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example/channels/EmailChannel

    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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure