Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The healthBots 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.HealthBot/healthBots resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HealthBot/healthBots@2025-05-25' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
userIdentity: 'string'
}
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HealthBot/healthBots
| Name | Description | Value |
|---|---|---|
| identity | The identity of the Azure Health Bot. | Identity |
| 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 Azure Health Bot resource. | HealthBotProperties |
| sku | SKU of the Azure Health Bot. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
HealthBotProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | KeyVault properties for the resource encryption. | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
UserAssignedIdentityMap |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key vault key. | string (required) |
| keyVaultUri | The Uri of the key vault. | string (required) |
| keyVersion | The version of the key vault key. | string |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string |
Sku
| Name | Description | Value |
|---|---|---|
| name | The name of the Azure Health Bot SKU | 'C0' 'C1' 'F0' 'PES' 'S1' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserAssignedIdentityMap
| 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:
- 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.HealthBot/healthBots resource, add the following JSON to your template.
{
"type": "Microsoft.HealthBot/healthBots",
"apiVersion": "2025-05-25",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string",
"userIdentity": "string"
}
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HealthBot/healthBots
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-05-25' |
| identity | The identity of the Azure Health Bot. | Identity |
| 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 Azure Health Bot resource. | HealthBotProperties |
| sku | SKU of the Azure Health Bot. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HealthBot/healthBots' |
HealthBotProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | KeyVault properties for the resource encryption. | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
UserAssignedIdentityMap |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key vault key. | string (required) |
| keyVaultUri | The Uri of the key vault. | string (required) |
| keyVersion | The version of the key vault key. | string |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string |
Sku
| Name | Description | Value |
|---|---|---|
| name | The name of the Azure Health Bot SKU | 'C0' 'C1' 'F0' 'PES' 'S1' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserAssignedIdentityMap
| 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@2025-05-25"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
userIdentity = "string"
}
}
sku = {
name = "string"
}
}
}
Property Values
Microsoft.HealthBot/healthBots
| Name | Description | Value |
|---|---|---|
| identity | The identity of the Azure Health Bot. | Identity |
| 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 Azure Health Bot resource. | HealthBotProperties |
| sku | SKU of the Azure Health Bot. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HealthBot/healthBots@2025-05-25" |
HealthBotProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | KeyVault properties for the resource encryption. | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
UserAssignedIdentityMap |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of the key vault key. | string (required) |
| keyVaultUri | The Uri of the key vault. | string (required) |
| keyVersion | The version of the key vault key. | string |
| userIdentity | The user assigned identity (ARM resource id) that has access to the key. | string |
Sku
| Name | Description | Value |
|---|---|---|
| name | The name of the Azure Health Bot SKU | 'C0' 'C1' 'F0' 'PES' 'S1' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
UserAssignedIdentityMap
| Name | Description | Value |
|---|