azure-native.botservice.BotConnection
Explore with Pulumi AI
Bot channel resource definition Azure REST API version: 2022-09-15. Prior API version in Azure Native 1.x: 2021-03-01.
Other available API versions: 2023-09-15-preview.
Example Usage
Create Connection Setting
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var botConnection = new AzureNative.BotService.BotConnection("botConnection", new()
{
ConnectionName = "sampleConnection",
Location = "West US",
Properties = new AzureNative.BotService.Inputs.ConnectionSettingPropertiesArgs
{
ClientId = "sampleclientid",
ClientSecret = "samplesecret",
Parameters = new[]
{
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/botservice/v2"
"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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.botservice.BotConnection;
import com.pulumi.azurenative.botservice.BotConnectionArgs;
import com.pulumi.azurenative.botservice.inputs.ConnectionSettingPropertiesArgs;
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) {
var botConnection = new BotConnection("botConnection", BotConnectionArgs.builder()
.connectionName("sampleConnection")
.location("West US")
.properties(ConnectionSettingPropertiesArgs.builder()
.clientId("sampleclientid")
.clientSecret("samplesecret")
.parameters(
ConnectionSettingParameterArgs.builder()
.key("key1")
.value("value1")
.build(),
ConnectionSettingParameterArgs.builder()
.key("key2")
.value("value2")
.build())
.scopes("samplescope")
.serviceProviderId("serviceproviderid")
.build())
.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={
"client_id": "sampleclientid",
"client_secret": "samplesecret",
"parameters": [
{
"key": "key1",
"value": "value1",
},
{
"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 BotConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BotConnection(name: string, args: BotConnectionArgs, opts?: CustomResourceOptions);
@overload
def BotConnection(resource_name: str,
args: BotConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BotConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
resource_name_: Optional[str] = None,
connection_name: Optional[str] = None,
kind: Optional[Union[str, Kind]] = None,
location: Optional[str] = None,
properties: Optional[ConnectionSettingPropertiesArgs] = None,
sku: Optional[SkuArgs] = None,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var botConnectionResource = new AzureNative.BotService.BotConnection("botConnectionResource", new()
{
ResourceGroupName = "string",
ResourceName = "string",
ConnectionName = "string",
Kind = "string",
Location = "string",
Properties = new AzureNative.BotService.Inputs.ConnectionSettingPropertiesArgs
{
ClientId = "string",
ClientSecret = "string",
Id = "string",
Name = "string",
Parameters = new[]
{
new AzureNative.BotService.Inputs.ConnectionSettingParameterArgs
{
Key = "string",
Value = "string",
},
},
ProvisioningState = "string",
Scopes = "string",
ServiceProviderDisplayName = "string",
ServiceProviderId = "string",
},
Sku = new AzureNative.BotService.Inputs.SkuArgs
{
Name = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := botservice.NewBotConnection(ctx, "botConnectionResource", &botservice.BotConnectionArgs{
ResourceGroupName: pulumi.String("string"),
ResourceName: pulumi.String("string"),
ConnectionName: pulumi.String("string"),
Kind: pulumi.String("string"),
Location: pulumi.String("string"),
Properties: &botservice.ConnectionSettingPropertiesArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Parameters: botservice.ConnectionSettingParameterArray{
&botservice.ConnectionSettingParameterArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ProvisioningState: pulumi.String("string"),
Scopes: pulumi.String("string"),
ServiceProviderDisplayName: pulumi.String("string"),
ServiceProviderId: pulumi.String("string"),
},
Sku: &botservice.SkuArgs{
Name: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var botConnectionResource = new BotConnection("botConnectionResource", BotConnectionArgs.builder()
.resourceGroupName("string")
.resourceName("string")
.connectionName("string")
.kind("string")
.location("string")
.properties(ConnectionSettingPropertiesArgs.builder()
.clientId("string")
.clientSecret("string")
.id("string")
.name("string")
.parameters(ConnectionSettingParameterArgs.builder()
.key("string")
.value("string")
.build())
.provisioningState("string")
.scopes("string")
.serviceProviderDisplayName("string")
.serviceProviderId("string")
.build())
.sku(SkuArgs.builder()
.name("string")
.build())
.tags(Map.of("string", "string"))
.build());
bot_connection_resource = azure_native.botservice.BotConnection("botConnectionResource",
resource_group_name="string",
resource_name_="string",
connection_name="string",
kind="string",
location="string",
properties={
"clientId": "string",
"clientSecret": "string",
"id": "string",
"name": "string",
"parameters": [{
"key": "string",
"value": "string",
}],
"provisioningState": "string",
"scopes": "string",
"serviceProviderDisplayName": "string",
"serviceProviderId": "string",
},
sku={
"name": "string",
},
tags={
"string": "string",
})
const botConnectionResource = new azure_native.botservice.BotConnection("botConnectionResource", {
resourceGroupName: "string",
resourceName: "string",
connectionName: "string",
kind: "string",
location: "string",
properties: {
clientId: "string",
clientSecret: "string",
id: "string",
name: "string",
parameters: [{
key: "string",
value: "string",
}],
provisioningState: "string",
scopes: "string",
serviceProviderDisplayName: "string",
serviceProviderId: "string",
},
sku: {
name: "string",
},
tags: {
string: "string",
},
});
type: azure-native:botservice:BotConnection
properties:
connectionName: string
kind: string
location: string
properties:
clientId: string
clientSecret: string
id: string
name: string
parameters:
- key: string
value: string
provisioningState: string
scopes: string
serviceProviderDisplayName: string
serviceProviderId: string
resourceGroupName: string
resourceName: string
sku:
name: string
tags:
string: string
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:
- Resource
Group stringName - The name of the Bot resource group in the user subscription.
- Resource
Name string - The name of the Bot resource.
- Connection
Name string - The name of the Bot Service Connection Setting resource.
- Kind
string | Pulumi.
Azure Native. Bot Service. Kind - Required. Gets or sets the Kind of the resource.
- Location string
- Specifies the location of the resource.
- Properties
Pulumi.
Azure Native. Bot Service. Inputs. Connection Setting Properties - The set of properties specific to bot channel resource
- Sku
Pulumi.
Azure Native. Bot Service. Inputs. Sku - Gets or sets the SKU of the resource.
- Dictionary<string, string>
- Contains resource tags defined as key/value pairs.
- Resource
Group stringName - The name of the Bot resource group in the user subscription.
- Resource
Name string - The name of the Bot resource.
- Connection
Name 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
Connection
Setting Properties Args - The set of properties specific to bot channel resource
- Sku
Sku
Args - Gets or sets the SKU of the resource.
- map[string]string
- Contains resource tags defined as key/value pairs.
- resource
Group StringName - The name of the Bot resource group in the user subscription.
- resource
Name String - The name of the Bot resource.
- connection
Name 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
Connection
Setting Properties - The set of properties specific to bot channel resource
- sku Sku
- Gets or sets the SKU of the resource.
- Map<String,String>
- Contains resource tags defined as key/value pairs.
- resource
Group stringName - The name of the Bot resource group in the user subscription.
- resource
Name string - The name of the Bot resource.
- connection
Name 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
Connection
Setting Properties - The set of properties specific to bot channel resource
- sku Sku
- Gets or sets the SKU of the resource.
- {[key: string]: string}
- Contains resource tags defined as key/value pairs.
- resource_
group_ strname - 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
Connection
Setting Properties Args - The set of properties specific to bot channel resource
- sku
Sku
Args - Gets or sets the SKU of the resource.
- Mapping[str, str]
- Contains resource tags defined as key/value pairs.
- resource
Group StringName - The name of the Bot resource group in the user subscription.
- resource
Name String - The name of the Bot resource.
- connection
Name String - The name of the Bot Service Connection Setting resource.
- kind String | "sdk" | "designer" | "bot" | "function" | "azurebot"
- 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.
- Map<String>
- 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:
Supporting Types
ConnectionSettingParameter, ConnectionSettingParameterArgs
ConnectionSettingParameterResponse, ConnectionSettingParameterResponseArgs
ConnectionSettingProperties, ConnectionSettingPropertiesArgs
- Client
Id string - Client Id associated with the Connection Setting.
- Client
Secret string - Client Secret associated with the Connection Setting
- Id string
- Id of the Connection Setting.
- Name string
- Name of the Connection Setting.
- Parameters
List<Pulumi.
Azure Native. Bot Service. Inputs. Connection Setting Parameter> - Service Provider Parameters associated with the Connection Setting
- Provisioning
State string - Provisioning state of the resource
- Scopes string
- Scopes associated with the Connection Setting
- Service
Provider stringDisplay Name - Service Provider Display Name associated with the Connection Setting
- Service
Provider stringId - Service Provider Id associated with the Connection Setting
- Client
Id string - Client Id associated with the Connection Setting.
- Client
Secret string - Client Secret associated with the Connection Setting
- Id string
- Id of the Connection Setting.
- Name string
- Name of the Connection Setting.
- Parameters
[]Connection
Setting Parameter - Service Provider Parameters associated with the Connection Setting
- Provisioning
State string - Provisioning state of the resource
- Scopes string
- Scopes associated with the Connection Setting
- Service
Provider stringDisplay Name - Service Provider Display Name associated with the Connection Setting
- Service
Provider stringId - Service Provider Id associated with the Connection Setting
- client
Id String - Client Id associated with the Connection Setting.
- client
Secret String - Client Secret associated with the Connection Setting
- id String
- Id of the Connection Setting.
- name String
- Name of the Connection Setting.
- parameters
List<Connection
Setting Parameter> - Service Provider Parameters associated with the Connection Setting
- provisioning
State String - Provisioning state of the resource
- scopes String
- Scopes associated with the Connection Setting
- service
Provider StringDisplay Name - Service Provider Display Name associated with the Connection Setting
- service
Provider StringId - Service Provider Id associated with the Connection Setting
- client
Id string - Client Id associated with the Connection Setting.
- client
Secret string - Client Secret associated with the Connection Setting
- id string
- Id of the Connection Setting.
- name string
- Name of the Connection Setting.
- parameters
Connection
Setting Parameter[] - Service Provider Parameters associated with the Connection Setting
- provisioning
State string - Provisioning state of the resource
- scopes string
- Scopes associated with the Connection Setting
- service
Provider stringDisplay Name - Service Provider Display Name associated with the Connection Setting
- service
Provider stringId - 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 of the Connection Setting.
- name str
- Name of the Connection Setting.
- parameters
Sequence[Connection
Setting Parameter] - 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_ strdisplay_ name - Service Provider Display Name associated with the Connection Setting
- service_
provider_ strid - Service Provider Id associated with the Connection Setting
- client
Id String - Client Id associated with the Connection Setting.
- client
Secret String - Client Secret associated with the Connection Setting
- id String
- Id of the Connection Setting.
- name String
- Name of the Connection Setting.
- parameters List<Property Map>
- Service Provider Parameters associated with the Connection Setting
- provisioning
State String - Provisioning state of the resource
- scopes String
- Scopes associated with the Connection Setting
- service
Provider StringDisplay Name - Service Provider Display Name associated with the Connection Setting
- service
Provider StringId - Service Provider Id associated with the Connection Setting
ConnectionSettingPropertiesResponse, ConnectionSettingPropertiesResponseArgs
- Setting
Id string - Setting Id set by the service for the Connection Setting.
- Client
Id string - Client Id associated with the Connection Setting.
- Client
Secret string - Client Secret associated with the Connection Setting
- Id string
- Id of the Connection Setting.
- Name string
- Name of the Connection Setting.
- Parameters
List<Pulumi.
Azure Native. Bot Service. Inputs. Connection Setting Parameter Response> - Service Provider Parameters associated with the Connection Setting
- Provisioning
State string - Provisioning state of the resource
- Scopes string
- Scopes associated with the Connection Setting
- Service
Provider stringDisplay Name - Service Provider Display Name associated with the Connection Setting
- Service
Provider stringId - Service Provider Id associated with the Connection Setting
- Setting
Id string - Setting Id set by the service for the Connection Setting.
- Client
Id string - Client Id associated with the Connection Setting.
- Client
Secret string - Client Secret associated with the Connection Setting
- Id string
- Id of the Connection Setting.
- Name string
- Name of the Connection Setting.
- Parameters
[]Connection
Setting Parameter Response - Service Provider Parameters associated with the Connection Setting
- Provisioning
State string - Provisioning state of the resource
- Scopes string
- Scopes associated with the Connection Setting
- Service
Provider stringDisplay Name - Service Provider Display Name associated with the Connection Setting
- Service
Provider stringId - Service Provider Id associated with the Connection Setting
- setting
Id String - Setting Id set by the service for the Connection Setting.
- client
Id String - Client Id associated with the Connection Setting.
- client
Secret String - Client Secret associated with the Connection Setting
- id String
- Id of the Connection Setting.
- name String
- Name of the Connection Setting.
- parameters
List<Connection
Setting Parameter Response> - Service Provider Parameters associated with the Connection Setting
- provisioning
State String - Provisioning state of the resource
- scopes String
- Scopes associated with the Connection Setting
- service
Provider StringDisplay Name - Service Provider Display Name associated with the Connection Setting
- service
Provider StringId - Service Provider Id associated with the Connection Setting
- setting
Id string - Setting Id set by the service for the Connection Setting.
- client
Id string - Client Id associated with the Connection Setting.
- client
Secret string - Client Secret associated with the Connection Setting
- id string
- Id of the Connection Setting.
- name string
- Name of the Connection Setting.
- parameters
Connection
Setting Parameter Response[] - Service Provider Parameters associated with the Connection Setting
- provisioning
State string - Provisioning state of the resource
- scopes string
- Scopes associated with the Connection Setting
- service
Provider stringDisplay Name - Service Provider Display Name associated with the Connection Setting
- service
Provider stringId - 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 of the Connection Setting.
- name str
- Name of the Connection Setting.
- parameters
Sequence[Connection
Setting Parameter Response] - 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_ strdisplay_ name - Service Provider Display Name associated with the Connection Setting
- service_
provider_ strid - Service Provider Id associated with the Connection Setting
- setting
Id String - Setting Id set by the service for the Connection Setting.
- client
Id String - Client Id associated with the Connection Setting.
- client
Secret String - Client Secret associated with the Connection Setting
- id String
- Id of the Connection Setting.
- name String
- Name of the Connection Setting.
- parameters List<Property Map>
- Service Provider Parameters associated with the Connection Setting
- provisioning
State String - Provisioning state of the resource
- scopes String
- Scopes associated with the Connection Setting
- service
Provider StringDisplay Name - Service Provider Display Name associated with the Connection Setting
- service
Provider StringId - Service Provider Id associated with the Connection Setting
Kind, KindArgs
- Sdk
- sdk
- Designer
- designer
- Bot
- bot
- Function
- function
- Azurebot
- azurebot
- Kind
Sdk - sdk
- Kind
Designer - designer
- Kind
Bot - bot
- Kind
Function - function
- Kind
Azurebot - azurebot
- Sdk
- sdk
- Designer
- designer
- Bot
- bot
- Function
- function
- Azurebot
- azurebot
- Sdk
- sdk
- Designer
- designer
- Bot
- bot
- Function
- function
- Azurebot
- azurebot
- SDK
- sdk
- DESIGNER
- designer
- BOT
- bot
- FUNCTION
- function
- AZUREBOT
- azurebot
- "sdk"
- sdk
- "designer"
- designer
- "bot"
- bot
- "function"
- function
- "azurebot"
- azurebot
Sku, SkuArgs
- Name
string | Pulumi.
Azure Native. Bot Service. Sku Name - The sku name
- name String | "F0" | "S1"
- The sku name
SkuName, SkuNameArgs
- F0
- F0
- S1
- S1
- Sku
Name F0 - F0
- Sku
Name S1 - S1
- F0
- F0
- S1
- S1
- F0
- F0
- S1
- S1
- F0
- F0
- S1
- S1
- "F0"
- F0
- "S1"
- S1
SkuResponse, SkuResponseArgs
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:botservice:BotConnection sampleConnection /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0