Services - Check Name Availability

Služba:
Search Management
Verze rozhraní API:
2025-02-01-preview

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-02-01-preview

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
subscriptionId
 path True

string

Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
api-version
 query True

string

Verze rozhraní API, která se má použít pro každý požadavek.

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

ResourceType

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

CheckNameAvailabilityOutput

Kontrola názvu byla dokončena. Odpověď obsahuje podrobnosti o tom, jestli je název platný a dostupný. Pokud je název neplatný, odpověď obsahuje také zprávu s vysvětlením, proč ne.
Other Status Codes

CloudError

HTTP 400 (Chybný požadavek): Daný typ prostředku není searchServices.

Zabezpečení

azure_auth

Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.

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

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

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

Ukázková odpověď

Stavový kód:
200 
{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": ""
}

Definice

Name Description
CheckNameAvailabilityInput

Vstup rozhraní API pro kontrolu dostupnosti názvu
CheckNameAvailabilityOutput

Výstup rozhraní API pro kontrolu dostupnosti názvu
CloudError

Obsahuje informace o chybě rozhraní API.
CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
ResourceType

Typ prostředku, jehož název se má ověřit. Tato hodnota musí být vždy "searchServices".
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.

CheckNameAvailabilityInput

Objekt

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

ResourceType

Typ prostředku, jehož název se má ověřit. Tato hodnota musí být vždy "searchServices".

CheckNameAvailabilityOutput

Objekt

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

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.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Name Typ Description
error

CloudErrorBody

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

Objekt

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

CloudErrorBody[]

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

ResourceType

Výčet

Typ prostředku, jehož název se má ověřit. Tato hodnota musí být vždy "searchServices".

Hodnota Description
searchServices

SearchServices je jediný typ prostředku, jehož název lze ověřit.

UnavailableNameReason

Výčet

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