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

We recommend using Azure Native.

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

azure.bot.ChannelWebChat

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 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",
    }])

    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
	})
}

    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 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: {}

    Create ChannelWebChat Resource

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

    Constructor syntax

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

@overload
def ChannelWebChat(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   bot_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   location: Optional[str] = None,
                   sites: Optional[Sequence[ChannelWebChatSiteArgs]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var channelWebChatResource = new Azure.Bot.ChannelWebChat("channelWebChatResource", new()
{
    BotName = "string",
    ResourceGroupName = "string",
    Location = "string",
    Sites = new[]
    {
        new Azure.Bot.Inputs.ChannelWebChatSiteArgs
        {
            Name = "string",
            EndpointParametersEnabled = false,
            StorageEnabled = false,
            UserUploadEnabled = false,
        },
    },
});

    example, err := bot.NewChannelWebChat(ctx, "channelWebChatResource", &bot.ChannelWebChatArgs{
	BotName:           pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Sites: bot.ChannelWebChatSiteArray{
		&bot.ChannelWebChatSiteArgs{
			Name:                      pulumi.String("string"),
			EndpointParametersEnabled: pulumi.Bool(false),
			StorageEnabled:            pulumi.Bool(false),
			UserUploadEnabled:         pulumi.Bool(false),
		},
	},
})

    var channelWebChatResource = new ChannelWebChat("channelWebChatResource", ChannelWebChatArgs.builder()
    .botName("string")
    .resourceGroupName("string")
    .location("string")
    .sites(ChannelWebChatSiteArgs.builder()
        .name("string")
        .endpointParametersEnabled(false)
        .storageEnabled(false)
        .userUploadEnabled(false)
        .build())
    .build());

    channel_web_chat_resource = azure.bot.ChannelWebChat("channelWebChatResource",
    bot_name="string",
    resource_group_name="string",
    location="string",
    sites=[{
        "name": "string",
        "endpoint_parameters_enabled": False,
        "storage_enabled": False,
        "user_upload_enabled": False,
    }])

    const channelWebChatResource = new azure.bot.ChannelWebChat("channelWebChatResource", {
    botName: "string",
    resourceGroupName: "string",
    location: "string",
    sites: [{
        name: "string",
        endpointParametersEnabled: false,
        storageEnabled: false,
        userUploadEnabled: false,
    }],
});

    type: azure:bot:ChannelWebChat
properties:
    botName: string
    location: string
    resourceGroupName: string
    sites:
        - endpointParametersEnabled: false
          name: string
          storageEnabled: false
          userUploadEnabled: false

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Sites List<ChannelWebChatSite>
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Sites []ChannelWebChatSiteArgs
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    sites List<ChannelWebChatSite>
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    sites ChannelWebChatSite[]
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    sites Sequence[ChannelWebChatSiteArgs]
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    sites List<Property Map>
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.

    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,
        sites: Optional[Sequence[ChannelWebChatSiteArgs]] = 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.
    Sites List<ChannelWebChatSite>
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    Sites []ChannelWebChatSiteArgs
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    sites List<ChannelWebChatSite>
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    sites ChannelWebChatSite[]
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    sites Sequence[ChannelWebChatSiteArgs]
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.
    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.
    sites List<Property Map>
    A site represents a client application that you want to connect to your bot. One or more site blocks as defined below.

    Supporting Types

    ChannelWebChatSite, ChannelWebChatSiteArgs

    Name string
    The name of the site.
    EndpointParametersEnabled bool
    Is the endpoint parameters enabled for this site?
    StorageEnabled bool
    Is the storage site enabled for detailed logging? Defaults to true.
    UserUploadEnabled bool
    Is the user upload enabled for this site? Defaults to true.
    Name string
    The name of the site.
    EndpointParametersEnabled bool
    Is the endpoint parameters enabled for this site?
    StorageEnabled bool
    Is the storage site enabled for detailed logging? Defaults to true.
    UserUploadEnabled bool
    Is the user upload enabled for this site? Defaults to true.
    name String
    The name of the site.
    endpointParametersEnabled Boolean
    Is the endpoint parameters enabled for this site?
    storageEnabled Boolean
    Is the storage site enabled for detailed logging? Defaults to true.
    userUploadEnabled Boolean
    Is the user upload enabled for this site? Defaults to true.
    name string
    The name of the site.
    endpointParametersEnabled boolean
    Is the endpoint parameters enabled for this site?
    storageEnabled boolean
    Is the storage site enabled for detailed logging? Defaults to true.
    userUploadEnabled boolean
    Is the user upload enabled for this site? Defaults to true.
    name str
    The name of the site.
    endpoint_parameters_enabled bool
    Is the endpoint parameters enabled for this site?
    storage_enabled bool
    Is the storage site enabled for detailed logging? Defaults to true.
    user_upload_enabled bool
    Is the user upload enabled for this site? Defaults to true.
    name String
    The name of the site.
    endpointParametersEnabled Boolean
    Is the endpoint parameters enabled for this site?
    storageEnabled Boolean
    Is the storage site enabled for detailed logging? Defaults to true.
    userUploadEnabled Boolean
    Is the user upload enabled for this site? Defaults to true.

    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

    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