Share via


Servers - Name Availability - Check Name Availability

Bestimmt, ob eine Ressource mit dem angegebenen Namen erstellt werden kann.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

Abonnement-ID für ein Azure-Abonnement.

api-version
query True

string

API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
name True

string

Der Name, dessen Verfügbarkeit überprüft werden soll.

type True

CheckNameAvailabilityResourceType

Der Ressourcentyp, der als Bereich der Verfügbarkeitsprüfung verwendet wird.

Antworten

Name Typ Beschreibung
200 OK

CheckNameAvailabilityResponse

OK

Beispiele

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

{
  "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

{
  "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

{
  "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."
}

Definitionen

Name Beschreibung
CheckNameAvailabilityReason

Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Ist NULL, wenn der Name verfügbar ist.

CheckNameAvailabilityRequest

Eine Anforderung, um zu überprüfen, ob der angegebene Name für eine Ressource verfügbar ist.

CheckNameAvailabilityResourceType

Der Ressourcentyp, der als Bereich der Verfügbarkeitsprüfung verwendet wird.

CheckNameAvailabilityResponse

Eine Antwort, die angibt, ob der angegebene Name für eine Ressource verfügbar ist.

CheckNameAvailabilityReason

Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Ist NULL, wenn der Name verfügbar ist.

Name Typ Beschreibung
AlreadyExists

string

Invalid

string

CheckNameAvailabilityRequest

Eine Anforderung, um zu überprüfen, ob der angegebene Name für eine Ressource verfügbar ist.

Name Typ Beschreibung
name

string

Der Name, dessen Verfügbarkeit überprüft werden soll.

type

CheckNameAvailabilityResourceType

Der Ressourcentyp, der als Bereich der Verfügbarkeitsprüfung verwendet wird.

CheckNameAvailabilityResourceType

Der Ressourcentyp, der als Bereich der Verfügbarkeitsprüfung verwendet wird.

Name Typ Beschreibung
Microsoft.Sql/servers

string

CheckNameAvailabilityResponse

Eine Antwort, die angibt, ob der angegebene Name für eine Ressource verfügbar ist.

Name Typ Beschreibung
available

boolean

True, wenn der Name verfügbar ist, andernfalls false.

message

string

Eine Meldung, die erklärt, warum der Name nicht verfügbar ist. Ist NULL, wenn der Name verfügbar ist.

name

string

Der Name, dessen Verfügbarkeit überprüft wurde.

reason

CheckNameAvailabilityReason

Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Ist NULL, wenn der Name verfügbar ist.