Microsoft Azure Bot Service is a platform developed by Microsoft that enables users to build, deploy, and manage intelligent bots that can interact with users across multiple channels. The service provides a comprehensive set of tools and resources for developers to create conversational bots that can be integrated with various messaging platforms, websites, and applications.
swagger: '2.0'
info:
title: Microsoft Azure Azure Bot Service
description: Azure Bot Service is a platform for creating smart conversational agents.
version: 2023-09-15-preview
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: impersonate your user account
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}
: put:
tags:
- Bot
description: >-
Creates a Bot Service. Bot Service is a resource group wide resource
type.
operationId: microsoftAzureBotsCreate
x-ms-examples:
Create Bot:
$ref: ./examples/CreateBot.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/Bot'
description: The parameters to provide for the created bot.
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
If resource is created successfully or already existed, the service
should return 200 (OK).
schema:
$ref: '#/definitions/Bot'
'201':
description: >-
If resource is created successfully, the service should return 201
(Created). Execution to continue asynchronously.
schema:
$ref: '#/definitions/Bot'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename
patch:
tags:
- Bot
description: Updates a Bot Service
operationId: microsoftAzureBotsUpdate
x-ms-examples:
Update Bot:
$ref: ./examples/UpdateBot.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- name: parameters
in: body
required: true
x-ms-client-flatten: true
schema:
$ref: '#/definitions/Bot'
description: The parameters to provide for the created bot.
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully.
schema:
$ref: '#/definitions/Bot'
'201':
description: >-
If resource is updated successfully, the service should return 201
(Created). Execution to continue asynchronously.
schema:
$ref: '#/definitions/Bot'
default:
description: >-
Error response describing why the operation failed. If the resource
group *or* resource does not exist, 404 (NotFound) should be
returned.
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename
delete:
tags:
- Bot
description: 'Deletes a Bot Service from the resource group. '
operationId: microsoftAzureBotsDelete
x-ms-examples:
Delete Bot:
$ref: ./examples/DeleteBot.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
A 200 (OK) should be returned if the object exists and was deleted
successfully;
'204':
description: >-
a 204 (NoContent) should be used if the resource does not exist and
the request is well formed.
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename
get:
tags:
- Bot
description: Returns a BotService specified by the parameters.
operationId: microsoftAzureBotsGet
x-ms-examples:
Get Bot:
$ref: ./examples/GetBot.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully.
schema:
$ref: '#/definitions/Bot'
default:
description: >-
Error response describing why the operation failed. If the resource
group *or* resource does not exist, 404 (NotFound) should be
returned.
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices:
get:
tags:
- Bot
description: >-
Returns all the resources of a particular type belonging to a resource
group
operationId: microsoftAzureBotsListbyresourcegroup
x-ms-examples:
List Bots by Resource Group:
$ref: ./examples/ListBotsByResourceGroup.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully. For other errors (e.g. internal
errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should
use to fetch the next page (per server side paging). This matches
the OData guidelines for paged responses here. If a resource
provider does not support paging, it should return the same body
(JSON object with “value” property) but omit nextLink entirely (or
set to null, *not* empty string) for future compatibility.
The nextLink should be implemented using following query parameters:
· skipToken: opaque token that allows the resource provider to skip
resources already enumerated. This value is defined and returned by
the RP after first request via nextLink.
· top: the optional client query parameter which defines the maximum
number of records to be returned by the server.
Implementation details:
· NextLink may include all the query parameters (specifically OData
$filter) used by the client in the first query.
· Server may return less records than requested with nextLink.
Returning zero records with NextLink is an acceptable response.
Clients must fetch records until the nextLink is not returned back /
null. Clients should never rely on number of returned records to
determinate if pagination is completed.
schema:
$ref: '#/definitions/BotResponseList'
default:
description: >-
Error response describing why the operation failed. If the resource
group does not exist, 404 (NotFound) will be returned.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices
/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices:
get:
tags:
- Bot
description: >-
Returns all the resources of a particular type belonging to a
subscription.
operationId: microsoftAzureBotsList
x-ms-examples:
List Bots by Subscription:
$ref: ./examples/ListBotsBySubscription.json
parameters:
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully. For other errors (e.g. internal
errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should
use to fetch the next page (per server side paging). This matches
the OData guidelines for paged responses. If a resource provider
does not support paging, it should return the same body but leave
nextLink empty for future compatibility.
For a detailed explanation of each field in the response body,
please refer to the request body description in the PUT resource
section.
schema:
$ref: '#/definitions/BotResponseList'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Botservice Botservices
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}
: put:
tags:
- Channel
description: Creates a Channel registration for a Bot Service
operationId: microsoftAzureChannelsCreate
x-ms-examples:
Create Channel:
$ref: ./examples/PutChannel.json
Create Alexa Channel:
$ref: ./examples/PutAlexaChannel.json
Create Email Channel:
$ref: ./examples/PutEmailChannel.json
Create Line Channel:
$ref: ./examples/PutLineChannel.json
Create DirectLine Speech Channel:
$ref: ./examples/PutDirectLineSpeechChannel.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/channelNameParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/BotChannel'
description: The parameters to provide for the created bot.
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
If resource is created successfully or already existed, the service
should return 200 (OK).
schema:
$ref: '#/definitions/BotChannel'
'201':
description: >-
If resource is created successfully, the service should return 201
(Created). Execution to continue asynchronously.
schema:
$ref: '#/definitions/BotChannel'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels Channelname
patch:
tags:
- Channel
description: Updates a Channel registration for a Bot Service
operationId: microsoftAzureChannelsUpdate
x-ms-examples:
Update Channel:
$ref: ./examples/UpdateChannel.json
Update Alexa Channel:
$ref: ./examples/UpdateAlexaChannel.json
Update Line Channel:
$ref: ./examples/UpdateLineChannel.json
Update DirectLine Speech Channel:
$ref: ./examples/UpdateDirectLineSpeechChannel.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/channelNameParameter'
- name: parameters
in: body
required: true
x-ms-client-flatten: true
schema:
$ref: '#/definitions/BotChannel'
description: The parameters to provide for the created bot.
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully.
schema:
$ref: '#/definitions/BotChannel'
'201':
description: >-
If resource is updated successfully, the service should return 201
(Created). Execution to continue asynchronously.
schema:
$ref: '#/definitions/BotChannel'
default:
description: >-
Error response describing why the operation failed. If the resource
group *or* resource does not exist, 404 (NotFound) should be
returned.
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels Channelname
delete:
tags:
- Channel
description: Deletes a Channel registration from a Bot Service
operationId: microsoftAzureChannelsDelete
x-ms-examples:
Delete Channel:
$ref: ./examples/DeleteChannel.json
Delete DirectLine Speech Channel:
$ref: ./examples/DeleteDirectLineSpeechChannel.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- name: channelName
in: path
required: true
type: string
maxLength: 64
minLength: 2
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
description: The name of the Bot resource.
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
A 200 (OK) should be returned if the object exists and was deleted
successfully;
'204':
description: >-
a 204 (NoContent) should be used if the resource does not exist and
the request is well formed.
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels Channelname
get:
tags:
- Channel
description: Returns a BotService Channel registration specified by the parameters.
operationId: microsoftAzureChannelsGet
x-ms-examples:
Get Channel:
$ref: ./examples/GetChannel.json
Get Alexa Channel:
$ref: ./examples/GetAlexaChannel.json
Get Line Channel:
$ref: ./examples/GetLineChannel.json
Get DirectLine Speech Channel:
$ref: ./examples/GetDirectLineSpeechChannel.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- name: channelName
in: path
required: true
type: string
maxLength: 64
minLength: 2
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
description: The name of the Bot resource.
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully.
schema:
$ref: '#/definitions/BotChannel'
default:
description: >-
Error response describing why the operation failed. If the resource
group *or* resource does not exist, 404 (NotFound) should be
returned.
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels Channelname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys
: post:
tags:
- Channel
description: Lists a Channel registration for a Bot Service including secrets
operationId: microsoftAzureChannelsListwithkeys
x-ms-examples:
List Channel:
$ref: ./examples/ListChannel.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/channelNameParameter'
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
If resource is retrieved successfully, the service should return 200
(OK).
schema:
$ref: '#/definitions/ListChannelWithKeysResponse'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels Channelname Listchannelwithkeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels
: get:
tags:
- Channel
description: >-
Returns all the Channel registrations of a particular BotService
resource
operationId: microsoftAzureChannelsListbyresourcegroup
x-ms-examples:
List Channels by Resource Group:
$ref: ./examples/ListChannelsByBotService.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully. For other errors (e.g. internal
errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should
use to fetch the next page (per server side paging). This matches
the OData guidelines for paged responses here. If a resource
provider does not support paging, it should return the same body
(JSON object with “value” property) but omit nextLink entirely (or
set to null, *not* empty string) for future compatibility.
The nextLink should be implemented using following query parameters:
· skipToken: opaque token that allows the resource provider to skip
resources already enumerated. This value is defined and returned by
the RP after first request via nextLink.
· top: the optional client query parameter which defines the maximum
number of records to be returned by the server.
Implementation details:
· NextLink may include all the query parameters (specifically OData
$filter) used by the client in the first query.
· Server may return less records than requested with nextLink.
Returning zero records with NextLink is an acceptable response.
Clients must fetch records until the nextLink is not returned back /
null. Clients should never rely on number of returned records to
determinate if pagination is completed.
schema:
$ref: '#/definitions/ChannelResponseList'
default:
description: >-
Error response describing why the operation failed. If the resource
group does not exist, 404 (NotFound) will be returned.
schema:
$ref: '#/definitions/Error'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys
: post:
tags:
- Channel
description: >-
Regenerates secret keys and returns them for the DirectLine Channel of a
particular BotService resource
operationId: microsoftAzureDirectlineRegeneratekeys
x-ms-examples:
Regenerate Keys for DirectLine Channel Site:
$ref: ./examples/DirectlineRegenerateKeys.json
Regenerate Keys for WebChat Channel Site:
$ref: ./examples/WebChatRegenerateKeys.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/regenerateKeyschannelNameParameter'
- $ref: '#/parameters/apiVersionParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/SiteInfo'
description: The parameters to provide for the created bot.
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully. For other errors (e.g. internal
errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should
use to fetch the next page (per server side paging). This matches
the OData guidelines for paged responses here. If a resource
provider does not support paging, it should return the same body
(JSON object with “value” property) but omit nextLink entirely (or
set to null, *not* empty string) for future compatibility.
The nextLink should be implemented using following query parameters:
· skipToken: opaque token that allows the resource provider to skip
resources already enumerated. This value is defined and returned by
the RP after first request via nextLink.
· top: the optional client query parameter which defines the maximum
number of records to be returned by the server.
Implementation details:
· NextLink may include all the query parameters (specifically OData
$filter) used by the client in the first query.
· Server may return less records than requested with nextLink.
Returning zero records with NextLink is an acceptable response.
Clients must fetch records until the nextLink is not returned back /
null. Clients should never rely on number of returned records to
determinate if pagination is completed.
schema:
$ref: '#/definitions/BotChannel'
default:
description: >-
Error response describing why the operation failed. If the resource
group does not exist, 404 (NotFound) will be returned.
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Channels Channelname Regeneratekeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/createEmailSignInUrl
: post:
tags:
- Channel
description: Creates an email channel sign in url for a Bot Service
operationId: microsoftAzureEmailCreatesigninurl
x-ms-examples:
Create Url:
$ref: ./examples/CreateEmailSignInUrl.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: If url is created successfully, the service should return 200 (OK).
schema:
$ref: '#/definitions/CreateEmailSignInUrlResponse'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Createemailsigninurl
/providers/Microsoft.BotService/checkNameAvailability:
post:
tags:
- Bot
description: Check whether a bot name is available.
operationId: microsoftAzureBotsGetchecknameavailability
x-ms-examples:
check Name Availability:
$ref: ./examples/CheckNameAvailability.json
parameters:
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/CheckNameAvailabilityRequestBody'
description: >-
The request body parameters to provide for the check name
availability request
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully. For other errors (e.g. internal
errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should
use to fetch the next page (per server side paging). This matches
the OData guidelines for paged responses. If a resource provider
does not support paging, it should return the same body but leave
nextLink empty for future compatibility.
For a detailed explanation of each field in the response body,
please refer to the request body description in the PUT resource
section.
schema:
$ref: '#/definitions/CheckNameAvailabilityResponseBody'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: Microsoft Azure Post Providers Microsoft Botservice Checknameavailability
/providers/Microsoft.BotService/operations:
get:
tags:
- Operations
description: Lists all the available BotService operations.
operationId: microsoftAzureOperationsList
x-ms-examples:
Get Operations:
$ref: ./examples/GetOperations.json
parameters:
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK.
schema:
$ref: '#/definitions/OperationEntityListResult'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
deprecated: false
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Botservice Operations
/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders:
post:
tags:
- ListServiceProviders
description: Lists the available Service Providers for creating Connection Settings
operationId: microsoftAzureBotconnectionListserviceproviders
x-ms-examples:
List Auth Service Providers:
$ref: ./examples/ListServiceProviders.json
parameters:
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
If resource is retrieved successfully, the service should return 200
(OK).
schema:
$ref: '#/definitions/ServiceProviderResponseList'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Botservice Listauthserviceproviders
/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listQnAMakerEndpointKeys:
post:
tags:
- ListQnAMakerEndpointKeys
description: Lists the QnA Maker endpoint keys
operationId: microsoftAzureQnamakerendpointkeysGet
x-ms-examples:
List QnAMaker Endpoint Keys:
$ref: ./examples/ListQnAMakerEndpointKeys.json
parameters:
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/QnAMakerEndpointKeysRequestBody'
description: >-
The request body parameters to provide for the check name
availability request
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
If resource is retrieved successfully, the service should return 200
(OK).
schema:
$ref: '#/definitions/QnAMakerEndpointKeysResponse'
default:
description: Error response describing why the operation failed
schema:
$ref: '#/definitions/Error'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Botservice Listqnamakerendpointkeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets
: post:
tags:
- BotConnection
x-ms-examples:
List Connection Setting With Secrets:
$ref: ./examples/GetConnection.json
description: Get a Connection Setting registration for a Bot Service
operationId: microsoftAzureBotconnectionListwithsecrets
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/resourceNameParameter'
- $ref: '#/parameters/connectionNameParameter'
- $ref: '#/parameters/apiVersionParameter'
- $ref: '#/parameters/subscriptionIdParameter'
responses:
'200':
description: >-
The resource provider should return 200 (OK) to indicate that the
operation completed successfully.
schema:
$ref: '#/definitions/ConnectionSetting'
default:
description: >-
Error response describing why the operation failed. If the resource
group *or* res
# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-bot-service-openapi-original.yml