Freigeben über

Servers - Check Name Availability

Dienst:
SQL Database
API-Version:
2025-01-01

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

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
 path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
name True

string

type True

CheckNameAvailabilityResourceType

Antworten

Name Typ Beschreibung
200 OK

CheckNameAvailabilityResponse

Die Anforderung ist erfolgreich.
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

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

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Check for a server name that is available

Beispielanforderung

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

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

Beispiel für eine Antwort

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

Check for a server name that is invalid

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "name": "SERVER1",
  "available": false,
  "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.",
  "reason": "Invalid"
}

Definitionen

Name Beschreibung
CheckNameAvailabilityReason

Der Grundcode, der erklärt, warum der Name nicht verfügbar ist. Wird nicht definiert, 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
CheckNameAvailabilityResponse

Das Ergebnis einer Namensverfügbarkeitsprüfung.
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort

CheckNameAvailabilityReason

Enumeration

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

Wert Beschreibung
Invalid

Ungültig
AlreadyExists

Bereits vorhanden

CheckNameAvailabilityRequest

Objekt

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

Name Typ Beschreibung
name

string

type

CheckNameAvailabilityResourceType

CheckNameAvailabilityResourceType

Enumeration
Wert Beschreibung
Microsoft.Sql/servers

Microsoft. SQL/Server

CheckNameAvailabilityResponse

Objekt

Das Ergebnis einer Namensverfügbarkeitsprüfung.

Name Typ Beschreibung
available

boolean

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

string

Eine Meldung, in der erläutert wird, warum der Name nicht verfügbar ist. Wird nicht definiert, 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. Wird nicht definiert, wenn der Name verfügbar ist.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.