Servers - Check Name Availability

Service:

SQL Database

API Version:

2023-08-01

Determines whether a resource can be created with the specified name.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Required	Type	Description
name	True	string
type	True	CheckNameAvailabilityResourceType

Responses

Name	Type	Description
200 OK	CheckNameAvailabilityResponse	Successfully completed the availability check.
Other Status Codes	ErrorResponse	*** Error Responses: *** 400 InvalidNameAvailabilityRequest - The check name availability request is invalid. 400 UnknownNameType - Unknown resource type specified for a subscription level name availability check.

Examples

Check for a server name that already exists

Check for a server name that is available

Check for a server name that is invalid

Check for a server name that already exists

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Sample response

Status code:

200

{
  "name": "server1",
  "available": false,
  "reason": "AlreadyExists",
  "message": "Specified server name is already used"
}

Check for a server name that is available

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "server1",
  "type": "Microsoft.Sql/servers"
}

Sample response

Status code:

200

{
  "name": "server1",
  "available": true
}

Check for a server name that is invalid

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2023-08-01

{
  "name": "SERVER1",
  "type": "Microsoft.Sql/servers"
}

Sample response

Status code:

200

{
  "name": "SERVER1",
  "available": false,
  "reason": "Invalid",
  "message": "Specified server name contains unsupported characters or is too long. Server name must be no longer than 63 characters long, contain only lower-case characters or digits, cannot contain '.' or '_' characters and can't start or end with '-' character."
}

Definitions

Name	Description
CheckNameAvailabilityReason	The reason code explaining why the name is unavailable. Will be undefined if the name is available.
CheckNameAvailabilityRequest	A request to check whether the specified name for a resource is available.
CheckNameAvailabilityResourceType
CheckNameAvailabilityResponse	The result of a name availability check.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

CheckNameAvailabilityReason

Enumeration

The reason code explaining why the name is unavailable. Will be undefined if the name is available.

Value	Description
AlreadyExists
Invalid

CheckNameAvailabilityRequest

Object

A request to check whether the specified name for a resource is available.

Name	Type	Description
name	string
type	CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Enumeration

Value	Description
Microsoft.Sql/servers

CheckNameAvailabilityResponse

Object

The result of a name availability check.

Name	Type	Description
available	boolean	True if the name is available, otherwise false.
message	string	A message explaining why the name is unavailable. Will be undefined if the name is available.
name	string	The name whose availability was checked.
reason	CheckNameAvailabilityReason	The reason code explaining why the name is unavailable. Will be undefined if the name is available.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.