1. Packages
  2. Azure Classic
  3. API Docs
  4. bot
  5. ChannelDirectLineSpeech

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.bot.ChannelDirectLineSpeech

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a Direct Line Speech 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 exampleAccount = new azure.cognitive.Account("example", {
        name: "example-cogacct",
        location: example.location,
        resourceGroupName: example.name,
        kind: "SpeechServices",
        skuName: "S0",
    });
    const exampleChannelsRegistration = new azure.bot.ChannelsRegistration("example", {
        name: "example-bcr",
        location: "global",
        resourceGroupName: example.name,
        sku: "F0",
        microsoftAppId: current.then(current => current.clientId),
    });
    const exampleChannelDirectLineSpeech = new azure.bot.ChannelDirectLineSpeech("example", {
        botName: exampleChannelsRegistration.name,
        location: exampleChannelsRegistration.location,
        resourceGroupName: example.name,
        cognitiveServiceLocation: exampleAccount.location,
        cognitiveServiceAccessKey: exampleAccount.primaryAccessKey,
    });
    
    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_account = azure.cognitive.Account("example",
        name="example-cogacct",
        location=example.location,
        resource_group_name=example.name,
        kind="SpeechServices",
        sku_name="S0")
    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_direct_line_speech = azure.bot.ChannelDirectLineSpeech("example",
        bot_name=example_channels_registration.name,
        location=example_channels_registration.location,
        resource_group_name=example.name,
        cognitive_service_location=example_account.location,
        cognitive_service_access_key=example_account.primary_access_key)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/bot"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cognitive"
    	"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
    		}
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := cognitive.NewAccount(ctx, "example", &cognitive.AccountArgs{
    			Name:              pulumi.String("example-cogacct"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			Kind:              pulumi.String("SpeechServices"),
    			SkuName:           pulumi.String("S0"),
    		})
    		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.NewChannelDirectLineSpeech(ctx, "example", &bot.ChannelDirectLineSpeechArgs{
    			BotName:                   exampleChannelsRegistration.Name,
    			Location:                  exampleChannelsRegistration.Location,
    			ResourceGroupName:         example.Name,
    			CognitiveServiceLocation:  exampleAccount.Location,
    			CognitiveServiceAccessKey: exampleAccount.PrimaryAccessKey,
    		})
    		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 exampleAccount = new Azure.Cognitive.Account("example", new()
        {
            Name = "example-cogacct",
            Location = example.Location,
            ResourceGroupName = example.Name,
            Kind = "SpeechServices",
            SkuName = "S0",
        });
    
        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 exampleChannelDirectLineSpeech = new Azure.Bot.ChannelDirectLineSpeech("example", new()
        {
            BotName = exampleChannelsRegistration.Name,
            Location = exampleChannelsRegistration.Location,
            ResourceGroupName = example.Name,
            CognitiveServiceLocation = exampleAccount.Location,
            CognitiveServiceAccessKey = exampleAccount.PrimaryAccessKey,
        });
    
    });
    
    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.cognitive.Account;
    import com.pulumi.azure.cognitive.AccountArgs;
    import com.pulumi.azure.bot.ChannelsRegistration;
    import com.pulumi.azure.bot.ChannelsRegistrationArgs;
    import com.pulumi.azure.bot.ChannelDirectLineSpeech;
    import com.pulumi.azure.bot.ChannelDirectLineSpeechArgs;
    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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
                .name("example-cogacct")
                .location(example.location())
                .resourceGroupName(example.name())
                .kind("SpeechServices")
                .skuName("S0")
                .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 exampleChannelDirectLineSpeech = new ChannelDirectLineSpeech("exampleChannelDirectLineSpeech", ChannelDirectLineSpeechArgs.builder()        
                .botName(exampleChannelsRegistration.name())
                .location(exampleChannelsRegistration.location())
                .resourceGroupName(example.name())
                .cognitiveServiceLocation(exampleAccount.location())
                .cognitiveServiceAccessKey(exampleAccount.primaryAccessKey())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:cognitive:Account
        name: example
        properties:
          name: example-cogacct
          location: ${example.location}
          resourceGroupName: ${example.name}
          kind: SpeechServices
          skuName: S0
      exampleChannelsRegistration:
        type: azure:bot:ChannelsRegistration
        name: example
        properties:
          name: example-bcr
          location: global
          resourceGroupName: ${example.name}
          sku: F0
          microsoftAppId: ${current.clientId}
      exampleChannelDirectLineSpeech:
        type: azure:bot:ChannelDirectLineSpeech
        name: example
        properties:
          botName: ${exampleChannelsRegistration.name}
          location: ${exampleChannelsRegistration.location}
          resourceGroupName: ${example.name}
          cognitiveServiceLocation: ${exampleAccount.location}
          cognitiveServiceAccessKey: ${exampleAccount.primaryAccessKey}
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create ChannelDirectLineSpeech Resource

    new ChannelDirectLineSpeech(name: string, args: ChannelDirectLineSpeechArgs, opts?: CustomResourceOptions);
    @overload
    def ChannelDirectLineSpeech(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                bot_name: Optional[str] = None,
                                cognitive_account_id: Optional[str] = None,
                                cognitive_service_access_key: Optional[str] = None,
                                cognitive_service_location: Optional[str] = None,
                                custom_speech_model_id: Optional[str] = None,
                                custom_voice_deployment_id: Optional[str] = None,
                                location: Optional[str] = None,
                                resource_group_name: Optional[str] = None)
    @overload
    def ChannelDirectLineSpeech(resource_name: str,
                                args: ChannelDirectLineSpeechArgs,
                                opts: Optional[ResourceOptions] = None)
    func NewChannelDirectLineSpeech(ctx *Context, name string, args ChannelDirectLineSpeechArgs, opts ...ResourceOption) (*ChannelDirectLineSpeech, error)
    public ChannelDirectLineSpeech(string name, ChannelDirectLineSpeechArgs args, CustomResourceOptions? opts = null)
    public ChannelDirectLineSpeech(String name, ChannelDirectLineSpeechArgs args)
    public ChannelDirectLineSpeech(String name, ChannelDirectLineSpeechArgs args, CustomResourceOptions options)
    
    type: azure:bot:ChannelDirectLineSpeech
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ChannelDirectLineSpeechArgs
    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 ChannelDirectLineSpeechArgs
    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 ChannelDirectLineSpeechArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelDirectLineSpeechArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelDirectLineSpeechArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ChannelDirectLineSpeech 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 ChannelDirectLineSpeech 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.
    CognitiveServiceAccessKey string
    The access key to access the Cognitive Service.
    CognitiveServiceLocation string
    Specifies the supported Azure location where the Cognitive Service resource exists.
    ResourceGroupName string
    The name of the resource group where the Direct Line Speech Channel should be created. Changing this forces a new resource to be created.
    CognitiveAccountId string
    The ID of the Cognitive Account this Bot Channel should be associated with.
    CustomSpeechModelId string
    The custom speech model id for the Direct Line Speech Channel.
    CustomVoiceDeploymentId string
    The custom voice deployment id for the Direct Line Speech Channel.
    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.
    CognitiveServiceAccessKey string
    The access key to access the Cognitive Service.
    CognitiveServiceLocation string
    Specifies the supported Azure location where the Cognitive Service resource exists.
    ResourceGroupName string
    The name of the resource group where the Direct Line Speech Channel should be created. Changing this forces a new resource to be created.
    CognitiveAccountId string
    The ID of the Cognitive Account this Bot Channel should be associated with.
    CustomSpeechModelId string
    The custom speech model id for the Direct Line Speech Channel.
    CustomVoiceDeploymentId string
    The custom voice deployment id for the Direct Line Speech Channel.
    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.
    cognitiveServiceAccessKey String
    The access key to access the Cognitive Service.
    cognitiveServiceLocation String
    Specifies the supported Azure location where the Cognitive Service resource exists.
    resourceGroupName String
    The name of the resource group where the Direct Line Speech Channel should be created. Changing this forces a new resource to be created.
    cognitiveAccountId String
    The ID of the Cognitive Account this Bot Channel should be associated with.
    customSpeechModelId String
    The custom speech model id for the Direct Line Speech Channel.
    customVoiceDeploymentId String
    The custom voice deployment id for the Direct Line Speech Channel.
    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.
    cognitiveServiceAccessKey string
    The access key to access the Cognitive Service.
    cognitiveServiceLocation string
    Specifies the supported Azure location where the Cognitive Service resource exists.
    resourceGroupName string
    The name of the resource group where the Direct Line Speech Channel should be created. Changing this forces a new resource to be created.
    cognitiveAccountId string
    The ID of the Cognitive Account this Bot Channel should be associated with.
    customSpeechModelId string
    The custom speech model id for the Direct Line Speech Channel.
    customVoiceDeploymentId string
    The custom voice deployment id for the Direct Line Speech Channel.
    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.
    cognitive_service_access_key str
    The access key to access the Cognitive Service.
    cognitive_service_location str
    Specifies the supported Azure location where the Cognitive Service resource exists.
    resource_group_name str
    The name of the resource group where the Direct Line Speech Channel should be created. Changing this forces a new resource to be created.
    cognitive_account_id str
    The ID of the Cognitive Account this Bot Channel should be associated with.
    custom_speech_model_id str
    The custom speech model id for the Direct Line Speech Channel.
    custom_voice_deployment_id str
    The custom voice deployment id for the Direct Line Speech Channel.
    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.
    cognitiveServiceAccessKey String
    The access key to access the Cognitive Service.
    cognitiveServiceLocation String
    Specifies the supported Azure location where the Cognitive Service resource exists.
    resourceGroupName String
    The name of the resource group where the Direct Line Speech Channel should be created. Changing this forces a new resource to be created.
    cognitiveAccountId String
    The ID of the Cognitive Account this Bot Channel should be associated with.
    customSpeechModelId String
    The custom speech model id for the Direct Line Speech Channel.
    customVoiceDeploymentId String
    The custom voice deployment id for the Direct Line Speech Channel.
    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 ChannelDirectLineSpeech 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 ChannelDirectLineSpeech Resource

    Get an existing ChannelDirectLineSpeech 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?: ChannelDirectLineSpeechState, opts?: CustomResourceOptions): ChannelDirectLineSpeech
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bot_name: Optional[str] = None,
            cognitive_account_id: Optional[str] = None,
            cognitive_service_access_key: Optional[str] = None,
            cognitive_service_location: Optional[str] = None,
            custom_speech_model_id: Optional[str] = None,
            custom_voice_deployment_id: Optional[str] = None,
            location: Optional[str] = None,
            resource_group_name: Optional[str] = None) -> ChannelDirectLineSpeech
    func GetChannelDirectLineSpeech(ctx *Context, name string, id IDInput, state *ChannelDirectLineSpeechState, opts ...ResourceOption) (*ChannelDirectLineSpeech, error)
    public static ChannelDirectLineSpeech Get(string name, Input<string> id, ChannelDirectLineSpeechState? state, CustomResourceOptions? opts = null)
    public static ChannelDirectLineSpeech get(String name, Output<String> id, ChannelDirectLineSpeechState 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.
    CognitiveAccountId string
    The ID of the Cognitive Account this Bot Channel should be associated with.
    CognitiveServiceAccessKey string
    The access key to access the Cognitive Service.
    CognitiveServiceLocation string
    Specifies the supported Azure location where the Cognitive Service resource exists.
    CustomSpeechModelId string
    The custom speech model id for the Direct Line Speech Channel.
    CustomVoiceDeploymentId string
    The custom voice deployment id for the Direct Line Speech Channel.
    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 Direct Line Speech Channel should be created. 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.
    CognitiveAccountId string
    The ID of the Cognitive Account this Bot Channel should be associated with.
    CognitiveServiceAccessKey string
    The access key to access the Cognitive Service.
    CognitiveServiceLocation string
    Specifies the supported Azure location where the Cognitive Service resource exists.
    CustomSpeechModelId string
    The custom speech model id for the Direct Line Speech Channel.
    CustomVoiceDeploymentId string
    The custom voice deployment id for the Direct Line Speech Channel.
    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 Direct Line Speech Channel should be created. 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.
    cognitiveAccountId String
    The ID of the Cognitive Account this Bot Channel should be associated with.
    cognitiveServiceAccessKey String
    The access key to access the Cognitive Service.
    cognitiveServiceLocation String
    Specifies the supported Azure location where the Cognitive Service resource exists.
    customSpeechModelId String
    The custom speech model id for the Direct Line Speech Channel.
    customVoiceDeploymentId String
    The custom voice deployment id for the Direct Line Speech Channel.
    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 Direct Line Speech Channel should be created. 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.
    cognitiveAccountId string
    The ID of the Cognitive Account this Bot Channel should be associated with.
    cognitiveServiceAccessKey string
    The access key to access the Cognitive Service.
    cognitiveServiceLocation string
    Specifies the supported Azure location where the Cognitive Service resource exists.
    customSpeechModelId string
    The custom speech model id for the Direct Line Speech Channel.
    customVoiceDeploymentId string
    The custom voice deployment id for the Direct Line Speech Channel.
    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 Direct Line Speech Channel should be created. 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.
    cognitive_account_id str
    The ID of the Cognitive Account this Bot Channel should be associated with.
    cognitive_service_access_key str
    The access key to access the Cognitive Service.
    cognitive_service_location str
    Specifies the supported Azure location where the Cognitive Service resource exists.
    custom_speech_model_id str
    The custom speech model id for the Direct Line Speech Channel.
    custom_voice_deployment_id str
    The custom voice deployment id for the Direct Line Speech Channel.
    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 Direct Line Speech Channel should be created. 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.
    cognitiveAccountId String
    The ID of the Cognitive Account this Bot Channel should be associated with.
    cognitiveServiceAccessKey String
    The access key to access the Cognitive Service.
    cognitiveServiceLocation String
    Specifies the supported Azure location where the Cognitive Service resource exists.
    customSpeechModelId String
    The custom speech model id for the Direct Line Speech Channel.
    customVoiceDeploymentId String
    The custom voice deployment id for the Direct Line Speech Channel.
    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 Direct Line Speech Channel should be created. Changing this forces a new resource to be created.

    Import

    Direct Line Speech Channels can be imported using the resource id, e.g.

    $ pulumi import azure:bot/channelDirectLineSpeech:ChannelDirectLineSpeech example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.BotService/botServices/botService1/channels/DirectLineSpeechChannel
    

    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 Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi