Microsoft.BotService enterpriseChannels 2018-07-12

  • Article

Bicep resource definition

The enterpriseChannels resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.BotService/enterpriseChannels resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.BotService/enterpriseChannels@2018-07-12' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  etag: 'string'
  properties: {
    nodes: [
      {
        azureLocation: 'string'
        azureSku: 'string'
        name: 'string'
        state: 'string'
      }
    ]
    state: 'string'
  }
}

Property values

enterpriseChannels

Name Description Value
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
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. 'bot'
'designer'
'function'
'sdk'
etag Entity Tag string
properties The set of properties specific to an Enterprise Channel resource. EnterpriseChannelProperties

EnterpriseChannelProperties

Name Description Value
nodes The nodes associated with the Enterprise Channel. EnterpriseChannelNode[] (required)
state The current state of the Enterprise Channel. 'CreateFailed'
'Creating'
'DeleteFailed'
'Deleting'
'StartFailed'
'Started'
'Starting'
'StopFailed'
'Stopped'
'Stopping'

EnterpriseChannelNode

Name Description Value
azureLocation The location of the Enterprise Channel Node. string (required)
azureSku The sku of the Enterprise Channel Node. string (required)
name The name of the Enterprise Channel Node. string (required)
state The current state of the Enterprise Channel Node. 'CreateFailed'
'Creating'
'DeleteFailed'
'Deleting'
'StartFailed'
'Started'
'Starting'
'StopFailed'
'Stopped'
'Stopping'

Sku

Name Description Value
name The sku name 'F0'
'S1' (required)

ARM template resource definition

The enterpriseChannels resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.BotService/enterpriseChannels resource, add the following JSON to your template.

{
  "type": "Microsoft.BotService/enterpriseChannels",
  "apiVersion": "2018-07-12",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "etag": "string",
  "properties": {
    "nodes": [
      {
        "azureLocation": "string",
        "azureSku": "string",
        "name": "string",
        "state": "string"
      }
    ],
    "state": "string"
  }
}

Property values

enterpriseChannels

Name Description Value
type The resource type 'Microsoft.BotService/enterpriseChannels'
apiVersion The resource api version '2018-07-12'
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
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. 'bot'
'designer'
'function'
'sdk'
etag Entity Tag string
properties The set of properties specific to an Enterprise Channel resource. EnterpriseChannelProperties

EnterpriseChannelProperties

Name Description Value
nodes The nodes associated with the Enterprise Channel. EnterpriseChannelNode[] (required)
state The current state of the Enterprise Channel. 'CreateFailed'
'Creating'
'DeleteFailed'
'Deleting'
'StartFailed'
'Started'
'Starting'
'StopFailed'
'Stopped'
'Stopping'

EnterpriseChannelNode

Name Description Value
azureLocation The location of the Enterprise Channel Node. string (required)
azureSku The sku of the Enterprise Channel Node. string (required)
name The name of the Enterprise Channel Node. string (required)
state The current state of the Enterprise Channel Node. 'CreateFailed'
'Creating'
'DeleteFailed'
'Deleting'
'StartFailed'
'Started'
'Starting'
'StopFailed'
'Stopped'
'Stopping'

Sku

Name Description Value
name The sku name 'F0'
'S1' (required)

Terraform (AzAPI provider) resource definition

The enterpriseChannels 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/enterpriseChannels resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.BotService/enterpriseChannels@2018-07-12"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      nodes = [
        {
          azureLocation = "string"
          azureSku = "string"
          name = "string"
          state = "string"
        }
      ]
      state = "string"
    }
    sku = {
      name = "string"
    }
    kind = "string"
    etag = "string"
  })
}

Property values

enterpriseChannels

Name Description Value
type The resource type "Microsoft.BotService/enterpriseChannels@2018-07-12"
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 To deploy to a resource group, use the ID of that resource group. string (required)
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. "bot"
"designer"
"function"
"sdk"
etag Entity Tag string
properties The set of properties specific to an Enterprise Channel resource. EnterpriseChannelProperties

EnterpriseChannelProperties

Name Description Value
nodes The nodes associated with the Enterprise Channel. EnterpriseChannelNode[] (required)
state The current state of the Enterprise Channel. "CreateFailed"
"Creating"
"DeleteFailed"
"Deleting"
"StartFailed"
"Started"
"Starting"
"StopFailed"
"Stopped"
"Stopping"

EnterpriseChannelNode

Name Description Value
azureLocation The location of the Enterprise Channel Node. string (required)
azureSku The sku of the Enterprise Channel Node. string (required)
name The name of the Enterprise Channel Node. string (required)
state The current state of the Enterprise Channel Node. "CreateFailed"
"Creating"
"DeleteFailed"
"Deleting"
"StartFailed"
"Started"
"Starting"
"StopFailed"
"Stopped"
"Stopping"

Sku

Name Description Value
name The sku name "F0"
"S1" (required)