Azure Classic v5.38.0, Mar 21 23

azure.bot.ChannelWebChat

Manages a Web Chat integration for a Bot Channel

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 exampleChannelWebChat = new Azure.Bot.ChannelWebChat("exampleChannelWebChat", new()
    {
        BotName = exampleChannelsRegistration.Name,
        Location = exampleChannelsRegistration.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        SiteNames = new[]
        {
            "TestSite",
        },
    });

});

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.NewChannelWebChat(ctx, "exampleChannelWebChat", &bot.ChannelWebChatArgs{
			BotName:           exampleChannelsRegistration.Name,
			Location:          exampleChannelsRegistration.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			SiteNames: pulumi.StringArray{
				pulumi.String("TestSite"),
			},
		})
		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.ChannelWebChat;
import com.pulumi.azure.bot.ChannelWebChatArgs;
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 exampleChannelWebChat = new ChannelWebChat("exampleChannelWebChat", ChannelWebChatArgs.builder()        
            .botName(exampleChannelsRegistration.name())
            .location(exampleChannelsRegistration.location())
            .resourceGroupName(exampleResourceGroup.name())
            .siteNames("TestSite")
            .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_web_chat = azure.bot.ChannelWebChat("exampleChannelWebChat",
    bot_name=example_channels_registration.name,
    location=example_channels_registration.location,
    resource_group_name=example_resource_group.name,
    site_names=["TestSite"])

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 exampleChannelWebChat = new azure.bot.ChannelWebChat("exampleChannelWebChat", {
    botName: exampleChannelsRegistration.name,
    location: exampleChannelsRegistration.location,
    resourceGroupName: exampleResourceGroup.name,
    siteNames: ["TestSite"],
});

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}
  exampleChannelWebChat:
    type: azure:bot:ChannelWebChat
    properties:
      botName: ${exampleChannelsRegistration.name}
      location: ${exampleChannelsRegistration.location}
      resourceGroupName: ${exampleResourceGroup.name}
      siteNames:
        - TestSite
variables:
  current:
    fn::invoke:
      Function: azure:core:getClientConfig
      Arguments: {}

Create ChannelWebChat Resource

new ChannelWebChat(name: string, args: ChannelWebChatArgs, opts?: CustomResourceOptions);

@overload
def ChannelWebChat(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   bot_name: Optional[str] = None,
                   location: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   site_names: Optional[Sequence[str]] = None)
@overload
def ChannelWebChat(resource_name: str,
                   args: ChannelWebChatArgs,
                   opts: Optional[ResourceOptions] = None)

func NewChannelWebChat(ctx *Context, name string, args ChannelWebChatArgs, opts ...ResourceOption) (*ChannelWebChat, error)

public ChannelWebChat(string name, ChannelWebChatArgs args, CustomResourceOptions? opts = null)

public ChannelWebChat(String name, ChannelWebChatArgs args)
public ChannelWebChat(String name, ChannelWebChatArgs args, CustomResourceOptions options)

type: azure:bot:ChannelWebChat
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args ChannelWebChatArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ChannelWebChatArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ChannelWebChat 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 ChannelWebChat 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.
ResourceGroupName string: The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.
SiteNames List<string>: A list of Web Chat Site names.
Location string: Specifies 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.
ResourceGroupName string: The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.
SiteNames []string: A list of Web Chat Site names.
Location string: Specifies 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.
resourceGroupName String: The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.
siteNames List<String>: A list of Web Chat Site names.
location String: Specifies 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.
resourceGroupName string: The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.
siteNames string[]: A list of Web Chat Site names.
location string: Specifies 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.
resource_group_name str: The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.
site_names Sequence[str]: A list of Web Chat Site names.
location str: Specifies 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.
resourceGroupName String: The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.
siteNames List<String>: A list of Web Chat Site names.
location String: Specifies 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 ChannelWebChat 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 ChannelWebChat Resource

Get an existing ChannelWebChat 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?: ChannelWebChatState, opts?: CustomResourceOptions): ChannelWebChat

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bot_name: Optional[str] = None,
        location: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        site_names: Optional[Sequence[str]] = None) -> ChannelWebChat

func GetChannelWebChat(ctx *Context, name string, id IDInput, state *ChannelWebChatState, opts ...ResourceOption) (*ChannelWebChat, error)

public static ChannelWebChat Get(string name, Input<string> id, ChannelWebChatState? state, CustomResourceOptions? opts = null)

public static ChannelWebChat get(String name, Output<String> id, ChannelWebChatState 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.
Location string: Specifies 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 where the Web Chat Channel should be created. Changing this forces a new resource to be created.
SiteNames List<string>: A list of Web Chat Site names.

BotName string: The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
Location string: Specifies 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 where the Web Chat Channel should be created. Changing this forces a new resource to be created.
SiteNames []string: A list of Web Chat Site names.

botName String: The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location String: Specifies 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 where the Web Chat Channel should be created. Changing this forces a new resource to be created.
siteNames List<String>: A list of Web Chat Site names.

botName string: The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location string: Specifies 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 where the Web Chat Channel should be created. Changing this forces a new resource to be created.
siteNames string[]: A list of Web Chat Site names.

bot_name str: The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location str: Specifies 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 where the Web Chat Channel should be created. Changing this forces a new resource to be created.
site_names Sequence[str]: A list of Web Chat Site names.

botName String: The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
location String: Specifies 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 where the Web Chat Channel should be created. Changing this forces a new resource to be created.
siteNames List<String>: A list of Web Chat Site names.

Import

Web Chat Channels can be imported using the resource id, e.g.

 $ pulumi import azure:bot/channelWebChat:ChannelWebChat example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.BotService/botServices/botService1/channels/WebChatChannel

Package Details

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