Share via

Microsoft.HealthBot healthBots 2020-12-08-preview

  • Article

Bicep resource definition

The healthBots 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.HealthBot/healthBots resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HealthBot/healthBots@2020-12-08-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  properties: {}
}

Property values

healthBots

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku SKU of the HealthBot. Sku
properties The set of properties specific to healthcare bot resource. HealthBotProperties

HealthBotProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the HealthBot SKU 'C0'
'F0'
'S1' (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Free'
'Standard'

ARM template resource definition

The healthBots 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.HealthBot/healthBots resource, add the following JSON to your template.

{
  "type": "Microsoft.HealthBot/healthBots",
  "apiVersion": "2020-12-08-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {}
}

Property values

healthBots

Name Description Value
type The resource type 'Microsoft.HealthBot/healthBots'
apiVersion The resource api version '2020-12-08-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku SKU of the HealthBot. Sku
properties The set of properties specific to healthcare bot resource. HealthBotProperties

HealthBotProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the HealthBot SKU 'C0'
'F0'
'S1' (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Free'
'Standard'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HealthBot/healthBots@2020-12-08-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {}
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

Property values

healthBots

Name Description Value
type The resource type "Microsoft.HealthBot/healthBots@2020-12-08-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku SKU of the HealthBot. Sku
properties The set of properties specific to healthcare bot resource. HealthBotProperties

HealthBotProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the HealthBot SKU "C0"
"F0"
"S1" (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. "Free"
"Standard"