Microsoft.BotService (preview:2017-12-01)

2025/09/05 • 21 new, 21 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
]
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
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. Current version is 2017-12-01 ,
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. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
,
}
,
]
,
}

⚐ 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

GET:  /providers/Microsoft.BotService/botServices/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. Current version is 2017-12-01 ,
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 ,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
,
]
,
}
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. Current version is 2017-12-01 ,
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: Display Name of the Service Provider ,
Required: False ,
}
string ,
devPortalUrl:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
iconUrl:
{
Description: Display Name of the Service Provider ,
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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
{
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 ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
{
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 ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
]
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
msaAppId:
{
Description: Microsoft App Id for the bot ,
Required: True ,
}
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
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 ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
channelName:
{
Description: The channel name ,
Required: True ,
}
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. Current version is 2017-12-01 ,
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. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
,
}
,
]
,
}

⚐ 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

GET:  /providers/Microsoft.BotService/botServices/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. Current version is 2017-12-01 ,
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 ,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
,
]
,
}
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. Current version is 2017-12-01 ,
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: Display Name of the Service Provider ,
Required: False ,
}
string ,
devPortalUrl:
{
Description: Display Name of the Service Provider ,
Required: False ,
}
string ,
iconUrl:
{
Description: Display Name of the Service Provider ,
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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
{
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 ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
{
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 ,
}
,
]
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The set of properties specific to bot channel resource ,
Required: False ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}

⚐ 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. Current version is 2017-12-01 ,
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. Current version is 2017-12-01 ,
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 ,
}
{
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 ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

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