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

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

azure.bot.Connection

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi

    Manages a Bot Connection.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    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 exampleConnection = new Azure.Bot.Connection("exampleConnection", new()
        {
            BotName = exampleChannelsRegistration.Name,
            Location = exampleChannelsRegistration.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            ServiceProviderName = "box",
            ClientId = "exampleId",
            ClientSecret = "exampleSecret",
        });
    
    });
    
    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.NewConnection(ctx, "exampleConnection", &bot.ConnectionArgs{
    			BotName:             exampleChannelsRegistration.Name,
    			Location:            exampleChannelsRegistration.Location,
    			ResourceGroupName:   exampleResourceGroup.Name,
    			ServiceProviderName: pulumi.String("box"),
    			ClientId:            pulumi.String("exampleId"),
    			ClientSecret:        pulumi.String("exampleSecret"),
    		})
    		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.Connection;
    import com.pulumi.azure.bot.ConnectionArgs;
    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 exampleConnection = new Connection("exampleConnection", ConnectionArgs.builder()        
                .botName(exampleChannelsRegistration.name())
                .location(exampleChannelsRegistration.location())
                .resourceGroupName(exampleResourceGroup.name())
                .serviceProviderName("box")
                .clientId("exampleId")
                .clientSecret("exampleSecret")
                .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_connection = azure.bot.Connection("exampleConnection",
        bot_name=example_channels_registration.name,
        location=example_channels_registration.location,
        resource_group_name=example_resource_group.name,
        service_provider_name="box",
        client_id="exampleId",
        client_secret="exampleSecret")
    
    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 exampleConnection = new azure.bot.Connection("exampleConnection", {
        botName: exampleChannelsRegistration.name,
        location: exampleChannelsRegistration.location,
        resourceGroupName: exampleResourceGroup.name,
        serviceProviderName: "box",
        clientId: "exampleId",
        clientSecret: "exampleSecret",
    });
    
    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}
      exampleConnection:
        type: azure:bot:Connection
        properties:
          botName: ${exampleChannelsRegistration.name}
          location: ${exampleChannelsRegistration.location}
          resourceGroupName: ${exampleResourceGroup.name}
          serviceProviderName: box
          clientId: exampleId
          clientSecret: exampleSecret
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create Connection Resource

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def Connection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   bot_name: Optional[str] = None,
                   client_id: Optional[str] = None,
                   client_secret: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   parameters: Optional[Mapping[str, str]] = None,
                   resource_group_name: Optional[str] = None,
                   scopes: Optional[str] = None,
                   service_provider_name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    @overload
    def Connection(resource_name: str,
                   args: ConnectionArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
    public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
    
    type: azure:bot:Connection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ConnectionArgs
    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 ConnectionArgs
    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 ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Connection 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 Connection resource accepts the following input properties:

    BotName string

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

    ClientId string

    The Client ID that will be used to authenticate with the service provider.

    ClientSecret string

    The Client Secret that will be used to authenticate with the service provider.

    ResourceGroupName string

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

    ServiceProviderName string

    The name of the service provider that will be associated with this connection. 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.

    Name string

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    Parameters Dictionary<string, string>

    A map of additional parameters to apply to the connection.

    Scopes string

    The Scopes at which the connection should be applied.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    BotName string

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

    ClientId string

    The Client ID that will be used to authenticate with the service provider.

    ClientSecret string

    The Client Secret that will be used to authenticate with the service provider.

    ResourceGroupName string

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

    ServiceProviderName string

    The name of the service provider that will be associated with this connection. 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.

    Name string

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    Parameters map[string]string

    A map of additional parameters to apply to the connection.

    Scopes string

    The Scopes at which the connection should be applied.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    botName String

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

    clientId String

    The Client ID that will be used to authenticate with the service provider.

    clientSecret String

    The Client Secret that will be used to authenticate with the service provider.

    resourceGroupName String

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

    serviceProviderName String

    The name of the service provider that will be associated with this connection. 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.

    name String

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters Map<String,String>

    A map of additional parameters to apply to the connection.

    scopes String

    The Scopes at which the connection should be applied.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    botName string

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

    clientId string

    The Client ID that will be used to authenticate with the service provider.

    clientSecret string

    The Client Secret that will be used to authenticate with the service provider.

    resourceGroupName string

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

    serviceProviderName string

    The name of the service provider that will be associated with this connection. 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.

    name string

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters {[key: string]: string}

    A map of additional parameters to apply to the connection.

    scopes string

    The Scopes at which the connection should be applied.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    bot_name str

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

    client_id str

    The Client ID that will be used to authenticate with the service provider.

    client_secret str

    The Client Secret that will be used to authenticate with the service provider.

    resource_group_name str

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

    service_provider_name str

    The name of the service provider that will be associated with this connection. 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.

    name str

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters Mapping[str, str]

    A map of additional parameters to apply to the connection.

    scopes str

    The Scopes at which the connection should be applied.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    botName String

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

    clientId String

    The Client ID that will be used to authenticate with the service provider.

    clientSecret String

    The Client Secret that will be used to authenticate with the service provider.

    resourceGroupName String

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

    serviceProviderName String

    The name of the service provider that will be associated with this connection. 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.

    name String

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters Map<String>

    A map of additional parameters to apply to the connection.

    scopes String

    The Scopes at which the connection should be applied.

    tags Map<String>

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Connection 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 Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bot_name: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            resource_group_name: Optional[str] = None,
            scopes: Optional[str] = None,
            service_provider_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState 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 connection will be associated with. Changing this forces a new resource to be created.

    ClientId string

    The Client ID that will be used to authenticate with the service provider.

    ClientSecret string

    The Client Secret that will be used to authenticate with the service provider.

    Location string

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

    Name string

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    Parameters Dictionary<string, string>

    A map of additional parameters to apply to the connection.

    ResourceGroupName string

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

    Scopes string

    The Scopes at which the connection should be applied.

    ServiceProviderName string

    The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    BotName string

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

    ClientId string

    The Client ID that will be used to authenticate with the service provider.

    ClientSecret string

    The Client Secret that will be used to authenticate with the service provider.

    Location string

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

    Name string

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    Parameters map[string]string

    A map of additional parameters to apply to the connection.

    ResourceGroupName string

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

    Scopes string

    The Scopes at which the connection should be applied.

    ServiceProviderName string

    The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    botName String

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

    clientId String

    The Client ID that will be used to authenticate with the service provider.

    clientSecret String

    The Client Secret that will be used to authenticate with the service provider.

    location String

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

    name String

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters Map<String,String>

    A map of additional parameters to apply to the connection.

    resourceGroupName String

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

    scopes String

    The Scopes at which the connection should be applied.

    serviceProviderName String

    The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    botName string

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

    clientId string

    The Client ID that will be used to authenticate with the service provider.

    clientSecret string

    The Client Secret that will be used to authenticate with the service provider.

    location string

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

    name string

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters {[key: string]: string}

    A map of additional parameters to apply to the connection.

    resourceGroupName string

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

    scopes string

    The Scopes at which the connection should be applied.

    serviceProviderName string

    The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    bot_name str

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

    client_id str

    The Client ID that will be used to authenticate with the service provider.

    client_secret str

    The Client Secret that will be used to authenticate with the service provider.

    location str

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

    name str

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters Mapping[str, str]

    A map of additional parameters to apply to the connection.

    resource_group_name str

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

    scopes str

    The Scopes at which the connection should be applied.

    service_provider_name str

    The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    botName String

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

    clientId String

    The Client ID that will be used to authenticate with the service provider.

    clientSecret String

    The Client Secret that will be used to authenticate with the service provider.

    location String

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

    name String

    Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.

    parameters Map<String>

    A map of additional parameters to apply to the connection.

    resourceGroupName String

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

    scopes String

    The Scopes at which the connection should be applied.

    serviceProviderName String

    The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.

    tags Map<String>

    A mapping of tags to assign to the resource.

    Deprecated:

    This property has been deprecated as the API no longer supports tags and will be removed in version 4.0 of the provider.

    Import

    Bot Connection can be imported using the resource id, e.g.

     $ pulumi import azure:bot/connection:Connection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example/connections/example
    

    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.43.0 published on Saturday, May 6, 2023 by Pulumi