Services - Check Name Availability

Überprüft, ob der angegebene Suchdienstname zur Verwendung verfügbar ist. Suchdienstnamen müssen global eindeutig sein, da sie Teil des Dienst-URI (https://< name.search.windows.net>) sind.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-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.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string (uuid)

Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Anforderungstext

Name Erforderlich Typ Beschreibung
name True

string

Der zu überprüfende Suchdienstname. Suchdienstnamen dürfen nur Kleinbuchstaben, Ziffern oder Striche enthalten, dürfen nicht als die ersten beiden oder letzten Zeichen Striche verwenden, dürfen keine aufeinander folgenden Striche enthalten und müssen zwischen 2 und 60 Zeichen lang sein.

type True enum:

searchServices

Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer 'searchServices' sein.

Antworten

Name Typ Beschreibung
200 OK

CheckNameAvailabilityOutput

Die Anforderung ist erfolgreich.

Other Status Codes

CloudError

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

SearchCheckNameAvailability

Beispielanforderung

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01

{
  "name": "mysearchservice",
  "type": "searchServices"
}

Beispiel für eine Antwort

{
  "message": "",
  "nameAvailable": false,
  "reason": "AlreadyExists"
}

Definitionen

Name Beschreibung
CheckNameAvailabilityInput

Eingabe der Überprüfungsnamenverfügbarkeits-API.

CheckNameAvailabilityOutput

Ausgabe der Überprüfungsnamenverfügbarkeits-API.

CloudError

Enthält Informationen zu einem API-Fehler.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

UnavailableNameReason

Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

CheckNameAvailabilityInput

Eingabe der Überprüfungsnamenverfügbarkeits-API.

Name Typ Beschreibung
name

string

Der zu überprüfende Suchdienstname. Suchdienstnamen dürfen nur Kleinbuchstaben, Ziffern oder Striche enthalten, dürfen nicht als die ersten beiden oder letzten Zeichen Striche verwenden, dürfen keine aufeinander folgenden Striche enthalten und müssen zwischen 2 und 60 Zeichen lang sein.

type enum:

searchServices

Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer 'searchServices' sein.

CheckNameAvailabilityOutput

Ausgabe der Überprüfungsnamenverfügbarkeits-API.

Name Typ Beschreibung
message

string

Eine Meldung, die erklärt, warum der Name ungültig ist und Ressourcenbenennungsanforderungen bereitstellt. Nur verfügbar, wenn "Invalid" in der Eigenschaft "reason" zurückgegeben wird.

nameAvailable

boolean

Ein Wert, der angibt, ob der Name verfügbar ist.

reason

UnavailableNameReason

Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

CloudError

Enthält Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

message

string

Eine kurze Beschreibung des Fehlers, der darauf hinweist, was schief gelaufen ist (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.

details

CloudErrorBody[]

Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.

message

string

Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.

target

string

Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

UnavailableNameReason

Der Grund, warum der Name nicht verfügbar ist. "Ungültig" gibt an, dass der angegebene Name nicht den Benennungsanforderungen entspricht (falsche Länge, nicht unterstützte Zeichen usw.). "AlreadyExists" gibt an, dass der Name bereits verwendet wird und daher nicht verfügbar ist.

Wert Beschreibung
Invalid

Der Name des Suchdiensts stimmt nicht mit den Benennungsanforderungen überein.

AlreadyExists

Der Name des Suchdiensts ist bereits einem anderen Suchdienst zugewiesen.