Sign in

v10

latestSwagger 2.0raw.githubusercontent.com2021-02-05141544.2 KB
Services

Checks whether or not the given Search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).

post/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability

Path parameters

subscriptionIdstring required

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.

Query parameters

api-versionstring required

The API version to use for each request. The current version is 2015-08-19.

Headers

x-ms-client-request-idstring uuid

A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Request body

namestring required

The Search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length.

type'searchServices' required

The type of the resource whose name is to be validated. This value must always be 'searchServices'.

Response

The name check completed. The response contains details of whether the name is valid and available. If the name is invalid, the response also contains a message explaining why not.

nameAvailableboolean

A value indicating whether the name is available.

reason'Invalid' | 'AlreadyExists'

The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.

messagestring

A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property.