Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

BotConnection

Bot channel resource definition API Version: 2021-03-01.

Example Usage

Create Connection Setting

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var botConnection = new AzureNative.BotService.BotConnection("botConnection", new AzureNative.BotService.BotConnectionArgs
        {
            ConnectionName = "sampleConnection",
            Location = "West US",
            Properties = new AzureNative.BotService.Inputs.ConnectionSettingPropertiesArgs
            {
                ClientId = "sampleclientid",
                ClientSecret = "samplesecret",
                Parameters = 
                {
                    new AzureNative.BotService.Inputs.ConnectionSettingParameterArgs
                    {
                        Key = "key1",
                        Value = "value1",
                    },
                    new AzureNative.BotService.Inputs.ConnectionSettingParameterArgs
                    {
                        Key = "key2",
                        Value = "value2",
                    },
                },
                Scopes = "samplescope",
                ServiceProviderId = "serviceproviderid",
            },
            ResourceGroupName = "OneResourceGroupName",
            ResourceName = "samplebotname",
        });
    }

}
package main

import (
	botservice "github.com/pulumi/pulumi-azure-native/sdk/go/azure/botservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := botservice.NewBotConnection(ctx, "botConnection", &botservice.BotConnectionArgs{
			ConnectionName: pulumi.String("sampleConnection"),
			Location:       pulumi.String("West US"),
			Properties: &botservice.ConnectionSettingPropertiesArgs{
				ClientId:     pulumi.String("sampleclientid"),
				ClientSecret: pulumi.String("samplesecret"),
				Parameters: botservice.ConnectionSettingParameterArray{
					&botservice.ConnectionSettingParameterArgs{
						Key:   pulumi.String("key1"),
						Value: pulumi.String("value1"),
					},
					&botservice.ConnectionSettingParameterArgs{
						Key:   pulumi.String("key2"),
						Value: pulumi.String("value2"),
					},
				},
				Scopes:            pulumi.String("samplescope"),
				ServiceProviderId: pulumi.String("serviceproviderid"),
			},
			ResourceGroupName: pulumi.String("OneResourceGroupName"),
			ResourceName:      pulumi.String("samplebotname"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var botConnection = new BotConnection("botConnection", BotConnectionArgs.builder()        
            .connectionName("sampleConnection")
            .location("West US")
            .properties(Map.ofEntries(
                Map.entry("clientId", "sampleclientid"),
                Map.entry("clientSecret", "samplesecret"),
                Map.entry("parameters",                 
                    Map.ofEntries(
                        Map.entry("key", "key1"),
                        Map.entry("value", "value1")
                    ),
                    Map.ofEntries(
                        Map.entry("key", "key2"),
                        Map.entry("value", "value2")
                    )),
                Map.entry("scopes", "samplescope"),
                Map.entry("serviceProviderId", "serviceproviderid")
            ))
            .resourceGroupName("OneResourceGroupName")
            .resourceName("samplebotname")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

bot_connection = azure_native.botservice.BotConnection("botConnection",
    connection_name="sampleConnection",
    location="West US",
    properties=azure_native.botservice.ConnectionSettingPropertiesArgs(
        client_id="sampleclientid",
        client_secret="samplesecret",
        parameters=[
            azure_native.botservice.ConnectionSettingParameterArgs(
                key="key1",
                value="value1",
            ),
            azure_native.botservice.ConnectionSettingParameterArgs(
                key="key2",
                value="value2",
            ),
        ],
        scopes="samplescope",
        service_provider_id="serviceproviderid",
    ),
    resource_group_name="OneResourceGroupName",
    resource_name_="samplebotname")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const botConnection = new azure_native.botservice.BotConnection("botConnection", {
    connectionName: "sampleConnection",
    location: "West US",
    properties: {
        clientId: "sampleclientid",
        clientSecret: "samplesecret",
        parameters: [
            {
                key: "key1",
                value: "value1",
            },
            {
                key: "key2",
                value: "value2",
            },
        ],
        scopes: "samplescope",
        serviceProviderId: "serviceproviderid",
    },
    resourceGroupName: "OneResourceGroupName",
    resourceName: "samplebotname",
});
resources:
  botConnection:
    type: azure-native:botservice:BotConnection
    properties:
      connectionName: sampleConnection
      location: West US
      properties:
        clientId: sampleclientid
        clientSecret: samplesecret
        parameters:
          - key: key1
            value: value1
          - key: key2
            value: value2
        scopes: samplescope
        serviceProviderId: serviceproviderid
      resourceGroupName: OneResourceGroupName
      resourceName: samplebotname

Create a BotConnection Resource

new BotConnection(name: string, args: BotConnectionArgs, opts?: CustomResourceOptions);
@overload
def BotConnection(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  connection_name: Optional[str] = None,
                  kind: Optional[Union[str, Kind]] = None,
                  location: Optional[str] = None,
                  properties: Optional[ConnectionSettingPropertiesArgs] = None,
                  resource_group_name: Optional[str] = None,
                  resource_name_: Optional[str] = None,
                  sku: Optional[SkuArgs] = None,
                  tags: Optional[Mapping[str, str]] = None)
@overload
def BotConnection(resource_name: str,
                  args: BotConnectionArgs,
                  opts: Optional[ResourceOptions] = None)
func NewBotConnection(ctx *Context, name string, args BotConnectionArgs, opts ...ResourceOption) (*BotConnection, error)
public BotConnection(string name, BotConnectionArgs args, CustomResourceOptions? opts = null)
public BotConnection(String name, BotConnectionArgs args)
public BotConnection(String name, BotConnectionArgs args, CustomResourceOptions options)
type: azure-native:botservice:BotConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BotConnectionArgs
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 BotConnectionArgs
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 BotConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BotConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BotConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ResourceGroupName string

The name of the Bot resource group in the user subscription.

ResourceName string

The name of the Bot resource.

ConnectionName string

The name of the Bot Service Connection Setting resource.

Kind string | Pulumi.AzureNative.BotService.Kind

Required. Gets or sets the Kind of the resource.

Location string

Specifies the location of the resource.

Properties Pulumi.AzureNative.BotService.Inputs.ConnectionSettingPropertiesArgs

The set of properties specific to bot channel resource

Sku Pulumi.AzureNative.BotService.Inputs.SkuArgs

Gets or sets the SKU of the resource.

Tags Dictionary<string, string>

Contains resource tags defined as key/value pairs.

ResourceGroupName string

The name of the Bot resource group in the user subscription.

ResourceName string

The name of the Bot resource.

ConnectionName string

The name of the Bot Service Connection Setting resource.

Kind string | Kind

Required. Gets or sets the Kind of the resource.

Location string

Specifies the location of the resource.

Properties ConnectionSettingPropertiesArgs

The set of properties specific to bot channel resource

Sku SkuArgs

Gets or sets the SKU of the resource.

Tags map[string]string

Contains resource tags defined as key/value pairs.

resourceGroupName String

The name of the Bot resource group in the user subscription.

resourceName String

The name of the Bot resource.

connectionName String

The name of the Bot Service Connection Setting resource.

kind String | Kind

Required. Gets or sets the Kind of the resource.

location String

Specifies the location of the resource.

properties ConnectionSettingPropertiesArgs

The set of properties specific to bot channel resource

sku SkuArgs

Gets or sets the SKU of the resource.

tags Map

Contains resource tags defined as key/value pairs.

resourceGroupName string

The name of the Bot resource group in the user subscription.

resourceName string

The name of the Bot resource.

connectionName string

The name of the Bot Service Connection Setting resource.

kind string | Kind

Required. Gets or sets the Kind of the resource.

location string

Specifies the location of the resource.

properties ConnectionSettingPropertiesArgs

The set of properties specific to bot channel resource

sku SkuArgs

Gets or sets the SKU of the resource.

tags {[key: string]: string}

Contains resource tags defined as key/value pairs.

resource_group_name str

The name of the Bot resource group in the user subscription.

resource_name str

The name of the Bot resource.

connection_name str

The name of the Bot Service Connection Setting resource.

kind str | Kind

Required. Gets or sets the Kind of the resource.

location str

Specifies the location of the resource.

properties ConnectionSettingPropertiesArgs

The set of properties specific to bot channel resource

sku SkuArgs

Gets or sets the SKU of the resource.

tags Mapping[str, str]

Contains resource tags defined as key/value pairs.

resourceGroupName String

The name of the Bot resource group in the user subscription.

resourceName String

The name of the Bot resource.

connectionName String

The name of the Bot Service Connection Setting resource.

kind String | "sdk" | "designer" | "bot" | "function"

Required. Gets or sets the Kind of the resource.

location String

Specifies the location of the resource.

properties Property Map

The set of properties specific to bot channel resource

sku Property Map

Gets or sets the SKU of the resource.

tags Map

Contains resource tags defined as key/value pairs.

Outputs

All input properties are implicitly available as output properties. Additionally, the BotConnection resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

Specifies the name of the resource.

Type string

Specifies the type of the resource.

Zones List<string>

Entity zones

Etag string

Entity Tag

Id string

The provider-assigned unique ID for this managed resource.

Name string

Specifies the name of the resource.

Type string

Specifies the type of the resource.

Zones []string

Entity zones

Etag string

Entity Tag

id String

The provider-assigned unique ID for this managed resource.

name String

Specifies the name of the resource.

type String

Specifies the type of the resource.

zones List

Entity zones

etag String

Entity Tag

id string

The provider-assigned unique ID for this managed resource.

name string

Specifies the name of the resource.

type string

Specifies the type of the resource.

zones string[]

Entity zones

etag string

Entity Tag

id str

The provider-assigned unique ID for this managed resource.

name str

Specifies the name of the resource.

type str

Specifies the type of the resource.

zones Sequence[str]

Entity zones

etag str

Entity Tag

id String

The provider-assigned unique ID for this managed resource.

name String

Specifies the name of the resource.

type String

Specifies the type of the resource.

zones List

Entity zones

etag String

Entity Tag

Supporting Types

ConnectionSettingParameter

Key string

Key for the Connection Setting Parameter.

Value string

Value associated with the Connection Setting Parameter.

Key string

Key for the Connection Setting Parameter.

Value string

Value associated with the Connection Setting Parameter.

key String

Key for the Connection Setting Parameter.

value String

Value associated with the Connection Setting Parameter.

key string

Key for the Connection Setting Parameter.

value string

Value associated with the Connection Setting Parameter.

key str

Key for the Connection Setting Parameter.

value str

Value associated with the Connection Setting Parameter.

key String

Key for the Connection Setting Parameter.

value String

Value associated with the Connection Setting Parameter.

ConnectionSettingParameterResponse

Key string

Key for the Connection Setting Parameter.

Value string

Value associated with the Connection Setting Parameter.

Key string

Key for the Connection Setting Parameter.

Value string

Value associated with the Connection Setting Parameter.

key String

Key for the Connection Setting Parameter.

value String

Value associated with the Connection Setting Parameter.

key string

Key for the Connection Setting Parameter.

value string

Value associated with the Connection Setting Parameter.

key str

Key for the Connection Setting Parameter.

value str

Value associated with the Connection Setting Parameter.

key String

Key for the Connection Setting Parameter.

value String

Value associated with the Connection Setting Parameter.

ConnectionSettingProperties

ClientId string

Client Id associated with the Connection Setting.

ClientSecret string

Client Secret associated with the Connection Setting

Id string

Id associated with the Connection Setting.

Name string

Name associated with the Connection Setting.

Parameters List<Pulumi.AzureNative.BotService.Inputs.ConnectionSettingParameter>

Service Provider Parameters associated with the Connection Setting

ProvisioningState string

Provisioning state of the resource

Scopes string

Scopes associated with the Connection Setting

ServiceProviderDisplayName string

Service Provider Display Name associated with the Connection Setting

ServiceProviderId string

Service Provider Id associated with the Connection Setting

ClientId string

Client Id associated with the Connection Setting.

ClientSecret string

Client Secret associated with the Connection Setting

Id string

Id associated with the Connection Setting.

Name string

Name associated with the Connection Setting.

Parameters []ConnectionSettingParameter

Service Provider Parameters associated with the Connection Setting

ProvisioningState string

Provisioning state of the resource

Scopes string

Scopes associated with the Connection Setting

ServiceProviderDisplayName string

Service Provider Display Name associated with the Connection Setting

ServiceProviderId string

Service Provider Id associated with the Connection Setting

clientId String

Client Id associated with the Connection Setting.

clientSecret String

Client Secret associated with the Connection Setting

id String

Id associated with the Connection Setting.

name String

Name associated with the Connection Setting.

parameters ListSettingParameter>

Service Provider Parameters associated with the Connection Setting

provisioningState String

Provisioning state of the resource

scopes String

Scopes associated with the Connection Setting

serviceProviderDisplayName String

Service Provider Display Name associated with the Connection Setting

serviceProviderId String

Service Provider Id associated with the Connection Setting

clientId string

Client Id associated with the Connection Setting.

clientSecret string

Client Secret associated with the Connection Setting

id string

Id associated with the Connection Setting.

name string

Name associated with the Connection Setting.

parameters ConnectionSettingParameter[]

Service Provider Parameters associated with the Connection Setting

provisioningState string

Provisioning state of the resource

scopes string

Scopes associated with the Connection Setting

serviceProviderDisplayName string

Service Provider Display Name associated with the Connection Setting

serviceProviderId string

Service Provider Id associated with the Connection Setting

client_id str

Client Id associated with the Connection Setting.

client_secret str

Client Secret associated with the Connection Setting

id str

Id associated with the Connection Setting.

name str

Name associated with the Connection Setting.

parameters Sequence[ConnectionSettingParameter]

Service Provider Parameters associated with the Connection Setting

provisioning_state str

Provisioning state of the resource

scopes str

Scopes associated with the Connection Setting

service_provider_display_name str

Service Provider Display Name associated with the Connection Setting

service_provider_id str

Service Provider Id associated with the Connection Setting

clientId String

Client Id associated with the Connection Setting.

clientSecret String

Client Secret associated with the Connection Setting

id String

Id associated with the Connection Setting.

name String

Name associated with the Connection Setting.

parameters List

Service Provider Parameters associated with the Connection Setting

provisioningState String

Provisioning state of the resource

scopes String

Scopes associated with the Connection Setting

serviceProviderDisplayName String

Service Provider Display Name associated with the Connection Setting

serviceProviderId String

Service Provider Id associated with the Connection Setting

ConnectionSettingPropertiesResponse

SettingId string

Setting Id set by the service for the Connection Setting.

ClientId string

Client Id associated with the Connection Setting.

ClientSecret string

Client Secret associated with the Connection Setting

Id string

Id associated with the Connection Setting.

Name string

Name associated with the Connection Setting.

Parameters List<Pulumi.AzureNative.BotService.Inputs.ConnectionSettingParameterResponse>

Service Provider Parameters associated with the Connection Setting

ProvisioningState string

Provisioning state of the resource

Scopes string

Scopes associated with the Connection Setting

ServiceProviderDisplayName string

Service Provider Display Name associated with the Connection Setting

ServiceProviderId string

Service Provider Id associated with the Connection Setting

SettingId string

Setting Id set by the service for the Connection Setting.

ClientId string

Client Id associated with the Connection Setting.

ClientSecret string

Client Secret associated with the Connection Setting

Id string

Id associated with the Connection Setting.

Name string

Name associated with the Connection Setting.

Parameters []ConnectionSettingParameterResponse

Service Provider Parameters associated with the Connection Setting

ProvisioningState string

Provisioning state of the resource

Scopes string

Scopes associated with the Connection Setting

ServiceProviderDisplayName string

Service Provider Display Name associated with the Connection Setting

ServiceProviderId string

Service Provider Id associated with the Connection Setting

settingId String

Setting Id set by the service for the Connection Setting.

clientId String

Client Id associated with the Connection Setting.

clientSecret String

Client Secret associated with the Connection Setting

id String

Id associated with the Connection Setting.

name String

Name associated with the Connection Setting.

parameters ListSettingParameterResponse>

Service Provider Parameters associated with the Connection Setting

provisioningState String

Provisioning state of the resource

scopes String

Scopes associated with the Connection Setting

serviceProviderDisplayName String

Service Provider Display Name associated with the Connection Setting

serviceProviderId String

Service Provider Id associated with the Connection Setting

settingId string

Setting Id set by the service for the Connection Setting.

clientId string

Client Id associated with the Connection Setting.

clientSecret string

Client Secret associated with the Connection Setting

id string

Id associated with the Connection Setting.

name string

Name associated with the Connection Setting.

parameters ConnectionSettingParameterResponse[]

Service Provider Parameters associated with the Connection Setting

provisioningState string

Provisioning state of the resource

scopes string

Scopes associated with the Connection Setting

serviceProviderDisplayName string

Service Provider Display Name associated with the Connection Setting

serviceProviderId string

Service Provider Id associated with the Connection Setting

setting_id str

Setting Id set by the service for the Connection Setting.

client_id str

Client Id associated with the Connection Setting.

client_secret str

Client Secret associated with the Connection Setting

id str

Id associated with the Connection Setting.

name str

Name associated with the Connection Setting.

parameters Sequence[ConnectionSettingParameterResponse]

Service Provider Parameters associated with the Connection Setting

provisioning_state str

Provisioning state of the resource

scopes str

Scopes associated with the Connection Setting

service_provider_display_name str

Service Provider Display Name associated with the Connection Setting

service_provider_id str

Service Provider Id associated with the Connection Setting

settingId String

Setting Id set by the service for the Connection Setting.

clientId String

Client Id associated with the Connection Setting.

clientSecret String

Client Secret associated with the Connection Setting

id String

Id associated with the Connection Setting.

name String

Name associated with the Connection Setting.

parameters List

Service Provider Parameters associated with the Connection Setting

provisioningState String

Provisioning state of the resource

scopes String

Scopes associated with the Connection Setting

serviceProviderDisplayName String

Service Provider Display Name associated with the Connection Setting

serviceProviderId String

Service Provider Id associated with the Connection Setting

Kind

Sdk
sdk
Designer
designer
Bot
bot
Function
function
KindSdk
sdk
KindDesigner
designer
KindBot
bot
KindFunction
function
Sdk
sdk
Designer
designer
Bot
bot
Function
function
Sdk
sdk
Designer
designer
Bot
bot
Function
function
SDK
sdk
DESIGNER
designer
BOT
bot
FUNCTION
function
"sdk"
sdk
"designer"
designer
"bot"
bot
"function"
function

Sku

Name string | SkuName

The sku name

name String | SkuName

The sku name

name string | SkuName

The sku name

name str | SkuName

The sku name

name String | "F0" | "S1"

The sku name

SkuName

F0
F0
S1
S1
SkuNameF0
F0
SkuNameS1
S1
F0
F0
S1
S1
F0
F0
S1
S1
F0
F0
S1
S1
"F0"
F0
"S1"
S1

SkuResponse

Name string

The sku name

Tier string

Gets the sku tier. This is based on the SKU name.

Name string

The sku name

Tier string

Gets the sku tier. This is based on the SKU name.

name String

The sku name

tier String

Gets the sku tier. This is based on the SKU name.

name string

The sku name

tier string

Gets the sku tier. This is based on the SKU name.

name str

The sku name

tier str

Gets the sku tier. This is based on the SKU name.

name String

The sku name

tier String

Gets the sku tier. This is based on the SKU name.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:botservice:BotConnection sampleConnection /subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0