v7

latestSwagger 2.0raw.githubusercontent.com2019-07-01275587.3 KB
Bot

Check whether a bot name is available.

post/providers/Microsoft.BotService/checkNameAvailability

Query parameters

api-versionstring required

Version of the API to be used with the client request.

Request body

namestring

the name of the bot for which availability needs to be checked.

typestring

the type of the bot for which availability needs to be checked

Response

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.

validboolean

indicates if the bot name is valid.

messagestring

additional message from the bot management api showing why a bot name is not available