openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 74.2 kB
JSON
{"openapi":"3.0.0","info":{"description":"Azure Bot Service is a platform for creating smart conversational agents.","title":"Azure Bot Service","version":"2018-07-12","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/botservice.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"botservice","x-tags":["Azure","Microsoft"]},"paths":{"/providers/Microsoft.BotService/checkEnterpriseChannelNameAvailability":{"post":{"description":"Check whether an Enterprise Channel name is available.","operationId":"EnterpriseChannels_CheckNameAvailability","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannelCheckNameAvailabilityRequest"}}},"description":"The parameters to provide for the Enterprise Channel check name availability request.","required":true},"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.\nThe 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.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannelCheckNameAvailabilityResponse"},"examples":{"Check Enterprise Channel Name Availability":{"$ref":"#/components/examples/Check_Enterprise_Channel_Name_Availability"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Enterprise Channel"]}},"/providers/Microsoft.BotService/checkNameAvailability":{"post":{"description":"Check whether a bot name is available.","operationId":"Bots_GetCheckNameAvailability","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityRequestBody"}}},"description":"The request body parameters to provide for the check name availability request","required":true},"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.\nThe 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.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityResponseBody"},"examples":{"check Name Availability":{"$ref":"#/components/examples/check_Name_Availability"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"]}},"/providers/Microsoft.BotService/operations":{"get":{"deprecated":false,"description":"Lists all the available BotService operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationEntityListResult"},"examples":{"Get Operations":{"$ref":"#/components/examples/Get_Operations"}}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices":{"get":{"description":"Returns all the resources of a particular type belonging to a subscription.","operationId":"Bots_List","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/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.\nThe 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.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotResponseList"},"examples":{"List Bots by Subscription":{"$ref":"#/components/examples/List_Bots_by_Subscription"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders":{"post":{"description":"Lists the available Service Providers for creating Connection Settings","operationId":"BotConnection_ListServiceProviders","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"If resource is retrieved successfully, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProviderResponseList"},"examples":{"List Auth Service Providers":{"$ref":"#/components/examples/List_Auth_Service_Providers"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["ListServiceProviders"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices":{"get":{"description":"Returns all the resources of a particular type belonging to a resource group","operationId":"Bots_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/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.\nThe 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.\nThe nextLink should be implemented using following query parameters:\n· 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.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients 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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotResponseList"},"examples":{"List Bots by Resource Group":{"$ref":"#/components/examples/List_Bots_by_Resource_Group"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}":{"delete":{"description":"Deletes a Bot Service from the resource group. ","operationId":"Bots_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"]},"get":{"description":"Returns a BotService specified by the parameters.","operationId":"Bots_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"},"examples":{"Get Bot":{"$ref":"#/components/examples/Get_Bot"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"]},"patch":{"description":"Updates a Bot Service","operationId":"Bots_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}},"description":"The parameters to provide for the created bot.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"},"examples":{"Update Bot":{"$ref":"#/components/examples/Update_Bot"}}}}},"201":{"description":"If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"},"examples":{"Update Bot":{"$ref":"#/components/examples/Update_Bot"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"]},"put":{"description":"Creates a Bot Service. Bot Service is a resource group wide resource type.","operationId":"Bots_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"}}},"description":"The parameters to provide for the created bot.","required":true},"responses":{"200":{"description":"If resource is created successfully or already existed, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"},"examples":{"Create Bot":{"$ref":"#/components/examples/Create_Bot"}}}}},"201":{"description":"If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bot"},"examples":{"Create Bot":{"$ref":"#/components/examples/Create_Bot"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Bot"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}":{"delete":{"description":"Deletes a Connection Setting registration for a Bot Service","operationId":"BotConnection_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/connectionNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["BotConnection"]},"get":{"description":"Get a Connection Setting registration for a Bot Service","operationId":"BotConnection_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/connectionNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"},"examples":{"Update Connection Setting":{"$ref":"#/components/examples/Update_Connection_Setting"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["BotConnection"]},"patch":{"description":"Updates a Connection Setting registration for a Bot Service","operationId":"BotConnection_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/connectionNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"}}},"description":"The parameters to provide for updating the Connection Setting.","required":true},"responses":{"200":{"description":"If resource is created successfully or already existed, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"},"examples":{"Update Connection Setting":{"$ref":"#/components/examples/Update_Connection_Setting"}}}}},"201":{"description":"If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"},"examples":{"Update Connection Setting":{"$ref":"#/components/examples/Update_Connection_Setting"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["BotConnection"]},"put":{"description":"Register a new Auth Connection for a Bot Service","operationId":"BotConnection_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/connectionNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"}}},"description":"The parameters to provide for creating the Connection Setting.","required":true},"responses":{"200":{"description":"If resource is created successfully or already existed, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"},"examples":{"Create Connection Setting":{"$ref":"#/components/examples/Create_Connection_Setting"}}}}},"201":{"description":"If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"},"examples":{"Create Connection Setting":{"$ref":"#/components/examples/Create_Connection_Setting"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["BotConnection"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}/listWithSecrets":{"post":{"description":"Get a Connection Setting registration for a Bot Service","operationId":"BotConnection_ListWithSecrets","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/connectionNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSetting"},"examples":{"Update Connection Setting":{"$ref":"#/components/examples/Update_Connection_Setting"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["BotConnection"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels":{"get":{"description":"Returns all the Channel registrations of a particular BotService resource","operationId":"Channels_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/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.\nThe 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.\nThe nextLink should be implemented using following query parameters:\n· 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.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients 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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelResponseList"},"examples":{"List Bots by Resource Group":{"$ref":"#/components/examples/List_Bots_by_Resource_Group"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Channel"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}":{"delete":{"description":"Deletes a Channel registration from a Bot Service","operationId":"Channels_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"description":"The name of the Bot resource.","in":"path","name":"channelName","required":true,"schema":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"examples":{"Delete Bot":{"value":"EmailChannel"}}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Channel"]},"get":{"description":"Returns a BotService Channel registration specified by the parameters.","operationId":"Channels_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"description":"The name of the Bot resource.","in":"path","name":"channelName","required":true,"schema":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"examples":{"Get Bot":{"value":"EmailChannel"}}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"},"examples":{"Get Bot":{"$ref":"#/components/examples/Get_Bot"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Channel"]},"patch":{"description":"Updates a Channel registration for a Bot Service","operationId":"Channels_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/channelNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"}}},"description":"The parameters to provide for the created bot.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"},"examples":{"Update Bot":{"$ref":"#/components/examples/Update_Bot"}}}}},"201":{"description":"If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"},"examples":{"Update Bot":{"$ref":"#/components/examples/Update_Bot"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Channel"]},"put":{"description":"Creates a Channel registration for a Bot Service","operationId":"Channels_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/channelNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"}}},"description":"The parameters to provide for the created bot.","required":true},"responses":{"200":{"description":"If resource is created successfully or already existed, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"},"examples":{"Create Bot":{"$ref":"#/components/examples/Create_Bot"}}}}},"201":{"description":"If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"},"examples":{"Create Bot":{"$ref":"#/components/examples/Create_Bot"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Channel"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys":{"post":{"description":"Lists a Channel registration for a Bot Service including secrets","operationId":"Channels_ListWithKeys","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/channelNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"If resource is retrieved successfully, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotChannel"},"examples":{"List Channel":{"$ref":"#/components/examples/List_Channel"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Channel"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections":{"get":{"description":"Returns all the Connection Settings registered to a particular BotService resource","operationId":"BotConnection_ListByBotService","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/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.\nThe 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.\nThe nextLink should be implemented using following query parameters:\n· 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.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients 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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSettingResponseList"},"examples":{"List Connection Settings":{"$ref":"#/components/examples/List_Connection_Settings"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["BotConnection"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/enterpriseChannels":{"get":{"description":"Returns all the resources of a particular type belonging to a resource group.","operationId":"EnterpriseChannels_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/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.\nThe 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.\nThe nextLink should be implemented using following query parameters:\n· 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.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients 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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannelResponseList"},"examples":{"List Enterprise Channels by Resource Group":{"$ref":"#/components/examples/List_Enterprise_Channels_by_Resource_Group"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Enterprise Channel"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/enterpriseChannels/{resourceName}":{"delete":{"description":"Deletes an Enterprise Channel from the resource group","operationId":"EnterpriseChannels_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Enterprise Channel"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}},"get":{"description":"Returns an Enterprise Channel specified by the parameters.","operationId":"EnterpriseChannels_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"responses":{"200":{"description":"The resource provider should return 200 (OK) to indicate that the operation completed successfully. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"},"examples":{"Get Enterprise Channel":{"$ref":"#/components/examples/Get_Enterprise_Channel"}}}}},"default":{"description":"Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Enterprise Channel"]},"patch":{"description":"Updates an Enterprise Channel.","operationId":"EnterpriseChannels_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"}}},"description":"The parameters to provide to update the Enterprise Channel.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"If resource is created successfully or already existed, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"},"examples":{"Update Enterprise Channel":{"$ref":"#/components/examples/Update_Enterprise_Channel"}}}}},"201":{"description":"If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"},"examples":{"Update Enterprise Channel":{"$ref":"#/components/examples/Update_Enterprise_Channel"}}}}},"default":{"description":"Error response describing why the operation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Enterprise Channel"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}},"put":{"description":"Creates an Enterprise Channel.","operationId":"EnterpriseChannels_Create","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"}}},"description":"The parameters to provide for the new Enterprise Channel.","required":true},"responses":{"200":{"description":"If resource is created successfully or already existed, the service should return 200 (OK).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"},"examples":{"Create Enterprise Channel":{"$ref":"#/components/examples/Create_Enterprise_Channel"}}}}},"201":{"description":"If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnterpriseChannel"},"examples":{"Create Enterprise Channel":{"$ref":"#/components/examples/Create_Enterprise_Channel"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["Enterprise Channel"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Check_Enterprise_Channel_Name_Availability":{"value":{"message":"custom message from server","valid":true}},"check_Name_Availability":{"value":{"message":"custom message from server","valid":true}},"Get_Operations":{"value":{"value":[{"display":{"description":"Read Bot Service","operation":"Read Bot Service","provider":"Microsoft Bot Service","resource":"Bot Service"},"name":"Microsoft.BotService/botService/read","origin":"user,system"},{"display":{"description":"Writes Bot Service","operation":"Write Bot Service","provider":"Microsoft Bot Service","resource":"Bot Service"},"name":"Microsoft.BotService/botService/write","origin":"user,system"},{"display":{"description":"Deletes Bot Service","operation":"Delete Bot Service","provider":"Microsoft Bot Service","resource":"Bot Service"},"name":"Microsoft.BotService/botService/delete","origin":"user,system"},{"display":{"description":"Check bot name availability","operation":"Check bot name availability","provider":"Microsoft Bot Service","resource":"Bot Service name availability"},"name":"Microsoft.BotService/botService/botName/read","origin":"user,system"}]}},"List_Bots_by_Subscription":{"value":{"value":[{"etag":"etag1","id":"someid","kind":"sdk","location":"West US","name":"samplename","properties":{"configuredChannels":["facebook","groupme"],"description":"The description of the bot","developerAppInsightKey":"appinsightskey","developerAppInsightsApplicationId":"appinsightsappid","displayName":"The Name of the bot","enabledChannels":["facebook"],"endpoint":"http://mybot.coffee","endpointVersion":"version","iconUrl":"http://myicon","luisAppIds":["luisappid1","luisappid2"],"msaAppId":"msaappid"},"tags":{"tag1":"value1","tag2":"value2"},"type":"sampletype"}]}},"List_Auth_Service_Providers":{"value":{"value":[{"properties":{"devPortalUrl":"sampleDevPortalUrl","displayName":"sample display name","iconUrl":"sampleIconUrl","id":"sampleId","parameters":[{"default":"sampleDefaultValue","description":"sampleDescription","displayName":"sampleDisplayName","helpUrl":"sampleHelpUrl","name":"sampleParameterName","type":"sampleParameterType"}],"serviceProviderName":"sampleServiceProvider"}}]}},"List_Bots_by_Resource_Group":{"value":{"value":[{"location":"global","properties":{"channelName":"EmailChannel","properties":{"emailAddress":"a@b.com","isEnabled":true,"password":"pwd"}}},{"location":"global","properties":{"channelName":"FacebookChannel","properties":{"appId":"id","appSecret":"secret","callbackUrl":"appid","isEnabled":true,"pages":[{"accessToken":"token","id":"id"}],"verifyToken":"othertoken"}}}]}},"Get_Bot":{"value":{"location":"global","properties":{"channelName":"EmailChannel","properties":{"emailAddress":"a@b.com","isEnabled":true,"password":"pwd"}}}},"Update_Bot":{"value":{"location":"global","properties":{"channelName":"EmailChannel","properties":{"emailAddress":"a@b.com","isEnabled":true,"password":"pwd"}}}},"Create_Bot":{"value":{"location":"global","properties":{"channelName":"EmailChannel","properties":{"emailAddress":"a@b.com","isEnabled":true,"password":"pwd"}}}},"Update_Connection_Setting":{"value":{"etag":"etag1","id":"someid","location":"global","name":"The Name of the Connection Setting","properties":{"clientId":"sampleclientid","clientSecret":"samplesecret","parameters":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}],"scopes":"samplescope","serviceProviderDisplayName":"serviceProviderDisplayName","serviceProviderId":"serviceproviderid"}}},"Create_Connection_Setting":{"value":{"etag":"etag1","id":"someid","location":"global","name":"The Name of the Connection Setting","properties":{"clientId":"sampleclientid","clientSecret":"samplesecret","parameters":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}],"scopes":"samplescope","serviceProviderDisplayName":"serviceProviderDisplayName","serviceProviderId":"serviceproviderid"}}},"List_Channel":{"value":{"location":"global","properties":{"channelName":"EmailChannel","properties":{"emailAddress":"a@b.com","isEnabled":true,"password":"pwd"}}}},"List_Connection_Settings":{"value":{"value":[{"name":"The Name of the Connection Setting","properties":{"clientId":"sampleclientid","clientSecret":"samplesecret","parameters":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}],"scopes":"samplescope","serviceProviderId":"serviceproviderid"}}]}},"List_Enterprise_Channels_by_Resource_Group":{"value":{"value":[{"etag":"etag1","id":"someid","location":"West US","properties":{"nodes":[{"azureLocation":"WestUs","azureSku":"Int1","id":"00000000-0000-0000-0000-000000000000","name":"Node 1","state":"Creating"},{"azureLocation":"EastUs","azureSku":"Int1","id":"00000000-0000-0000-0000-000000000001","name":"Node 2","state":"Creating"}],"state":"Creating"},"tags":{"tag1":"value1","tag2":"value2"}}]}},"Get_Enterprise_Channel":{"value":{"etag":"etag1","id":"contoso-dl","location":"West US","properties":{"nodes":[{"azureLocation":"WestUs","azureSku":"Int1","id":"00000000-0000-0000-0000-000000000000","name":"Node 1","state":"Stopping"},{"azureLocation":"EastUs","azureSku":"Int1","id":"00000000-0000-0000-0000-000000000001","name":"Node 2","state":"Started"}],"state":"Started"},"tags":{"tag1":"value1","tag2":"value2"}}},"Update_Enterprise_Channel":{"value":{"id":"someid","location":"West US","properties":{"nodes":[{"azureLocation":"WestUs","azureSku":"Int1","id":"00000000-0000-0000-0000-000000000000","name":"Node 1","state":"Stopping"}],"state":"Stopping"},"tags":{"tag1":"value1","tag2":"value2"}}},"Create_Enterprise_Channel":{"value":{"id":"someid","location":"West US","properties":{"nodes":[{"azureLocation":"WestUs","azureSku":"Int1","id":"00000000-0000-0000-0000-000000000000","name":"Node 1","state":"Creating"}],"state":"Creating"},"tags":{"tag1":"value1","tag2":"value2"}}}},"parameters":{"apiVersionParameter":{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Check Enterprise Channel Name Availability":{"value":"2018-07-12"},"check Name Availability":{"value":"2018-07-12"},"Get Operations":{"value":"2017-04-18"},"List Bots by Subscription":{"value":"2017-01-01"},"List Auth Service Providers":{"value":"2017-01-01"},"List Bots by Resource Group":{"value":"2017-01-01"},"Delete Bot":{"value":"2017-01-01"},"Get Bot":{"value":"2017-01-01"},"Update Bot":{"value":"2017-01-01"},"Create Bot":{"value":"2017-01-01"},"Update Connection Setting":{"value":"2017-01-01"},"Create Connection Setting":{"value":"2017-01-01"},"List Channel":{"value":"2017-01-01"},"List Connection Settings":{"value":"2017-01-01"},"List Enterprise Channels by Resource Group":{"value":"2018-07-12"},"Delete Enterprise Channel":{"value":"2018-07-12"},"Get Enterprise Channel":{"value":"2018-07-12"},"Update Enterprise Channel":{"value":"2018-07-12"},"Create Enterprise Channel":{"value":"2018-07-12"}}},"channelNameParameter":{"description":"The name of the Channel resource.","in":"path","name":"channelName","required":true,"x-ms-enum":{"modelAsString":false,"name":"channelName","values":[{"value":"FacebookChannel"},{"value":"EmailChannel"},{"value":"KikChannel"},{"value":"TelegramChannel"},{"value":"SlackChannel"},{"value":"MsTeamsChannel"},{"value":"SkypeChannel"},{"value":"WebChatChannel"},{"value":"DirectLineChannel"},{"value":"SmsChannel"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["FacebookChannel","EmailChannel","KikChannel","TelegramChannel","SlackChannel","MsTeamsChannel","SkypeChannel","WebChatChannel","DirectLineChannel","SmsChannel"]},"examples":{"Update Bot":{"value":"EmailChannel"},"Create Bot":{"value":"EmailChannel"},"List Channel":{"value":"EmailChannel"}}},"connectionNameParameter":{"description":"The name of the Bot Service Connection Setting resource","in":"path","name":"connectionName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"examples":{"Update Connection Setting":{"value":"sampleConnection"},"Create Connection Setting":{"value":"sampleConnection"}}},"resourceGroupNameParameter":{"description":"The name of the Bot resource group in the user subscription.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"examples":{"List Bots by Resource Group":{"value":"OneResourceGroupName"},"Delete Bot":{"value":"OneResourceGroupName"},"Get Bot":{"value":"OneResourceGroupName"},"Update Bot":{"value":"OneResourceGroupName"},"Create Bot":{"value":"OneResourceGroupName"},"Update Connection Setting":{"value":"OneResourceGroupName"},"Create Connection Setting":{"value":"OneResourceGroupName"},"List Channel":{"value":"OneResourceGroupName"},"List Connection Settings":{"value":"OneResourceGroupName"},"List Enterprise Channels by Resource Group":{"value":"OneResourceGroupName"},"Delete Enterprise Channel":{"value":"OneResourceGroupName"},"Get Enterprise Channel":{"value":"OneResourceGroupName"},"Update Enterprise Channel":{"value":"OneResourceGroupName"},"Create Enterprise Channel":{"value":"OneResourceGroupName"}}},"resourceNameParameter":{"description":"The name of the Bot resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"},"examples":{"Delete Bot":{"value":"samplebotname"},"Get Bot":{"value":"samplebotname"},"Update Bot":{"value":"samplebotname"},"Create Bot":{"value":"samplebotname"},"Update Connection Setting":{"value":"samplebotname"},"Create Connection Setting":{"value":"samplebotname"},"List Bots by Resource Group":{"value":"samplebotname"},"List Channel":{"value":"samplebotname"},"List Connection Settings":{"value":"samplebotname"},"Delete Enterprise Channel":{"value":"contoso-dl"},"Get Enterprise Channel":{"value":"contoso-dl"},"Update Enterprise Channel":{"value":"contoso-dl"},"Create Enterprise Channel":{"value":"contoso-dl"}}},"subscriptionIdParameter":{"description":"Azure Subscription ID.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List Bots by Subscription":{"value":"subscription-id"},"List Auth Service Providers":{"value":"subscription-id"},"List Bots by Resource Group":{"value":"subscription-id"},"Delete Bot":{"value":"subscription-id"},"Get Bot":{"value":"subscription-id"},"Update Bot":{"value":"subscription-id"},"Create Bot":{"value":"subscription-id"},"Update Connection Setting":{"value":"subscription-id"},"Create Connection Setting":{"value":"subscription-id"},"List Channel":{"value":"subscription-id"},"List Connection Settings":{"value":"subscription-id"},"List Enterprise Channels by Resource Group":{"value":"subscription-id"},"Delete Enterprise Channel":{"value":"subscription-id"},"Get Enterprise Channel":{"value":"subscription-id"},"Update Enterprise Channel":{"value":"subscription-id"},"Create Enterprise Channel":{"value":"subscription-id"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Bot":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Bot resource definition","properties":{"properties":{"$ref":"#/components/schemas/BotProperties"}},"type":"object"},"BotChannel":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Bot channel resource definition","properties":{"properties":{"$ref":"#/componen