Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.15.0 published on Wednesday, Aug 17, 2022 by Pulumi

ChannelEmail

Manages a Email integration for a Bot Channel

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

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

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

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/bot"
	"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 {
		current, err := core.GetClientConfig(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleChannelsRegistration, err := bot.NewChannelsRegistration(ctx, "exampleChannelsRegistration", &bot.ChannelsRegistrationArgs{
			Location:          pulumi.String("global"),
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("F0"),
			MicrosoftAppId:    pulumi.String(current.ClientId),
		})
		if err != nil {
			return err
		}
		_, err = bot.NewChannelEmail(ctx, "exampleChannelEmail", &bot.ChannelEmailArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			EmailAddress:      pulumi.String("example.com"),
			EmailPassword:     pulumi.String("123456"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

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

    }
}
import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_channels_registration = azure.bot.ChannelsRegistration("exampleChannelsRegistration",
    location="global",
    resource_group_name=example_resource_group.name,
    sku="F0",
    microsoft_app_id=current.client_id)
example_channel_email = azure.bot.ChannelEmail("exampleChannelEmail",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example_resource_group.name,
    email_address="example.com",
    email_password="123456")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

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

Create a ChannelEmail Resource

new ChannelEmail(name: string, args: ChannelEmailArgs, opts?: CustomResourceOptions);
@overload
def ChannelEmail(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 bot_name: Optional[str] = None,
                 email_address: Optional[str] = None,
                 email_password: Optional[str] = None,
                 location: Optional[str] = None,
                 resource_group_name: Optional[str] = None)
@overload
def ChannelEmail(resource_name: str,
                 args: ChannelEmailArgs,
                 opts: Optional[ResourceOptions] = 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.

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.

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

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.

EmailPassword string

The email password 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.

Location string

The supported Azure location where the resource exists. 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.

ResourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

Location string

The supported Azure location where the resource exists. 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.

resourceGroupName String

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

location String

The supported Azure location where the resource exists. 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.

resourceGroupName string

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

location string

The supported Azure location where the resource exists. 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.

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.

location str

The supported Azure location where the resource exists. 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.

resourceGroupName String

The name of the resource group in which to create the Bot Channel. Changing this forces a new resource to be created.

location String

The supported Azure location where the resource exists. Changing this forces a new resource to be created.

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 an 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,
        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.

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.

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.

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.

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.

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.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.