Services - Check Name Availability
Zkontroluje, jestli je daný název vyhledávací služby k dispozici pro použití. Názvy vyhledávacích služeb musí být globálně jedinečné, protože jsou součástí identifikátoru URI služby (https://< name.search.windows.net>).
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
ID cílového předplatného. Hodnota musí být UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek. |
Text požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| name | True |
string |
Název vyhledávací služby, který chcete ověřit. Názvy vyhledávacích služeb musí obsahovat jenom malá písmena, číslice nebo pomlčky, nesmí jako první dva nebo poslední jeden znak používat pomlčku, nesmí obsahovat po sobě jdoucí pomlčky a musí mít délku 2 až 60 znaků. |
| type | True |
enum:
search |
Typ prostředku, jehož název se má ověřit. Tato hodnota musí být vždy "searchServices". |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Požadavek byl úspěšný. |
|
| Other Status Codes |
Neočekávaná chybová odpověď |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
| Name | Description |
|---|---|
| user_impersonation | zosobnění uživatelského účtu |
Příklady
SearchCheckNameAvailability
Ukázkový požadavek
Ukázková odpověď
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
Definice
| Name | Description |
|---|---|
|
Check |
Vstup rozhraní API pro kontrolu dostupnosti názvu |
|
Check |
Výstup rozhraní API pro kontrolu dostupnosti názvu |
|
Cloud |
Obsahuje informace o chybě rozhraní API. |
|
Cloud |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
|
Unavailable |
Důvod, proč název není k dispozici. Zadaný název neodpovídá požadavkům na pojmenování (nesprávná délka, nepodporované znaky atd.). 'AlreadyExists' označuje, že název je již používán, a proto není k dispozici. |
CheckNameAvailabilityInput
Vstup rozhraní API pro kontrolu dostupnosti názvu
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název vyhledávací služby, který chcete ověřit. Názvy vyhledávacích služeb musí obsahovat jenom malá písmena, číslice nebo pomlčky, nesmí jako první dva nebo poslední jeden znak používat pomlčku, nesmí obsahovat po sobě jdoucí pomlčky a musí mít délku 2 až 60 znaků. |
| type |
enum:
search |
Typ prostředku, jehož název se má ověřit. Tato hodnota musí být vždy "searchServices". |
CheckNameAvailabilityOutput
Výstup rozhraní API pro kontrolu dostupnosti názvu
| Name | Typ | Description |
|---|---|---|
| message |
string |
Zpráva, která vysvětluje, proč je název neplatný a poskytuje požadavky na pojmenování prostředků. K dispozici pouze v případě, že vlastnost 'reason' je vrácena neplatná. |
| nameAvailable |
boolean |
Hodnota označující, zda je název k dispozici. |
| reason |
Důvod, proč název není k dispozici. Zadaný název neodpovídá požadavkům na pojmenování (nesprávná délka, nepodporované znaky atd.). 'AlreadyExists' označuje, že název je již používán, a proto není k dispozici. |
CloudError
Obsahuje informace o chybě rozhraní API.
| Name | Typ | Description |
|---|---|---|
| error |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
|
| message |
string |
Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message). |
CloudErrorBody
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb. |
| details |
Obsahuje vnořené chyby, které souvisejí s touto chybou. |
|
| message |
string |
Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění. |
| target |
string |
Cíl konkrétní chyby (například název vlastnosti v chybě). |
UnavailableNameReason
Důvod, proč název není k dispozici. Zadaný název neodpovídá požadavkům na pojmenování (nesprávná délka, nepodporované znaky atd.). 'AlreadyExists' označuje, že název je již používán, a proto není k dispozici.
| Hodnota | Description |
|---|---|
| Invalid |
Název vyhledávací služby neodpovídá požadavkům na pojmenování. |
| AlreadyExists |
Název vyhledávací služby je již přiřazen k jiné vyhledávací službě. |