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* resource does not exist, 404 (NotFound) should be returned. schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname Listwithsecrets ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName} : put: tags: - BotConnection description: Register a new Auth Connection for a Bot Service operationId: microsoftAzureBotconnectionCreate x-ms-examples: Create Connection Setting: $ref: ./examples/PutConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/connectionNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ConnectionSetting' description: The parameters to provide for creating the Connection Setting. - $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/ConnectionSetting' '201': description: >- If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously. schema: $ref: '#/definitions/ConnectionSetting' 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 Connections Connectionname patch: tags: - BotConnection description: Updates a Connection Setting registration for a Bot Service operationId: microsoftAzureBotconnectionUpdate x-ms-examples: Update Connection Setting: $ref: ./examples/UpdateConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/connectionNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ConnectionSetting' description: The parameters to provide for updating the Connection Setting. - $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/ConnectionSetting' '201': description: >- If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously. schema: $ref: '#/definitions/ConnectionSetting' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Connections Connectionname get: tags: - BotConnection x-ms-examples: Get Connection Setting: $ref: ./examples/GetConnection.json description: Get a Connection Setting registration for a Bot Service operationId: microsoftAzureBotconnectionGet 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* 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 Connections Connectionname delete: tags: - BotConnection description: Deletes a Connection Setting registration for a Bot Service operationId: microsoftAzureBotconnectionDelete x-ms-examples: Delete Connection Setting: $ref: ./examples/DeleteConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/connectionNameParameter' - $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 Connections Connectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections : get: tags: - BotConnection description: >- Returns all the Connection Settings registered to a particular BotService resource operationId: microsoftAzureBotconnectionListbybotservice x-ms-examples: List Connection Settings: $ref: ./examples/ListConnectionsByBotService.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/ConnectionSettingResponseList' 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 Connections /subscriptions/{subscriptionId}/providers/Microsoft.BotService/hostSettings: get: tags: - BotHostSettings description: >- Get per subscription settings needed to host bot in compute resource such as Azure App Service operationId: microsoftAzureHostsettingsGet x-ms-examples: Get Bot Host Settings: $ref: ./examples/GetHostSettings.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/HostSettingsResponse' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Botservice Hostsettings /subscriptions/{subscriptionId}/providers/Microsoft.BotService/operationresults/{operationResultId}: get: tags: - OperationResults description: Get the operation result for a long running operation. operationId: microsoftAzureOperationresultsGet x-ms-examples: Get operation result: $ref: ./examples/OperationResultsGet.json parameters: - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/operationResultIdParameter' responses: '200': description: The body contains all of the properties of the operation result. schema: $ref: '#/definitions/OperationResultsDescription' '202': description: >- Accepted - Get request accepted; the operation will complete asynchronously. default: description: Default error response x-ms-error-response: true schema: $ref: '#/definitions/Error' x-ms-long-running-operation: true summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Botservice Operationresults Operationresultid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsList description: List all the private endpoint connections associated with the Bot. x-ms-examples: List Private Endpoint Connections: $ref: ./examples/ListPrivateEndpointConnections.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' responses: '200': description: OK -- Successfully retrieved private endpoint connections. schema: $ref: >- ./privatelinks.json#/definitions/PrivateEndpointConnectionListResult default: description: Default error response x-ms-error-response: true schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsGet description: Gets the specified private endpoint connection associated with the Bot. x-ms-examples: Get Private Endpoint Connection: $ref: ./examples/GetPrivateEndpointConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: >- ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Get the private endpoint connection properties successfully. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections Privateendpointconnectionname put: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsCreate description: >- Update the state of specified private endpoint connection associated with the Bot. x-ms-examples: Put Private Endpoint Connection: $ref: ./examples/PutPrivateEndpointConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: >- ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName - name: properties in: body required: true schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection description: The private endpoint connection properties. responses: '200': description: >- OK -- Update the private endpoint connection properties successfully. schema: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections Privateendpointconnectionname delete: tags: - PrivateEndpointConnections operationId: microsoftAzurePrivateendpointconnectionsDelete description: >- Deletes the specified private endpoint connection associated with the Bot. x-ms-examples: Delete Private Endpoint Connection: $ref: ./examples/DeletePrivateEndpointConnection.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: >- ../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName responses: '200': description: OK -- Delete the private endpoint connection successfully. '204': description: No Content -- The private endpoint connection does not exist. default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privateendpointconnections Privateendpointconnectionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateLinkResources : get: tags: - PrivateLinkResources operationId: microsoftAzurePrivatelinkresourcesListbybotresource description: Gets the private link resources that need to be created for a Bot. x-ms-examples: List Private Link Resources: $ref: ./examples/ListPrivateLinkResources.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' - $ref: '#/parameters/subscriptionIdParameter' responses: '200': description: Successfully retrieved private link resources. schema: $ref: ./privatelinks.json#/definitions/PrivateLinkResourceListResult default: description: Default error response x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Privatelinkresources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName} : get: tags: - NetworkSecurityPerimeterConfigurations operationId: microsoftAzureNetworksecurityperimeterconfigurationsGet description: >- Gets the specified Network Security Perimeter configuration associated with the Bot. x-ms-examples: Get Network Security Perimeter Configuration: $ref: ./examples/GetNetworkSecurityPerimeterConfiguration.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: >- ./networksecurityperimeter.json#/parameters/NetworkSecurityPerimeterConfigurationNameParameter - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK -- Get the Network Security Perimeter configuration successfully. schema: $ref: >- ./networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Networksecurityperimeterconfigurations Networksecurityperimeterconfigurationname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/networkSecurityPerimeterConfigurations : get: tags: - NetworkSecurityPerimeterConfigurations operationId: microsoftAzureNetworksecurityperimeterconfigurationsList description: List Network Security Perimeter configurations associated with the Bot. x-ms-examples: List Network Security Perimeter Configurations: $ref: ./examples/ListNetworkSecurityPerimeterConfigurations.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: >- OK -- List the Network Security Perimeter configurations successfully. schema: $ref: >- ./networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationList default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: '#/definitions/Error' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Networksecurityperimeterconfigurations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile : post: tags: - NetworkSecurityPerimeterConfigurations operationId: microsoftAzureNetworksecurityperimeterconfigurationsReconcile description: >- Reconcile the specified Network Security Perimeter configuration associated with the Bot. x-ms-examples: Reconcile Network Security Perimeter Configuration: $ref: ./examples/ReconcileNetworkSecurityPerimeterConfiguration.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/resourceNameParameter' - $ref: >- ./networksecurityperimeter.json#/parameters/NetworkSecurityPerimeterConfigurationNameParameter - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Request to reconcile the configuration succeeded. schema: $ref: >- ./networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration '202': description: Request to reconcile the configuration accepted. headers: location: type: string default: description: Error response describing why the operation failed. x-ms-error-response: true schema: $ref: >- ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Botservice Botservices Resourcename Networksecurityperimeterconfigurations Networksecurityperimeterconfigurationname Reconcile definitions: Resource: description: Azure resource x-ms-azure-resource: true properties: id: description: Specifies the resource ID. type: string readOnly: true name: description: Specifies the name of the resource. type: string readOnly: true location: description: Specifies the location of the resource. type: string type: description: Specifies the type of the resource. type: string readOnly: true tags: description: Contains resource tags defined as key/value pairs. type: object additionalProperties: type: string sku: $ref: '#/definitions/Sku' description: Gets or sets the SKU of the resource. kind: $ref: '#/definitions/Kind' description: Required. Gets or sets the Kind of the resource. x-nullable: true etag: type: string description: Entity Tag. zones: type: array items: type: string description: Entity zones readOnly: true Sku: properties: name: $ref: '#/definitions/SkuName' description: The sku name tier: readOnly: true type: string description: Gets the sku tier. This is based on the SKU name. enum: - Free - Standard x-ms-enum: name: SkuTier modelAsString: true required: - name description: The SKU of the cognitive services account. SkuName: type: string description: The name of SKU. enum: - F0 - S1 x-ms-enum: name: SkuName modelAsString: true Kind: type: string description: Indicates the type of bot service enum: - sdk - designer - bot - function - azurebot x-ms-enum: name: Kind modelAsString: true x-ms-mutability: - create - read Bot: type: object description: Bot resource definition allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/BotProperties' description: The set of properties specific to bot resource BotProperties: properties: displayName: type: string description: The Name of the bot description: type: string description: The description of the bot iconUrl: type: string description: The Icon Url of the bot default: '' endpoint: type: string description: The bot's endpoint x-nullable: true endpointVersion: type: string readOnly: true description: The bot's endpoint version allSettings: description: Contains resource all settings defined as key/value pairs. type: object additionalProperties: type: string parameters: description: Contains resource parameters defined as key/value pairs. type: object additionalProperties: type: string manifestUrl: type: string description: The bot's manifest url msaAppType: type: string description: Microsoft App Type for the bot enum: - UserAssignedMSI - SingleTenant - MultiTenant x-ms-enum: name: msaAppType modelAsString: true msaAppId: type: string description: Microsoft App Id for the bot x-ms-mutability: - create - read msaAppTenantId: type: string description: Microsoft App Tenant Id for the bot x-ms-mutability: - create - read msaAppMSIResourceId: type: string description: Microsoft App Managed Identity Resource Id for the bot configuredChannels: type: array items: type: string readOnly: true description: Collection of channels for which the bot is configured enabledChannels: type: array items: type: string readOnly: true description: Collection of channels for which the bot is enabled developerAppInsightKey: type: string description: The Application Insights key developerAppInsightsApiKey: type: string description: The Application Insights Api Key developerAppInsightsApplicationId: type: string description: The Application Insights App Id luisAppIds: type: array items: type: string description: Collection of LUIS App Ids luisKey: type: string description: The LUIS Key isCmekEnabled: type: boolean description: Whether Cmek is enabled default: false cmekKeyVaultUrl: type: string description: The CMK Url cmekEncryptionStatus: type: string description: The CMK encryption status readOnly: true tenantId: type: string description: The Tenant Id for the bot x-ms-mutability: - create - read publicNetworkAccess: description: Whether the bot is in an isolated network enum: - Enabled - Disabled - SecuredByPerimeter type: string x-ms-enum: name: PublicNetworkAccess modelAsString: true default: Enabled isStreamingSupported: type: boolean description: Whether the bot is streaming supported default: false isDeveloperAppInsightsApiKeySet: type: boolean description: Whether the bot is developerAppInsightsApiKey set readOnly: true migrationToken: type: string description: Token used to migrate non Azure bot to azure subscription readOnly: true disableLocalAuth: type: boolean description: >- Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. schemaTransformationVersion: type: string description: The channel schema transformation version for the bot x-nullable: true default: storageResourceId: type: string description: The storage resourceId for the bot privateEndpointConnections: type: array readOnly: true description: List of Private Endpoint Connections configured for the bot items: $ref: ./privatelinks.json#/definitions/PrivateEndpointConnection networkSecurityPerimeterConfigurations: type: array readOnly: true description: List of Network Security Perimeter configurations for the bot items: $ref: >- ./networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration openWithHint: type: string description: >- The hint to browser (e.g. protocol handler) on how to open the bot for authoring appPasswordHint: type: string description: >- The hint (e.g. keyVault secret resourceId) on how to fetch the app secret provisioningState: type: string readOnly: true description: Provisioning state of the resource publishingCredentials: type: string description: Publishing credentials of the resource description: The parameters to provide for the Bot. required: - displayName - endpoint - msaAppId BotResponseList: properties: nextLink: description: The link used to get the next page of bot service resources. type: string value: readOnly: true type: array items: $ref: '#/definitions/Bot' description: Gets the list of bot service results and their properties. description: The list of bot service operation response. CreateEmailSignInUrlResponse: type: object description: The ARM create email sign in url operation response. properties: id: description: Specifies the resource ID. type: string readOnly: true location: description: Specifies the location of the resource. type: string properties: $ref: '#/definitions/CreateEmailSignInUrlResponseProperties' description: The set of properties specific to sign in url CreateEmailSignInUrlResponseProperties: type: object description: The set of properties specific to sign in url properties: url: description: Sign in url. type: string ListChannelWithKeysResponse: type: object description: The ARM channel of list channel with keys operation response. allOf: - $ref: '#/definitions/BotChannel' properties: resource: $ref: '#/definitions/Channel' description: The set of properties specific to bot channel resource setting: $ref: '#/definitions/ChannelSettings' description: Channel settings provisioningState: type: string description: Provisioning state of the resource entityTag: type: string description: Entity tag of the resource changedTime: type: string description: Changed time of the resource BotChannel: type: object description: Bot channel resource definition allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/Channel' description: The set of properties specific to bot channel resource ChannelSettings: type: object description: Channel settings definition properties: extensionKey1: type: string description: The extensionKey1 default: '' extensionKey2: type: string description: The extensionKey2 default: '' sites: type: array items: $ref: '#/definitions/Site' description: The list of sites channelId: type: string description: The channel id channelDisplayName: type: string description: The channel display name botId: type: string description: The bot id botIconUrl: type: string description: The bot icon url isEnabled: type: boolean description: Whether this channel is enabled for the bot disableLocalAuth: type: boolean description: >- Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. requireTermsAgreement: type: boolean description: Whether customer needs to agree to new terms. x-ms-nullable: true Channel: type: object description: Channel definition discriminator: channelName properties: channelName: type: string description: The channel name etag: type: string description: Entity Tag of the resource x-nullable: true x-ms-mutability: - create - read provisioningState: type: string readOnly: true description: Provisioning state of the resource location: description: Specifies the location of the resource. type: string default: global required: - channelName AlexaChannel: type: object x-ms-discriminator-value: AlexaChannel description: Alexa channel definition allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/AlexaChannelProperties' description: The set of properties specific to Alexa channel resource AlexaChannelProperties: properties: alexaSkillId: type: string description: The Alexa skill Id urlFragment: type: string readOnly: true description: Url fragment used in part of the Uri configured in Alexa serviceEndpointUri: type: string readOnly: true description: Full Uri used to configured the skill in Alexa isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Alexa channel. required: - alexaSkillId - isEnabled FacebookChannel: type: object description: Facebook channel definition x-ms-discriminator-value: FacebookChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/FacebookChannelProperties' description: The set of properties specific to bot facebook channel FacebookChannelProperties: properties: verifyToken: x-ms-secret: true type: string readOnly: true description: >- Verify token. Value only returned through POST to the action Channel List API, otherwise empty. pages: type: array items: $ref: '#/definitions/FacebookPage' description: The list of Facebook pages appId: type: string description: Facebook application id appSecret: x-ms-secret: true type: string description: >- Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty. callbackUrl: type: string readOnly: true description: Callback Url isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Facebook channel. required: - appId - isEnabled FacebookPage: properties: id: type: string description: Page id accessToken: x-ms-secret: true type: string description: >- Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty. description: A Facebook page for Facebook channel registration required: - id EmailChannel: type: object description: Email channel definition x-ms-discriminator-value: EmailChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/EmailChannelProperties' description: The set of properties specific to email channel resource EmailChannelProperties: properties: emailAddress: type: string description: The email address authMethod: $ref: '#/definitions/EmailChannelAuthMethod' description: Email channel auth method. 0 Password (Default); 1 Graph. password: type: string description: >- The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty. magicCode: type: string description: The magic code for setting up the modern authentication. isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Email channel. required: - emailAddress - isEnabled EmailChannelAuthMethod: type: number description: Email channel auth method. 0 Password (Default); 1 Graph. enum: - 0 - 1 x-ms-enum: name: EmailChannelAuthMethod modelAsString: false values: - value: 0 name: Password description: Basic authentication. - value: 1 name: Graph description: Modern authentication. OutlookChannel: type: object x-ms-discriminator-value: OutlookChannel description: Outlook channel definition allOf: - $ref: '#/definitions/Channel' MsTeamsChannel: type: object x-ms-discriminator-value: MsTeamsChannel description: Microsoft Teams channel definition allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/MsTeamsChannelProperties' description: The set of properties specific to Microsoft Teams channel resource MsTeamsChannelProperties: properties: enableCalling: type: boolean description: Enable calling for Microsoft Teams channel default: false callingWebhook: type: string description: Webhook for Microsoft Teams channel calls isEnabled: type: boolean description: Whether this channel is enabled for the bot incomingCallRoute: type: string description: Webhook for Microsoft Teams channel calls deploymentEnvironment: type: string description: Deployment environment for Microsoft Teams channel calls default: FallbackDeploymentEnvironment acceptedTerms: type: boolean description: Whether this channel accepted terms x-nullable: true default: description: The parameters to provide for the Microsoft Teams channel. required: - isEnabled SkypeChannel: type: object description: Skype channel definition x-ms-discriminator-value: SkypeChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/SkypeChannelProperties' description: The set of properties specific to Skype channel resource SkypeChannelProperties: properties: enableMessaging: type: boolean description: Enable messaging for Skype channel enableMediaCards: type: boolean description: Enable media cards for Skype channel enableVideo: type: boolean description: Enable video for Skype channel enableCalling: type: boolean description: Enable calling for Skype channel default: false enableScreenSharing: type: boolean description: Enable screen sharing for Skype channel enableGroups: type: boolean description: Enable groups for Skype channel groupsMode: type: string description: Group mode for Skype channel callingWebHook: type: string description: Calling web hook for Skype channel incomingCallRoute: type: string description: Incoming call route for Skype channel isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Microsoft Teams channel. required: - isEnabled KikChannel: type: object x-ms-discriminator-value: KikChannel description: Kik channel definition allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/KikChannelProperties' description: The set of properties specific to Kik channel resource KikChannelProperties: properties: userName: type: string description: The Kik user name apiKey: type: string description: >- Kik API key. Value only returned through POST to the action Channel List API, otherwise empty. isValidated: type: boolean description: Whether this channel is validated for the bot isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Kik channel. required: - userName - isEnabled WebChatChannel: type: object x-ms-discriminator-value: WebChatChannel description: Web Chat channel definition allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/WebChatChannelProperties' description: The set of properties specific to Web Chat channel resource WebChatChannelProperties: properties: webChatEmbedCode: type: string x-ms-mutability: - read readOnly: true description: Web chat control embed code sites: type: array items: $ref: '#/definitions/WebChatSite' description: The list of Web Chat sites description: The parameters to provide for the Web Chat channel. DirectLineChannel: type: object x-ms-discriminator-value: DirectLineChannel description: Direct Line channel definition allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/DirectLineChannelProperties' description: The set of properties specific to Direct Line channel resource DirectLineChannelProperties: properties: sites: type: array items: $ref: '#/definitions/DirectLineSite' description: The list of Direct Line sites extensionKey1: type: string description: The extensionKey1 default: '' extensionKey2: type: string description: The extensionKey2 default: '' DirectLineEmbedCode: type: string description: Direct Line embed code of the resource description: The parameters to provide for the Direct Line channel. TelegramChannel: type: object description: Telegram channel definition x-ms-discriminator-value: TelegramChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/TelegramChannelProperties' description: The set of properties specific to Telegram channel resource TelegramChannelProperties: properties: accessToken: x-ms-secret: true type: string description: >- The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty. isValidated: type: boolean description: Whether this channel is validated for the bot isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Telegram channel. required: - isEnabled SmsChannel: type: object description: Sms channel definition x-ms-discriminator-value: SmsChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/SmsChannelProperties' description: The set of properties specific to Sms channel resource SmsChannelProperties: properties: phone: type: string description: The Sms phone accountSID: type: string description: >- The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty. authToken: x-ms-secret: true type: string description: >- The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty. isValidated: type: boolean description: Whether this channel is validated for the bot isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Sms channel. required: - phone - accountSID - isEnabled SlackChannel: type: object description: Slack channel definition x-ms-discriminator-value: SlackChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/SlackChannelProperties' description: The set of properties specific to Slack channel resource SlackChannelProperties: properties: clientId: type: string description: The Slack client id clientSecret: x-ms-secret: true type: string description: >- The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty. verificationToken: x-ms-secret: true type: string description: >- The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty. scopes: type: string description: The Slack permission scopes. landingPageUrl: type: string description: The Slack landing page Url redirectAction: type: string description: The Slack redirect action readOnly: true lastSubmissionId: type: string description: The Sms auth token readOnly: true registerBeforeOAuthFlow: type: boolean description: >- Whether to register the settings before OAuth validation is performed. Recommended to True. IsValidated: type: boolean description: Whether this channel is validated for the bot readOnly: true signingSecret: x-ms-secret: true type: string description: The Slack signing secret. isEnabled: type: boolean description: Whether this channel is enabled for the bot description: The parameters to provide for the Slack channel. required: - isEnabled LineChannel: type: object description: Line channel definition x-ms-discriminator-value: LineChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/LineChannelProperties' description: The set of properties specific to line channel resource LineChannelProperties: properties: lineRegistrations: type: array description: The list of line channel registrations items: $ref: '#/definitions/LineRegistration' callbackUrl: type: string description: Callback Url to enter in line registration. readOnly: true isValidated: type: boolean description: Whether this channel is validated for the bot readOnly: true description: The parameters to provide for the Line channel. required: - lineRegistrations LineRegistration: properties: generatedId: x-ms-mutability: - read type: string description: Id generated for the line channel registration readOnly: true channelSecret: x-ms-secret: true type: string description: Secret for the line channel registration channelAccessToken: x-ms-secret: true type: string description: Access token for the line channel registration description: The properties corresponding to a line channel registration DirectLineSpeechChannel: type: object description: DirectLine Speech channel definition x-ms-discriminator-value: DirectLineSpeechChannel allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/DirectLineSpeechChannelProperties' description: The set of properties specific to DirectLine Speech channel resource DirectLineSpeechChannelProperties: properties: cognitiveServiceResourceId: type: string description: The cognitive service id with this channel registration. cognitiveServiceRegion: type: string description: The cognitive service region with this channel registration. x-nullable: true cognitiveServiceSubscriptionKey: x-ms-secret: true type: string description: >- The cognitive service subscription key to use with this channel registration. x-nullable: true isEnabled: type: boolean description: Whether this channel is enabled or not. customVoiceDeploymentId: type: string description: Custom speech model id (optional). customSpeechModelId: type: string description: Custom voice deployment id (optional). isDefaultBotForCogSvcAccount: type: boolean description: Make this a default bot for chosen cognitive service account. description: The parameters to provide for the DirectLine Speech channel. Omnichannel: type: object x-ms-discriminator-value: Omnichannel description: Omnichannel channel definition allOf: - $ref: '#/definitions/Channel' TelephonyChannel: type: object x-ms-discriminator-value: TelephonyChannel description: Telephony channel definition allOf: - $ref: '#/definitions/Channel' properties: properties: $ref: '#/definitions/TelephonyChannelProperties' description: The set of properties specific to Telephony channel resource TelephonyChannelProperties: type: object properties: phoneNumbers: type: array items: $ref: '#/definitions/TelephonyPhoneNumbers' description: The list of Telephony phone numbers apiConfigurations: type: array items: $ref: '#/definitions/TelephonyChannelResourceApiConfiguration' description: The list of Telephony api configuration cognitiveServiceSubscriptionKey: type: string description: The extensionKey1 x-nullable: true cognitiveServiceRegion: type: string description: The extensionKey2 x-nullable: true defaultLocale: type: string description: The default locale of the channel x-nullable: true premiumSKU: type: string description: The premium SKU applied to the channel x-nullable: true isEnabled: type: boolean description: Whether the channel is enabled description: The parameters to provide for the Direct Line channel. AcsChatChannel: type: object x-ms-discriminator-value: AcsChatChannel description: AcsChat channel definition allOf: - $ref: '#/definitions/Channel' SearchAssistant: type: object x-ms-discriminator-value: SearchAssistant description: SearchAssistant definition allOf: - $ref: '#/definitions/Channel' M365Extensions: type: object x-ms-discriminator-value: M365Extensions description: M365 Extensions definition allOf: - $ref: '#/definitions/Channel' ChannelResponseList: properties: nextLink: description: The link used to get the next page of bot service channel resources. type: string value: readOnly: true type: array items: $ref: '#/definitions/BotChannel' description: Gets the list of bot service channel results and their properties. description: The list of bot service channel operation response. WebChatSite: allOf: - $ref: '#/definitions/Site' required: - isWebchatPreviewEnabled description: A site for the Webchat channel DirectLineSite: allOf: - $ref: '#/definitions/Site' description: A site for the Direct Line channel required: - isV1Enabled - isV3Enabled Site: type: object properties: tenantId: type: string description: Tenant Id siteId: type: string description: Site Id x-ms-mutability: - read readOnly: true siteName: type: string description: Site name x-ms-mutability: - create - read key: type: string description: >- Primary key. Value only returned through POST to the action Channel List API, otherwise empty. x-ms-mutability: - read readOnly: true key2: type: string description: >- Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. x-ms-mutability: - read readOnly: true isEnabled: type: boolean description: Whether this site is enabled for DirectLine channel isTokenEnabled: type: boolean description: Whether this site is token enabled for channel readOnly: true isEndpointParametersEnabled: type: boolean description: Whether this site is EndpointParameters enabled for channel isDetailedLoggingEnabled: type: boolean description: Whether this site is disabled detailed logging for isBlockUserUploadEnabled: type: boolean description: Whether this site is enabled for block user upload. x-nullable: true default: isNoStorageEnabled: type: boolean description: Whether this no-storage site is disabled detailed logging for eTag: type: string description: Entity Tag appId: type: string description: DirectLine application id isV1Enabled: type: boolean description: Whether this site is enabled for Bot Framework V1 protocol. x-ms-mutability: - create - read isV3Enabled: type: boolean description: Whether this site is enabled for Bot Framework V3 protocol. isSecureSiteEnabled: type: boolean description: Whether this site is enabled for authentication with Bot Framework. trustedOrigins: type: array description: >- List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. items: type: string isWebChatSpeechEnabled: type: boolean description: Whether this site is enabled for Webchat Speech default: false isWebchatPreviewEnabled: type: boolean description: Whether this site is enabled for preview versions of Webchat default: false required: - isEnabled - siteName description: A site for the channel SiteInfo: properties: siteName: type: string description: The site name x-ms-mutability: - create - read key: type: string description: Determines which key is to be regenerated enum: - key1 - key2 x-ms-enum: name: key modelAsString: false description: >- Site information for WebChat or DirectLine Channels to identify which site to regenerate keys for. type: object required: - siteName - key TelephonyPhoneNumbers: type: object properties: id: type: string description: The element id. phoneNumber: type: string description: The phone number. acsEndpoint: type: string description: The endpoint of ACS. x-nullable: true acsSecret: type: string description: The secret of ACS. x-nullable: true acsResourceId: type: string description: The resource id of ACS. x-nullable: true cognitiveServiceSubscriptionKey: type: string description: The subscription key of cognitive service. x-nullable: true cognitiveServiceRegion: type: string description: The service region of cognitive service. x-nullable: true cognitiveServiceResourceId: type: string description: The resource id of cognitive service. x-nullable: true defaultLocale: type: string description: The default locale of the phone number. x-nullable: true offerType: type: string description: Optional Property that will determine the offering type of the phone. x-nullable: true description: A telephone number for the Telephony channel TelephonyChannelResourceApiConfiguration: type: object properties: id: type: string description: The id of config. providerName: type: string description: The provider name. x-nullable: true cognitiveServiceSubscriptionKey: type: string description: The cognitive service subscription key. x-nullable: true cognitiveServiceRegion: type: string description: The cognitive service region. x-nullable: true cognitiveServiceResourceId: type: string description: The cognitive service resourceId. x-nullable: true defaultLocale: type: string description: The default locale. x-nullable: true description: A resource Api configuration for the Telephony channel ConnectionItemName: properties: name: type: string description: Connection Item name that has been added in the API readOnly: true description: The display name of a connection Item Setting registered with the Bot ConnectionSettingParameter: properties: key: type: string description: Key for the Connection Setting Parameter. value: type: string description: Value associated with the Connection Setting Parameter. x-nullable: true description: >- Extra Parameter in a Connection Setting Properties to indicate service provider specific properties ConnectionSettingProperties: properties: id: type: string description: Id of the Connection Setting. name: type: string description: Name of the Connection Setting. clientId: type: string description: Client Id associated with the Connection Setting. settingId: type: string description: Setting Id set by the service for the Connection Setting. readOnly: true clientSecret: x-ms-secret: true type: string description: Client Secret associated with the Connection Setting scopes: type: string description: Scopes associated with the Connection Setting default: '' serviceProviderId: type: string description: Service Provider Id associated with the Connection Setting serviceProviderDisplayName: type: string description: Service Provider Display Name associated with the Connection Setting parameters: type: array description: Service Provider Parameters associated with the Connection Setting items: $ref: '#/definitions/ConnectionSettingParameter' provisioningState: type: string description: Provisioning state of the resource description: Properties for a Connection Setting Item ConnectionSetting: type: object description: Bot channel resource definition allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ConnectionSettingProperties' description: The set of properties specific to bot channel resource ConnectionSettingResponseList: properties: nextLink: description: >- The link used to get the next page of bot service connection setting resources. type: string value: readOnly: true type: array items: $ref: '#/definitions/ConnectionSetting' description: Gets the list of bot service connection settings and their properties. description: The list of bot service connection settings response. ServiceProviderResponseList: properties: nextLink: description: The link used to get the next page of bot service providers. type: string value: readOnly: true type: array items: $ref: '#/definitions/ServiceProvider' description: Gets the list of bot service providers and their properties. description: The list of bot service providers response. ServiceProviderParameter: properties: name: type: string description: Name of the Service Provider readOnly: true type: type: string description: Type of the Service Provider readOnly: true displayName: type: string description: Display Name of the Service Provider readOnly: true description: type: string description: Description of the Service Provider readOnly: true helpUrl: type: string description: Help Url for the Service Provider readOnly: true default: type: string description: Default Name for the Service Provider readOnly: true metadata: type: object description: Meta data for the Service Provider readOnly: true properties: constraints: description: the constraints of the bot meta data. type: object properties: required: description: Whether required the constraints of the bot meta data. type: boolean description: Extra Parameters specific to each Service Provider ServiceProviderProperties: properties: id: type: string description: Id for Service Provider readOnly: true displayName: type: string description: Display Name of the Service Provider readOnly: true serviceProviderName: type: string description: Name of the Service Provider readOnly: true devPortalUrl: type: string description: URL of Dev Portal readOnly: true iconUrl: type: string description: The URL of icon default: '' parameters: description: The list of parameters for the Service Provider type: array items: $ref: '#/definitions/ServiceProviderParameter' description: The Object used to describe a Service Provider supported by Bot Service ServiceProvider: type: object description: Service Provider Definition properties: properties: $ref: '#/definitions/ServiceProviderProperties' description: The Properties of a Service Provider Object Error: properties: error: $ref: '#/definitions/ErrorBody' description: The error body. description: Bot Service error object. ErrorBody: properties: code: type: string description: error code message: type: string description: error message description: Bot Service error body. required: - code - message OperationEntityListResult: description: The list of bot service operation response. type: object properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The list of operations. type: array items: $ref: '#/definitions/OperationEntity' OperationEntity: description: The operations supported by Bot Service Management. type: object properties: name: description: 'Operation name: {provider}/{resource}/{operation}.' type: string display: $ref: '#/definitions/OperationDisplayInfo' description: The operation supported by Bot Service Management. origin: description: The origin of the operation. type: string properties: description: Additional properties. type: object OperationDisplayInfo: description: The operation supported by Bot Service Management. type: object properties: description: description: The description of the operation. type: string operation: description: The action that users can perform, based on their permission level. type: string provider: description: 'Service provider: Microsoft Bot Service.' type: string resource: description: Resource on which the operation is performed. type: string CheckNameAvailabilityRequestBody: description: >- The request body for a request to Bot Service Management to check availability of a bot name. type: object properties: name: description: the name of the bot for which availability needs to be checked. type: string type: description: the type of the bot for which availability needs to be checked type: string CheckNameAvailabilityResponseBody: description: >- The response body returned for a request to Bot Service Management to check availability of a bot name. type: object properties: valid: description: indicates if the bot name is valid. type: boolean message: description: >- additional message from the bot management api showing why a bot name is not available type: string absCode: description: response code from ABS type: string x-ms-nullable: true HostSettingsResponse: description: >- The response body returned for a request to Bot Service Management to check per subscription hostSettings type: object properties: OAuthUrl: description: For in-conversation bot user authentication type: string ToBotFromChannelOpenIdMetadataUrl: description: For verifying incoming tokens from the channels type: string ToBotFromChannelTokenIssuer: description: For verifying incoming tokens from the channels type: string ToBotFromEmulatorOpenIdMetadataUrl: description: For verifying incoming tokens from bot emulator type: string ToChannelFromBotLoginUrl: description: For getting access token to channels from bot host type: string ToChannelFromBotOAuthScope: description: For getting access token to channels from bot host type: string ValidateAuthority: description: Per cloud OAuth setting on whether authority is validated type: boolean BotOpenIdMetadata: description: Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12 type: string QnAMakerEndpointKeysRequestBody: description: >- The request body for a request to Bot Service Management to list QnA Maker endpoint keys. type: object properties: hostname: description: the host name of the QnA Maker endpoint type: string authkey: description: Subscription key which provides access to this API. type: string QnAMakerEndpointKeysResponse: type: object description: Schema for EndpointKeys generate/refresh operations. properties: primaryEndpointKey: type: string description: Primary Access Key. secondaryEndpointKey: type: string description: Secondary Access Key. installedVersion: type: string description: Current version of runtime. lastStableVersion: type: string description: Latest version of runtime. OperationResultsDescription: description: >- The properties indicating the operation result of an operation on a service. type: object properties: id: description: The ID of the operation returned. readOnly: true type: string name: description: The name of the operation result. readOnly: true type: string status: description: The status of the operation being performed. enum: - Canceled - Succeeded - Failed - Requested - Running readOnly: true type: string x-ms-enum: name: OperationResultStatus modelAsString: true startTime: format: date-time description: The time that the operation was started. readOnly: true type: string parameters: resourceGroupNameParameter: name: resourceGroupName x-ms-parameter-location: method 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 group in the user subscription. resourceNameParameter: name: resourceName x-ms-parameter-location: method 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. subscriptionIdParameter: name: subscriptionId in: path description: Azure Subscription ID. required: true type: string apiVersionParameter: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. operationResultIdParameter: name: operationResultId in: path description: The ID of the operation result to get. required: true x-ms-parameter-location: method type: string connectionNameParameter: name: connectionName x-ms-parameter-location: method in: path required: true type: string maxLength: 64 minLength: 2 pattern: ^[a-zA-Z0-9][\sa-zA-Z0-9_.-]*$ description: The name of the Bot Service Connection Setting resource. channelNameParameter: name: channelName x-ms-parameter-location: method in: path required: true type: string enum: - AlexaChannel - FacebookChannel - EmailChannel - KikChannel - TelegramChannel - SlackChannel - MsTeamsChannel - SkypeChannel - WebChatChannel - DirectLineChannel - SmsChannel - LineChannel - DirectLineSpeechChannel - OutlookChannel - Omnichannel - TelephonyChannel - AcsChatChannel - SearchAssistant - M365Extensions x-ms-enum: name: channelName modelAsString: false values: - value: AlexaChannel - value: FacebookChannel - value: EmailChannel - value: KikChannel - value: TelegramChannel - value: SlackChannel - value: MsTeamsChannel - value: SkypeChannel - value: WebChatChannel - value: DirectLineChannel - value: SmsChannel - value: LineChannel - value: DirectLineSpeechChannel - value: OutlookChannel - value: Omnichannel - value: TelephonyChannel - value: AcsChatChannel - value: SearchAssistant - value: M365Extensions description: The name of the Channel resource. regenerateKeyschannelNameParameter: name: channelName x-ms-parameter-location: method in: path required: true type: string enum: - WebChatChannel - DirectLineChannel x-ms-enum: name: regenerateKeysChannelName modelAsString: false values: - value: WebChatChannel - value: DirectLineChannel description: The name of the Channel resource for which keys are to be regenerated. tags: - name: Bot - name: BotConnection - name: BotHostSettings - name: Channel - name: ListQnAMakerEndpointKeys - name: ListServiceProviders - name: NetworkSecurityPerimeterConfigurations - name: OperationResults - name: Operations - name: PrivateEndpointConnections - name: PrivateLinkResources