Services - Check Name Availability

Dienst:: Search Management

API-Version:: 2024-03-01-preview

Ü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=2024-03-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
api-version	query	True	string	Die API-Version, die für jede Anforderung 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	ResourceType	Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer 'searchServices' sein.

Antworten

Name	Typ	Beschreibung
200 OK	CheckNameAvailabilityOutput	Die Namensüberprüfung wurde abgeschlossen. Die Antwort enthält Details dazu, ob der Name gültig und verfügbar ist. Wenn der Name ungültig ist, enthält die Antwort auch eine Meldung, in der erläutert wird, warum dies nicht der Grund ist.
Other Status Codes	CloudError	HTTP 400 (ungültige Anforderung): Der angegebene Ressourcentyp ist nicht 'searchServices'.

Sicherheit

azure_auth

Gibt einen impliziten Genehmigungsfluss an, der auf der Microsoft Identity Platform unterstützt wird.

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

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2024-03-01-preview

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

Beispiel für eine Antwort

Statuscode:: 200

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

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.
ResourceType	Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer 'searchServices' sein.
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

Objekt

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	ResourceType	Der Typ der Ressource, deren Name überprüft werden soll. Dieser Wert muss immer 'searchServices' sein.

CheckNameAvailabilityOutput

Objekt

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

Objekt

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

Objekt

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).

ResourceType

Enumeration

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

Wert	Beschreibung
searchServices	'searchServices' ist der einzige Ressourcentyp, dessen Name überprüft werden kann.

UnavailableNameReason

Enumeration

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.