Microsoft.BotService (preview:2022-06-15)

2025/09/05 • 31 new, 31 deleted methods

Bots_Create (new)
Description :  Creates a Bot Service. Bot Service is a resource group wide resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Update (new)
Description :  Updates a Bot Service
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Delete (new)
Description :  Deletes a Bot Service from the resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Get (new)
Description :  Returns a BotService specified by the parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
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.BotService/botServices
{
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 bot service results and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_List (new)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 bot service results and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Create (new)
Description :  Creates a Channel registration for a Bot Service
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Update (new)
Description :  Updates a Channel registration for a Bot Service
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Delete (new)
Description :  Deletes a Channel registration from a Bot Service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Get (new)
Description :  Returns a BotService Channel registration specified by the parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_ListWithKeys (new)
Description :  Lists a Channel registration for a Bot Service including secrets
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resource:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
setting:
{
Description: Channel settings ,
Required: False ,
}
{
extensionKey1:
{
Description: The extensionKey1 ,
Required: False ,
}
string ,
extensionKey2:
{
Description: The extensionKey2 ,
Required: False ,
}
string ,
sites:
{
Description: The list of sites ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
siteId:
{
Description: Site Id ,
Required: False ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
key:
{
Description: Primary key. Value only returned through POST to the action Channel List API, otherwise empty. ,
Required: False ,
}
string ,
key2:
{
Description: Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Whether this site is enabled for DirectLine channel ,
Required: True ,
}
boolean ,
isTokenEnabled:
{
Description: Whether this site is token enabled for channel ,
Required: False ,
}
boolean ,
isEndpointParametersEnabled:
{
Description: Whether this site is EndpointParameters enabled for channel ,
Required: False ,
}
boolean ,
isDetailedLoggingEnabled:
{
Description: Whether this site is disabled detailed logging for ,
Required: False ,
}
boolean ,
isBlockUserUploadEnabled:
{
Description: Whether this site is enabled for block user upload. ,
Required: False ,
}
boolean ,
isNoStorageEnabled:
{
Description: Whether this no-storage site is disabled detailed logging for ,
Required: False ,
}
boolean ,
eTag:
{
Description: Entity Tag ,
Required: False ,
}
string ,
appId:
{
Description: DirectLine application id ,
Required: False ,
}
string ,
isV1Enabled:
{
Description: Whether this site is enabled for Bot Framework V1 protocol. ,
Required: False ,
}
boolean ,
isV3Enabled:
{
Description: Whether this site is enabled for Bot Framework V3 protocol. ,
Required: False ,
}
boolean ,
isSecureSiteEnabled:
{
Description: Whether this site is enabled for authentication with Bot Framework. ,
Required: False ,
}
boolean ,
trustedOrigins:
{
Description: List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. ,
Required: False ,
}
[
string ,
]
,
isWebChatSpeechEnabled:
{
Description: Whether this site is enabled for Webchat Speech ,
Required: False ,
}
boolean ,
isWebchatPreviewEnabled:
{
Description: Whether this site is enabled for preview versions of Webchat ,
Required: False ,
}
boolean ,
}
,
]
,
channelId:
{
Description: The channel id ,
Required: False ,
}
string ,
channelDisplayName:
{
Description: The channel display name ,
Required: False ,
}
string ,
botId:
{
Description: The bot id ,
Required: False ,
}
string ,
botIconUrl:
{
Description: The bot icon url ,
Required: False ,
}
string ,
isEnabled:
{
Description: Whether this channel is enabled for the bot ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
requireTermsAgreement:
{
Description: Whether customer needs to agree to new terms. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
entityTag:
{
Description: Entity tag of the resource ,
Required: False ,
}
string ,
changedTime:
{
Description: Changed time of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_ListByResourceGroup (new)
Description :  Returns all the Channel registrations of a particular BotService resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
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 channel resources. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service channel results and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
DirectLine_RegenerateKeys (new)
Description :  Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource for which keys are to be regenerated. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
siteName:
{
Description: The site name ,
Required: True ,
}
string ,
key:
{
Description: Determines which key is to be regenerated ,
Enum:
{
key1: No description available. ,
key2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Email_CreateSignInUrl (new)
Description :  Creates an email channel sign in url for a Bot Service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/createEmailSignInUrl
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of properties specific to sign in url ,
Required: False ,
}
{
url:
{
Description: Sign in url. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_GetCheckNameAvailability (new)
Description :  Check whether a bot name is available.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.BotService/checkNameAvailability
{
parameters:
{
Description: The request body parameters to provide for the check name availability request ,
Required: True ,
}
{
name:
{
Description: the name of the bot for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: the type of the bot for which availability needs to be checked ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
valid:
{
Description: indicates if the bot name is valid. ,
Required: False ,
}
boolean ,
message:
{
Description: additional message from the bot management api showing why a bot name is not available ,
Required: False ,
}
string ,
absCode:
{
Description: response code from ABS ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all the available BotService operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BotService/operations
{
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 operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Bot Service Management. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft Bot Service. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListServiceProviders (new)
Description :  Lists the available Service Providers for creating Connection Settings
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of bot service providers. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service providers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The Properties of a Service Provider Object ,
Required: False ,
}
{
id:
{
Description: Id for Service Provider ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
serviceProviderName:
{
Description: Name of the Service Provider ,
Required: False ,
}
string ,
devPortalUrl:
{
Description: URL of Dev Portal ,
Required: False ,
}
string ,
iconUrl:
{
Description: The URL of icon ,
Required: False ,
}
string ,
parameters:
{
Description: The list of parameters for the Service Provider ,
Required: False ,
}
[
{
name:
{
Description: Name of the Service Provider ,
Required: False ,
}
string ,
type:
{
Description: Type of the Service Provider ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
description:
{
Description: Description of the Service Provider ,
Required: False ,
}
string ,
helpUrl:
{
Description: Help Url for the Service Provider ,
Required: False ,
}
string ,
default:
{
Description: Default Name for the Service Provider ,
Required: False ,
}
string ,
metadata:
{
Description: Meta data for the Service Provider ,
Required: False ,
}
{
constraints:
{
Description: the constraints of the bot meta data. ,
Required: False ,
}
{
required:
{
Description: Whether required the constraints of the bot meta data. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
QnAMakerEndpointKeys_Get (new)
Description :  Lists the QnA Maker endpoint keys
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/listQnAMakerEndpointKeys
{
parameters:
{
Description: The request body parameters to provide for the check name availability request ,
Required: True ,
}
{
hostname:
{
Description: the host name of the QnA Maker endpoint ,
Required: False ,
}
string ,
authkey:
{
Description: Subscription key which provides access to this API. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListWithSecrets (new)
Description :  Get a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Create (new)
Description :  Register a new Auth Connection for a Bot Service
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for creating the Connection Setting. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Update (new)
Description :  Updates a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for updating the Connection Setting. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Get (new)
Description :  Get a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Delete (new)
Description :  Deletes a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListByBotService (new)
Description :  Returns all the Connection Settings registered to a particular BotService resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
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 connection setting resources. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service connection settings and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
HostSettings_Get (new)
Description :  Get per subscription settings needed to host bot in compute resource such as Azure App Service
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
OAuthUrl:
{
Description: For in-conversation bot user authentication ,
Required: False ,
}
string ,
ToBotFromChannelOpenIdMetadataUrl:
{
Description: For verifying incoming tokens from the channels ,
Required: False ,
}
string ,
ToBotFromChannelTokenIssuer:
{
Description: For verifying incoming tokens from the channels ,
Required: False ,
}
string ,
ToBotFromEmulatorOpenIdMetadataUrl:
{
Description: For verifying incoming tokens from bot emulator ,
Required: False ,
}
string ,
ToChannelFromBotLoginUrl:
{
Description: For getting access token to channels from bot host ,
Required: False ,
}
string ,
ToChannelFromBotOAuthScope:
{
Description: For getting access token to channels from bot host ,
Required: False ,
}
string ,
ValidateAuthority:
{
Description: Per cloud OAuth setting on whether authority is validated ,
Required: False ,
}
boolean ,
BotOpenIdMetadata:
{
Description: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
OperationResults_Get (new)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/operationresults/{operationResultId}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
operationResultId:
{
Description: The ID of the operation result to get. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the operation returned. ,
Required: False ,
}
string ,
name:
{
Description: The name of the operation result. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation being performed. ,
Enum:
{
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Requested: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The time that the operation was started. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List all the private endpoint connections associated with the Bot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Create (new)
Description :  Update the state of specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateLinkResources_ListByBotResource (new)
Description :  Gets the private link resources that need to be created for a Bot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Create (removed)
Description :  Creates a Bot Service. Bot Service is a resource group wide resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Update (removed)
Description :  Updates a Bot Service
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Delete (removed)
Description :  Deletes a Bot Service from the resource group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_Get (removed)
Description :  Returns a BotService specified by the parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_ListByResourceGroup (removed)
Description :  Returns all the resources of a particular type belonging to a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices
{
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 bot service results and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_List (removed)
Description :  Returns all the resources of a particular type belonging to a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
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 bot service results and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot resource ,
Required: False ,
}
{
displayName:
{
Description: The Name of the bot ,
Required: True ,
}
string ,
description:
{
Description: The description of the bot ,
Required: False ,
}
string ,
iconUrl:
{
Description: The Icon Url of the bot ,
Required: False ,
}
string ,
endpoint:
{
Description: The bot's endpoint ,
Required: True ,
}
string ,
endpointVersion:
{
Description: The bot's endpoint version ,
Required: False ,
}
string ,
allSettings:
{
Description: Contains resource all settings defined as key/value pairs. ,
Required: False ,
}
object ,
parameters:
{
Description: Contains resource parameters defined as key/value pairs. ,
Required: False ,
}
object ,
manifestUrl:
{
Description: The bot's manifest url ,
Required: False ,
}
string ,
msaAppType:
{
Description: Microsoft App Type for the bot ,
Enum:
{
UserAssignedMSI: No description available. ,
SingleTenant: No description available. ,
MultiTenant: No description available. ,
}
,
Required: False ,
}
enum ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
string ,
msaAppTenantId:
{
Description: Microsoft App Tenant Id for the bot ,
Required: False ,
}
string ,
msaAppMSIResourceId:
{
Description: Microsoft App Managed Identity Resource Id for the bot ,
Required: False ,
}
string ,
configuredChannels:
{
Description: Collection of channels for which the bot is configured ,
Required: False ,
}
[
string ,
]
,
enabledChannels:
{
Description: Collection of channels for which the bot is enabled ,
Required: False ,
}
[
string ,
]
,
developerAppInsightKey:
{
Description: The Application Insights key ,
Required: False ,
}
string ,
developerAppInsightsApiKey:
{
Description: The Application Insights Api Key ,
Required: False ,
}
string ,
developerAppInsightsApplicationId:
{
Description: The Application Insights App Id ,
Required: False ,
}
string ,
luisAppIds:
{
Description: Collection of LUIS App Ids ,
Required: False ,
}
[
string ,
]
,
luisKey:
{
Description: The LUIS Key ,
Required: False ,
}
string ,
isCmekEnabled:
{
Description: Whether Cmek is enabled ,
Required: False ,
}
boolean ,
cmekKeyVaultUrl:
{
Description: The CMK Url ,
Required: False ,
}
string ,
cmekEncryptionStatus:
{
Description: The CMK encryption status ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant Id for the bot ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Whether the bot is in an isolated network ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
isStreamingSupported:
{
Description: Whether the bot is streaming supported ,
Required: False ,
}
boolean ,
isDeveloperAppInsightsApiKeySet:
{
Description: Whether the bot is developerAppInsightsApiKey set ,
Required: False ,
}
boolean ,
migrationToken:
{
Description: Token used to migrate non Azure bot to azure subscription ,
Required: False ,
}
string ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
schemaTransformationVersion:
{
Description: The channel schema transformation version for the bot ,
Required: False ,
}
string ,
storageResourceId:
{
Description: The storage resourceId for the bot ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of Private Endpoint Connections configured for the bot ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
openWithHint:
{
Description: The hint to browser (e.g. protocol handler) on how to open the bot for authoring ,
Required: False ,
}
string ,
appPasswordHint:
{
Description: The hint (e.g. keyVault secret resourceId) on how to fetch the app secret ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
publishingCredentials:
{
Description: Publishing credentials of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Create (removed)
Description :  Creates a Channel registration for a Bot Service
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Update (removed)
Description :  Updates a Channel registration for a Bot Service
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Delete (removed)
Description :  Deletes a Channel registration from a Bot Service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_Get (removed)
Description :  Returns a BotService Channel registration specified by the parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_ListWithKeys (removed)
Description :  Lists a Channel registration for a Bot Service including secrets
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resource:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
setting:
{
Description: Channel settings ,
Required: False ,
}
{
extensionKey1:
{
Description: The extensionKey1 ,
Required: False ,
}
string ,
extensionKey2:
{
Description: The extensionKey2 ,
Required: False ,
}
string ,
sites:
{
Description: The list of sites ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
siteId:
{
Description: Site Id ,
Required: False ,
}
string ,
siteName:
{
Description: Site name ,
Required: True ,
}
string ,
key:
{
Description: Primary key. Value only returned through POST to the action Channel List API, otherwise empty. ,
Required: False ,
}
string ,
key2:
{
Description: Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Whether this site is enabled for DirectLine channel ,
Required: True ,
}
boolean ,
isTokenEnabled:
{
Description: Whether this site is token enabled for channel ,
Required: False ,
}
boolean ,
isEndpointParametersEnabled:
{
Description: Whether this site is EndpointParameters enabled for channel ,
Required: False ,
}
boolean ,
isDetailedLoggingEnabled:
{
Description: Whether this site is disabled detailed logging for ,
Required: False ,
}
boolean ,
isBlockUserUploadEnabled:
{
Description: Whether this site is enabled for block user upload. ,
Required: False ,
}
boolean ,
isNoStorageEnabled:
{
Description: Whether this no-storage site is disabled detailed logging for ,
Required: False ,
}
boolean ,
eTag:
{
Description: Entity Tag ,
Required: False ,
}
string ,
appId:
{
Description: DirectLine application id ,
Required: False ,
}
string ,
isV1Enabled:
{
Description: Whether this site is enabled for Bot Framework V1 protocol. ,
Required: False ,
}
boolean ,
isV3Enabled:
{
Description: Whether this site is enabled for Bot Framework V3 protocol. ,
Required: False ,
}
boolean ,
isSecureSiteEnabled:
{
Description: Whether this site is enabled for authentication with Bot Framework. ,
Required: False ,
}
boolean ,
trustedOrigins:
{
Description: List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. ,
Required: False ,
}
[
string ,
]
,
isWebChatSpeechEnabled:
{
Description: Whether this site is enabled for Webchat Speech ,
Required: False ,
}
boolean ,
isWebchatPreviewEnabled:
{
Description: Whether this site is enabled for preview versions of Webchat ,
Required: False ,
}
boolean ,
}
,
]
,
channelId:
{
Description: The channel id ,
Required: False ,
}
string ,
channelDisplayName:
{
Description: The channel display name ,
Required: False ,
}
string ,
botId:
{
Description: The bot id ,
Required: False ,
}
string ,
botIconUrl:
{
Description: The bot icon url ,
Required: False ,
}
string ,
isEnabled:
{
Description: Whether this channel is enabled for the bot ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. ,
Required: False ,
}
boolean ,
requireTermsAgreement:
{
Description: Whether customer needs to agree to new terms. ,
Required: False ,
}
boolean ,
}
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
entityTag:
{
Description: Entity tag of the resource ,
Required: False ,
}
string ,
changedTime:
{
Description: Changed time of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Channels_ListByResourceGroup (removed)
Description :  Returns all the Channel registrations of a particular BotService resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
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 channel resources. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service channel results and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
DirectLine_RegenerateKeys (removed)
Description :  Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
channelName:
{
Description: The name of the Channel resource for which keys are to be regenerated. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created bot. ,
Required: True ,
}
{
siteName:
{
Description: The site name ,
Required: True ,
}
string ,
key:
{
Description: Determines which key is to be regenerated ,
Enum:
{
key1: No description available. ,
key2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
string ,
etag:
{
Description: Entity Tag of the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Email_CreateSignInUrl (removed)
Description :  Creates an email channel sign in url for a Bot Service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/createEmailSignInUrl
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Specifies the resource ID. ,
Required: False ,
}
string ,
location:
{
Description: Specifies the location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of properties specific to sign in url ,
Required: False ,
}
{
url:
{
Description: Sign in url. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Bots_GetCheckNameAvailability (removed)
Description :  Check whether a bot name is available.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.BotService/checkNameAvailability
{
parameters:
{
Description: The request body parameters to provide for the check name availability request ,
Required: True ,
}
{
name:
{
Description: the name of the bot for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: the type of the bot for which availability needs to be checked ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
valid:
{
Description: indicates if the bot name is valid. ,
Required: False ,
}
boolean ,
message:
{
Description: additional message from the bot management api showing why a bot name is not available ,
Required: False ,
}
string ,
absCode:
{
Description: response code from ABS ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all the available BotService operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BotService/operations
{
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 operations. ,
Required: False ,
}
string ,
value:
{
Description: The list of operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Bot Service Management. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Microsoft Bot Service. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional properties. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListServiceProviders (removed)
Description :  Lists the available Service Providers for creating Connection Settings
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of bot service providers. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service providers and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The Properties of a Service Provider Object ,
Required: False ,
}
{
id:
{
Description: Id for Service Provider ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
serviceProviderName:
{
Description: Name of the Service Provider ,
Required: False ,
}
string ,
devPortalUrl:
{
Description: URL of Dev Portal ,
Required: False ,
}
string ,
iconUrl:
{
Description: The URL of icon ,
Required: False ,
}
string ,
parameters:
{
Description: The list of parameters for the Service Provider ,
Required: False ,
}
[
{
name:
{
Description: Name of the Service Provider ,
Required: False ,
}
string ,
type:
{
Description: Type of the Service Provider ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
description:
{
Description: Description of the Service Provider ,
Required: False ,
}
string ,
helpUrl:
{
Description: Help Url for the Service Provider ,
Required: False ,
}
string ,
default:
{
Description: Default Name for the Service Provider ,
Required: False ,
}
string ,
metadata:
{
Description: Meta data for the Service Provider ,
Required: False ,
}
{
constraints:
{
Description: the constraints of the bot meta data. ,
Required: False ,
}
{
required:
{
Description: Whether required the constraints of the bot meta data. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
QnAMakerEndpointKeys_Get (removed)
Description :  Lists the QnA Maker endpoint keys
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/listQnAMakerEndpointKeys
{
parameters:
{
Description: The request body parameters to provide for the check name availability request ,
Required: True ,
}
{
hostname:
{
Description: the host name of the QnA Maker endpoint ,
Required: False ,
}
string ,
authkey:
{
Description: Subscription key which provides access to this API. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListWithSecrets (removed)
Description :  Get a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Create (removed)
Description :  Register a new Auth Connection for a Bot Service
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for creating the Connection Setting. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Update (removed)
Description :  Updates a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for updating the Connection Setting. ,
Required: True ,
}
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Get (removed)
Description :  Get a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_Delete (removed)
Description :  Deletes a Connection Setting registration for a Bot Service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of the Bot Service Connection Setting resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
BotConnection_ListByBotService (removed)
Description :  Returns all the Connection Settings registered to a particular BotService resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the Bot resource. ,
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 connection setting resources. ,
Required: False ,
}
string ,
value:
{
Description: Gets the list of bot service connection settings and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
id:
{
Description: Id of the Connection Setting. ,
Required: False ,
}
string ,
name:
{
Description: Name of the Connection Setting. ,
Required: False ,
}
string ,
clientId:
{
Description: Client Id associated with the Connection Setting. ,
Required: False ,
}
string ,
settingId:
{
Description: Setting Id set by the service for the Connection Setting. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret associated with the Connection Setting ,
Required: False ,
}
string ,
scopes:
{
Description: Scopes associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderId:
{
Description: Service Provider Id associated with the Connection Setting ,
Required: False ,
}
string ,
serviceProviderDisplayName:
{
Description: Service Provider Display Name associated with the Connection Setting ,
Required: False ,
}
string ,
parameters:
{
Description: Service Provider Parameters associated with the Connection Setting ,
Required: False ,
}
[
{
key:
{
Description: Key for the Connection Setting Parameter. ,
Required: False ,
}
string ,
value:
{
Description: Value associated with the Connection Setting Parameter. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
HostSettings_Get (removed)
Description :  Get per subscription settings needed to host bot in compute resource such as Azure App Service
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
OAuthUrl:
{
Description: For in-conversation bot user authentication ,
Required: False ,
}
string ,
ToBotFromChannelOpenIdMetadataUrl:
{
Description: For verifying incoming tokens from the channels ,
Required: False ,
}
string ,
ToBotFromChannelTokenIssuer:
{
Description: For verifying incoming tokens from the channels ,
Required: False ,
}
string ,
ToBotFromEmulatorOpenIdMetadataUrl:
{
Description: For verifying incoming tokens from bot emulator ,
Required: False ,
}
string ,
ToChannelFromBotLoginUrl:
{
Description: For getting access token to channels from bot host ,
Required: False ,
}
string ,
ToChannelFromBotOAuthScope:
{
Description: For getting access token to channels from bot host ,
Required: False ,
}
string ,
ValidateAuthority:
{
Description: Per cloud OAuth setting on whether authority is validated ,
Required: False ,
}
boolean ,
BotOpenIdMetadata:
{
Description: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12 ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
OperationResults_Get (removed)
Description :  Get the operation result for a long running operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BotService/operationresults/{operationResultId}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
operationResultId:
{
Description: The ID of the operation result to get. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the operation returned. ,
Required: False ,
}
string ,
name:
{
Description: The name of the operation result. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation being performed. ,
Enum:
{
Canceled: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Requested: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The time that the operation was started. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  List all the private endpoint connections associated with the Bot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets the specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Create (removed)
Description :  Update the state of specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
groupIds:
{
Description: Group ids ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes the specified private endpoint connection associated with the Bot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}
PrivateLinkResources_ListByBotResource (removed)
Description :  Gets the private link resources that need to be created for a Bot.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the Bot resource group in the user subscription. ,
Required: True ,
}
string ,
resourceName:
{
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 ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error body. ,
Required: False ,
}
{
code:
{
Description: error code ,
Required: True ,
}
string ,
message:
{
Description: error message ,
Required: True ,
}
string ,
}
,
}