Services - Check Name Availability

Tjänst:: Search Management

API-version:: 2026-11-01

Kontrollerar om det angivna söktjänstnamnet är tillgängligt för användning eller inte. Söktjänstnamn måste vara globalt unika eftersom de är en del av tjänstens URI (https://< name.search.windows.net>).

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
name	True	string	Söktjänstens namn som ska verifieras. Söktjänstnamn får endast innehålla gemener, siffror eller bindestreck, kan inte använda bindestreck som de två första eller sista tecknen, får inte innehålla på varandra följande bindestreck och måste vara mellan 2 och 60 tecken långa.
type	True	enum: searchServices	Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".

Svar

Name	Typ	Description
200 OK	CheckNameAvailabilityOutput	Begäran har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SearchCheckNameAvailability

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
CheckNameAvailabilityInput	Indata för API:et för tillgänglighet för kontrollnamn.
CheckNameAvailabilityOutput	Utdata från API:et för tillgänglighet för kontrollnamn.
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
UnavailableNameReason	Anledningen till att namnet inte är tillgängligt. "Ogiltigt" anger att det angivna namnet inte matchar namngivningskraven (felaktig längd, tecken som inte stöds osv.). "AlreadyExists" anger att namnet redan används och därför inte är tillgängligt.

CheckNameAvailabilityInput

Objekt

Indata för API:et för tillgänglighet för kontrollnamn.

Name	Typ	Description
name	string	Söktjänstens namn som ska verifieras. Söktjänstnamn får endast innehålla gemener, siffror eller bindestreck, kan inte använda bindestreck som de två första eller sista tecknen, får inte innehålla på varandra följande bindestreck och måste vara mellan 2 och 60 tecken långa.
type	enum: searchServices	Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".

CheckNameAvailabilityOutput

Objekt

Utdata från API:et för tillgänglighet för kontrollnamn.

Name	Typ	Description
message	string	Ett meddelande som förklarar varför namnet är ogiltigt och innehåller krav på resursnamngivning. Endast tillgängligt om "Ogiltig" returneras i egenskapen "reason".
nameAvailable	boolean	Ett värde som anger om namnet är tillgängligt.
reason	UnavailableNameReason	Anledningen till att namnet inte är tillgängligt. "Ogiltigt" anger att det angivna namnet inte matchar namngivningskraven (felaktig längd, tecken som inte stöds osv.). "AlreadyExists" anger att namnet redan används och därför inte är tillgängligt.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på den felaktiga egenskapen).

UnavailableNameReason

Uppräkning

Anledningen till att namnet inte är tillgängligt. "Ogiltigt" anger att det angivna namnet inte matchar namngivningskraven (felaktig längd, tecken som inte stöds osv.). "AlreadyExists" anger att namnet redan används och därför inte är tillgängligt.

Värde	Description
Invalid	Söktjänstens namn matchar inte namngivningskraven.
AlreadyExists	Söktjänstens namn har redan tilldelats till en annan söktjänst.