ChannelWebChat

class ChannelWebChat : KotlinCustomResource

Manages a Web Chat integration for a Bot Channel

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-bcr",
location: "global",
resourceGroupName: example.name,
sku: "F0",
microsoftAppId: current.then(current => current.clientId),
});
const exampleChannelWebChat = new azure.bot.ChannelWebChat("example", {
botName: exampleChannelsRegistration.name,
location: exampleChannelsRegistration.location,
resourceGroupName: example.name,
sites: [{
name: "TestSite",
}],
});
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-bcr",
location="global",
resource_group_name=example.name,
sku="F0",
microsoft_app_id=current.client_id)
example_channel_web_chat = azure.bot.ChannelWebChat("example",
bot_name=example_channels_registration.name,
location=example_channels_registration.location,
resource_group_name=example.name,
sites=[{
"name": "TestSite",
}])
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-bcr",
Location = "global",
ResourceGroupName = example.Name,
Sku = "F0",
MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
});
var exampleChannelWebChat = new Azure.Bot.ChannelWebChat("example", new()
{
BotName = exampleChannelsRegistration.Name,
Location = exampleChannelsRegistration.Location,
ResourceGroupName = example.Name,
Sites = new[]
{
new Azure.Bot.Inputs.ChannelWebChatSiteArgs
{
Name = "TestSite",
},
},
});
});
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-bcr"),
Location: pulumi.String("global"),
ResourceGroupName: example.Name,
Sku: pulumi.String("F0"),
MicrosoftAppId: pulumi.String(current.ClientId),
})
if err != nil {
return err
}
_, err = bot.NewChannelWebChat(ctx, "example", &bot.ChannelWebChatArgs{
BotName: exampleChannelsRegistration.Name,
Location: exampleChannelsRegistration.Location,
ResourceGroupName: example.Name,
Sites: bot.ChannelWebChatSiteArray{
&bot.ChannelWebChatSiteArgs{
Name: 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 com.pulumi.azure.bot.inputs.ChannelWebChatSiteArgs;
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-bcr")
.location("global")
.resourceGroupName(example.name())
.sku("F0")
.microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
.build());
var exampleChannelWebChat = new ChannelWebChat("exampleChannelWebChat", ChannelWebChatArgs.builder()
.botName(exampleChannelsRegistration.name())
.location(exampleChannelsRegistration.location())
.resourceGroupName(example.name())
.sites(ChannelWebChatSiteArgs.builder()
.name("TestSite")
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleChannelsRegistration:
type: azure:bot:ChannelsRegistration
name: example
properties:
name: example-bcr
location: global
resourceGroupName: ${example.name}
sku: F0
microsoftAppId: ${current.clientId}
exampleChannelWebChat:
type: azure:bot:ChannelWebChat
name: example
properties:
botName: ${exampleChannelsRegistration.name}
location: ${exampleChannelsRegistration.location}
resourceGroupName: ${example.name}
sites:
- name: TestSite
variables:
current:
fn::invoke:
function: azure:core:getClientConfig
arguments: {}

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

Properties

Link copied to clipboard
val botName: Output<String>

The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The name of the resource group where the Web Chat Channel should be created. Changing this forces a new resource to be created.

Link copied to clipboard

A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.

Link copied to clipboard
val urn: Output<String>