Microsoft.HealthBot (stable:2025-05-25)

2025/06/09 • 9 new methods

Bots_Create (new)
Description :  Create a new Azure Health Bot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created Azure Health Bot. ,
Required: True ,
}
{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_Get (new)
Description :  Get a HealthBot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_Update (new)
Description :  Patch a HealthBot.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the required Azure Health Bot. ,
Required: True ,
}
{
properties:
{
Description: Properties of Azure Health Bot. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for a Azure Health Bot. ,
Required: False ,
}
object ,
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: False ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
location:
{
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_Delete (new)
Description :  Delete a HealthBot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_ListSecrets (new)
Description :  List all secrets of a HealthBot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}/listSecrets
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
secrets:
{
Description: Array of Azure Health Bot Secrets. ,
Required: False ,
}
[
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_RegenerateApiJwtSecret (new)
Description :  Regenerate the API JWT Secret of a HealthBot.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}/regenerateApiJwtSecret
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_ListByResourceGroup (new)
Description :  Returns all the resources of a particular type belonging to a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of bot service resources. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Azure Health Bot results and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Bots_List (new)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/healthBots
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of bot service resources. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of Azure Health Bot results and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: SKU of the Azure Health Bot. ,
Required: True ,
}
{
name:
{
Description: The name of the Azure Health Bot SKU ,
Enum:
{
F0: No description available. ,
S1: No description available. ,
C0: No description available. ,
PES: No description available. ,
C1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The identity of the Azure Health Bot. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: 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 ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The set of properties specific to Azure Health Bot resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the Azure Health Bot resource. ,
Required: False ,
}
string ,
botManagementPortalLink:
{
Description: The link. ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: KeyVault properties for the resource encryption. ,
Required: False ,
}
{
keyName:
{
Description: The name of the key vault key. ,
Required: True ,
}
string ,
keyVersion:
{
Description: The version of the key vault key. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of the key vault. ,
Required: True ,
}
string ,
userIdentity:
{
Description: The user assigned identity (ARM resource id) that has access to the key. ,
Required: False ,
}
string ,
}
,
accessControlMethod:
{
Description: The access control method for the Azure Health Bot resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all the available Azure Health Bot operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HealthBot/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display of the operation ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation ,
Required: False ,
}
string ,
resource:
{
Description: Resource of the operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}