Connection

Manages a Bot Connection.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "northeurope",
        });
        var exampleChannelsRegistration = new Azure.Bot.ChannelsRegistration("exampleChannelsRegistration", new Azure.Bot.ChannelsRegistrationArgs
        {
            Location = "global",
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "F0",
            MicrosoftAppId = current.Apply(current => current.ClientId),
        });
        var exampleConnection = new Azure.Bot.Connection("exampleConnection", new Azure.Bot.ConnectionArgs
        {
            BotName = exampleChannelsRegistration.Name,
            Location = exampleChannelsRegistration.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            ServiceProviderName = "box",
            ClientId = "exampleId",
            ClientSecret = "exampleSecret",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/bot"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/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("northeurope"),
        })
        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
    })
}

import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
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: "northeurope"});
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",
});

Create a Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

def Connection(resource_name, opts=None, bot_name=None, client_id=None, client_secret=None, location=None, name=None, parameters=None, resource_group_name=None, scopes=None, service_provider_name=None, tags=None, __props__=None);

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Connection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.

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.

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.

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 Dict[str, str]: A map of additional parameters to apply to the connection.
scopes str: The Scopes at which the connection should be applied.
tags Dict[str, str]: A mapping of tags to assign to the resource.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, bot_name=None, client_id=None, client_secret=None, location=None, name=None, parameters=None, resource_group_name=None, scopes=None, service_provider_name=None, tags=None, __props__=None);

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)

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.

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.

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.

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.

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 Dict[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 Dict[str, str]: A mapping of tags to assign to the resource.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud