Microsoft.BotService botServices/Connections template reference

Template format

To create a Microsoft.BotService/botServices/Connections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.BotService/botServices/Connections",
  "apiVersion": "2017-12-01",
  "location": "string",
  "tags": {},
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "scopes": "string",
    "serviceProviderId": "string",
    "serviceProviderDisplayName": "string",
    "parameters": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.BotService/botServices/Connections object

Name Type Required Value
name string Yes The name of the Bot Service Connection Setting resource
type enum Yes Connections
-or-
Microsoft.BotService/botServices/Connections

See Set name and type for child resources.
apiVersion enum Yes 2017-12-01
location string No Specifies the location of the resource.
tags object No Contains resource tags defined as key/value pairs.
sku object No Gets or sets the SKU of the resource. - Sku object
kind enum No Required. Gets or sets the Kind of the resource. - sdk, designer, bot, function
properties object Yes The set of properties specific to bot channel resource - ConnectionSettingProperties object

Sku object

Name Type Required Value
name enum Yes The sku name. - F0 or S1

ConnectionSettingProperties object

Name Type Required Value
clientId string No Client Id associated with the Connection Setting.
clientSecret string No Client Secret associated with the Connection Setting
scopes string No Scopes associated with the Connection Setting
serviceProviderId string No Service Provider Id associated with the Connection Setting
serviceProviderDisplayName string No Service Provider Display Name associated with the Connection Setting
parameters array No Service Provider Parameters associated with the Connection Setting - ConnectionSettingParameter object

ConnectionSettingParameter object

Name Type Required Value
key string No Key for the Connection Setting Parameter.
value string No Value associated with the Connection Setting Parameter.