Services - Check Name Availability
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 ingår i tjänst-URI:n (https://.search.windows.net).
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2023-11-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et, kommandoradsverktygen eller portalen. |
api-version
|
query | True |
string |
DEN API-version som ska användas för varje begäran. |
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 |
Namnet på söktjänsten 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 |
Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices". |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Namnkontrollen har slutförts. Svaret innehåller information om huruvida namnet är giltigt och tillgängligt. Om namnet är ogiltigt innehåller svaret också ett meddelande som förklarar varför inte. |
|
Other Status Codes |
HTTP 400 (felaktig begäran): Den angivna resurstypen är inte "searchServices". |
Säkerhet
azure_auth
Auktoriseringsflöde för Microsoft Entra ID OAuth2.
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
POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2023-11-01
{
"name": "mysearchservice",
"type": "searchServices"
}
Exempelsvar
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": ""
}
Definitioner
Name | Description |
---|---|
Check |
Indata för API:et för tillgänglighet för kontrollnamn. |
Check |
Utdata från API:et för tillgänglighet för kontrollnamn. |
Cloud |
Innehåller information om ett API-fel. |
Cloud |
Beskriver ett visst API-fel med en felkod och ett meddelande. |
Resource |
Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices". |
Unavailable |
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
Indata för API:et för tillgänglighet för kontrollnamn.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på söktjänsten 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 |
Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices". |
CheckNameAvailabilityOutput
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 |
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
Innehåller information om ett API-fel.
Name | Typ | Description |
---|---|---|
error |
Beskriver ett visst API-fel med en felkod och ett meddelande. |
CloudErrorBody
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 |
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å egenskapen i fel). |
ResourceType
Typen av resurs vars namn ska verifieras. Det här värdet måste alltid vara "searchServices".
Värde | Description |
---|---|
searchServices |
"searchServices" är den enda resurstyp vars namn kan verifieras. |
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.
Värde | Description |
---|---|
AlreadyExists |
Söktjänstens namn har redan tilldelats till en annan söktjänst. |
Invalid |
Söktjänstens namn matchar inte namngivningskraven. |