Microsoft.HealthBot healthBots
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@2023-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
userIdentity: 'string'
}
}
}
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 Azure Health Bot. | Sku (required) |
| identity | The identity of the Azure Health Bot. | Identity |
| properties | The set of properties specific to Azure Health Bot resource. | HealthBotProperties |
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}'. |
object |
HealthBotProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | KeyVault properties for the resource encryption. | KeyVaultProperties |
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' 'F0' 'PES' 'S1' (required) |
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": "2023-05-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string",
"userIdentity": "string"
}
}
}
Property values
healthBots
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.HealthBot/healthBots' |
| apiVersion | The resource api version | '2023-05-01' |
| 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 Azure Health Bot. | Sku (required) |
| identity | The identity of the Azure Health Bot. | Identity |
| properties | The set of properties specific to Azure Health Bot resource. | HealthBotProperties |
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}'. |
object |
HealthBotProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | KeyVault properties for the resource encryption. | KeyVaultProperties |
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' 'F0' 'PES' 'S1' (required) |
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@2023-05-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
userIdentity = "string"
}
}
sku = {
name = "string"
}
})
}
Property values
healthBots
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.HealthBot/healthBots@2023-05-01" |
| 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 Azure Health Bot. | Sku (required) |
| identity | The identity of the Azure Health Bot. | Identity |
| properties | The set of properties specific to Azure Health Bot resource. | HealthBotProperties |
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 | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| identity_ids | 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}'. |
Array of user identity IDs. |
HealthBotProperties
| Name | Description | Value |
|---|---|---|
| keyVaultProperties | KeyVault properties for the resource encryption. | KeyVaultProperties |
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" "F0" "PES" "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