Share via

Servers - Name Availability - Check Name Availability

Service:
SQL Database
API Version:
2014-04-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=2014-04-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

The name whose availability is to be checked.
type True

CheckNameAvailabilityResourceType

The type of resource that is used as the scope of the availability check.

Responses

Name Type Description
200 OK

CheckNameAvailabilityResponse

OK

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

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-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

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

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

Sample response

Status code:
200 
{
  "name": "server1",
  "available": true,
  "reason": null,
  "message": null
}

Check for a server name that is invalid

Sample request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/checkNameAvailability?api-version=2014-04-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 null if the name is available.
CheckNameAvailabilityRequest

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

The type of resource that is used as the scope of the availability check.
CheckNameAvailabilityResponse

A response indicating whether the specified name for a resource is available.

CheckNameAvailabilityReason

Enumeration

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

Value Description
Invalid
AlreadyExists

CheckNameAvailabilityRequest

Object

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

Name Type Description
name

string

The name whose availability is to be checked.
type

CheckNameAvailabilityResourceType

The type of resource that is used as the scope of the availability check.

CheckNameAvailabilityResourceType

Enumeration

The type of resource that is used as the scope of the availability check.

Value Description
Microsoft.Sql/servers

CheckNameAvailabilityResponse

Object

A response indicating whether the specified name for a resource is available.

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 null 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 null if the name is available.