Share via

Microsoft.HealthBot healthBots 2020-10-20-preview

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-10-20-preview' = {
  location: 'string'
  name: 'string'
  properties: {}
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HealthBot/healthBots

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 2
Max length = 64
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
properties The set of properties specific to healthcare bot resource. HealthBotProperties
sku SKU of the HealthBot. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

HealthBotProperties

Name Description Value

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 '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'

TrackedResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Health Bot AVM Resource Module for Azure Health Bot

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-10-20-preview",
  "name": "string",
  "location": "string",
  "properties": {
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HealthBot/healthBots

Name Description Value
apiVersion The api version '2020-10-20-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 2
Max length = 64
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
properties The set of properties specific to healthcare bot resource. HealthBotProperties
sku SKU of the HealthBot. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HealthBot/healthBots'

HealthBotProperties

Name Description Value

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 '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'

TrackedResourceTags

Name Description Value

Usage Examples

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-10-20-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.HealthBot/healthBots

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 2
Max length = 64
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
properties The set of properties specific to healthcare bot resource. HealthBotProperties
sku SKU of the HealthBot. Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HealthBot/healthBots@2020-10-20-preview"

HealthBotProperties

Name Description Value

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 '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'

TrackedResourceTags

Name Description Value