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

2025/10/29 • 9 updated methods

Operations_List (updated)
Description :  Lists all the available Azure Health Bot operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Available operations of the service.",
        "old": "Available operations of the service"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "Collection of available operation details.",
            "old": "Collection of available operation details"
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": [
              {
                "#name": "properties",
                "Type": {
                  "new": "string",
                  "old": "object"
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "URL client should use to fetch the next page (per server side paging).\nIt's null for now, added for future use.",
            "old": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
          }
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.HealthBot/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of available operation details. ,
Required: True ,
}
[
{
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 ,
}
string ,
}
,
]
,
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 ,
}
string ,
}
,
]
,
}
,
}
Bots_List (updated)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The HealthBot items on this page",
            "old": "Gets the list of Azure Health Bot results and their properties."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "identity": [
                {
                  "#name": "userAssignedIdentities",
                  "Description": {
                    "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                    "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of bot service resources."
          }
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/healthBots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HealthBot items on this page ,
Required: True ,
}
[
{
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 ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
string ,
}
,
]
,
}
,
}
Bots_ListByResourceGroup (updated)
Description :  Returns all the resources of a particular type belonging to a resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The HealthBot items on this page",
            "old": "Gets the list of Azure Health Bot results and their properties."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "identity": [
                {
                  "#name": "userAssignedIdentities",
                  "Description": {
                    "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                    "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The link used to get the next page of bot service resources."
          }
        }
      ]
    },
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HealthBot items on this page ,
Required: True ,
}
[
{
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 ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
string ,
}
,
]
,
}
,
}
Bots_Get (updated)
Description :  Get a HealthBot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
            }
          }
        ]
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
}
,
}

⚐ 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 ,
}
string ,
}
,
]
,
}
,
}
Bots_Create (updated)
Description :  Create a new Azure Health Bot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Create",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
            }
          }
        ]
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
{
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 ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Azure Health Bot resource definition ,
}
{
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 ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
string ,
}
,
]
,
}
,
}
Bots_Update (updated)
Description :  Patch a HealthBot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    },
    {
      "parameters": {
        "$properties": {
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n"
            }
          }
        ]
      }
    },
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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 ,
}
,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Azure Health Bot resource definition ,
}
{
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 ,
}
,
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 ,
}
,
}
,
}

⚐ 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 ,
}
string ,
}
,
]
,
}
,
}
Bots_Delete (updated)
Description :  Delete a HealthBot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ 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 ,
}
string ,
}
,
]
,
}
,
}
Bots_ListSecrets (updated)
Description :  List all secrets of a HealthBot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_ListSecrets",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}/listSecrets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
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. ,
Format: password ,
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 ,
}
string ,
}
,
]
,
}
,
}
Bots_RegenerateApiJwtSecret (updated)
Description :  Regenerate the API JWT Secret of a HealthBot.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Bots_RegenerateApiJwtSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "Azure Subscription ID."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the Bot resource group in the user subscription."
      }
    }
  ],
  "$responses": {
    "default": {
      "$properties": {
        "error": [
          {
            "additionalInfo": {
              "$properties": [
                {
                  "#name": "info",
                  "Type": {
                    "new": "string",
                    "old": "object"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots/{botName}/regenerateApiJwtSecret
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
botName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
value:
{
Description: The value of the key. ,
Format: password ,
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 ,
}
string ,
}
,
]
,
}
,
}