Microsoft.BotService botServices/connections
Bicep resource definition
The botServices/connections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BotService/botServices/connections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.BotService/botServices/connections@2022-09-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
kind: 'string'
parent: resourceSymbolicName
etag: 'string'
properties: {
clientId: 'string'
clientSecret: 'string'
parameters: [
{
key: 'string'
value: 'string'
}
]
provisioningState: 'string'
scopes: 'string'
serviceProviderDisplayName: 'string'
serviceProviderId: 'string'
}
}
Property values
botServices/connections
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. |
| location | Specifies the location of the resource. | string |
| tags | Contains resource tags defined as key/value pairs. | Dictionary of tag names and values. See Tags in templates |
| sku | Gets or sets the SKU of the resource. | Sku |
| kind | Required. Gets or sets the Kind of the resource. | 'azurebot' 'bot' 'designer' 'function' 'sdk' |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: botServices |
| etag | Entity Tag | string |
| properties | The set of properties specific to bot channel resource | ConnectionSettingProperties |
ConnectionSettingProperties
| Name | Description | Value |
|---|---|---|
| clientId | Client Id associated with the Connection Setting. | string |
| clientSecret | Client Secret associated with the Connection Setting | string |
| parameters | Service Provider Parameters associated with the Connection Setting | ConnectionSettingParameter[] |
| provisioningState | Provisioning state of the resource | string |
| scopes | Scopes associated with the Connection Setting | string |
| serviceProviderDisplayName | Service Provider Display Name associated with the Connection Setting | string |
| serviceProviderId | Service Provider Id associated with the Connection Setting | string |
ConnectionSettingParameter
| Name | Description | Value |
|---|---|---|
| key | Key for the Connection Setting Parameter. | string |
| value | Value associated with the Connection Setting Parameter. | string |
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |
ARM template resource definition
The botServices/connections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BotService/botServices/connections resource, add the following JSON to your template.
{
"type": "Microsoft.BotService/botServices/connections",
"apiVersion": "2022-09-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"kind": "string",
"etag": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"parameters": [
{
"key": "string",
"value": "string"
}
],
"provisioningState": "string",
"scopes": "string",
"serviceProviderDisplayName": "string",
"serviceProviderId": "string"
}
}
Property values
botServices/connections
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.BotService/botServices/connections' |
| apiVersion | The resource api version | '2022-09-15' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. |
| location | Specifies the location of the resource. | string |
| tags | Contains resource tags defined as key/value pairs. | Dictionary of tag names and values. See Tags in templates |
| sku | Gets or sets the SKU of the resource. | Sku |
| kind | Required. Gets or sets the Kind of the resource. | 'azurebot' 'bot' 'designer' 'function' 'sdk' |
| etag | Entity Tag | string |
| properties | The set of properties specific to bot channel resource | ConnectionSettingProperties |
ConnectionSettingProperties
| Name | Description | Value |
|---|---|---|
| clientId | Client Id associated with the Connection Setting. | string |
| clientSecret | Client Secret associated with the Connection Setting | string |
| parameters | Service Provider Parameters associated with the Connection Setting | ConnectionSettingParameter[] |
| provisioningState | Provisioning state of the resource | string |
| scopes | Scopes associated with the Connection Setting | string |
| serviceProviderDisplayName | Service Provider Display Name associated with the Connection Setting | string |
| serviceProviderId | Service Provider Id associated with the Connection Setting | string |
ConnectionSettingParameter
| Name | Description | Value |
|---|---|---|
| key | Key for the Connection Setting Parameter. | string |
| value | Value associated with the Connection Setting Parameter. | string |
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | 'F0' 'S1' (required) |
Terraform (AzAPI provider) resource definition
The botServices/connections resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.BotService/botServices/connections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.BotService/botServices/connections@2022-09-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
parameters = [
{
key = "string"
value = "string"
}
]
provisioningState = "string"
scopes = "string"
serviceProviderDisplayName = "string"
serviceProviderId = "string"
}
sku = {
name = "string"
}
kind = "string"
etag = "string"
})
}
Property values
botServices/connections
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.BotService/botServices/connections@2022-09-15" |
| name | The resource name | string (required) Character limit: 2-64 Valid characters: Alphanumerics, underscores, periods, and hyphens. Start with alphanumeric. |
| location | Specifies the location of the resource. | string |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: botServices |
| tags | Contains resource tags defined as key/value pairs. | Dictionary of tag names and values. |
| sku | Gets or sets the SKU of the resource. | Sku |
| kind | Required. Gets or sets the Kind of the resource. | "azurebot" "bot" "designer" "function" "sdk" |
| etag | Entity Tag | string |
| properties | The set of properties specific to bot channel resource | ConnectionSettingProperties |
ConnectionSettingProperties
| Name | Description | Value |
|---|---|---|
| clientId | Client Id associated with the Connection Setting. | string |
| clientSecret | Client Secret associated with the Connection Setting | string |
| parameters | Service Provider Parameters associated with the Connection Setting | ConnectionSettingParameter[] |
| provisioningState | Provisioning state of the resource | string |
| scopes | Scopes associated with the Connection Setting | string |
| serviceProviderDisplayName | Service Provider Display Name associated with the Connection Setting | string |
| serviceProviderId | Service Provider Id associated with the Connection Setting | string |
ConnectionSettingParameter
| Name | Description | Value |
|---|---|---|
| key | Key for the Connection Setting Parameter. | string |
| value | Value associated with the Connection Setting Parameter. | string |
Sku
| Name | Description | Value |
|---|---|---|
| name | The sku name | "F0" "S1" (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for