Services - Check Name Availability

Szolgáltatás:
Search Management
API-verzió:
2025-02-01-preview

Ellenőrzi, hogy a megadott keresési szolgáltatásnév használható-e. A keresési szolgáltatások nevének globálisan egyedinek kell lennie, mivel a szolgáltatás URI-jának (https:// name.search.windows.net<>) részét képezik.

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

URI-paraméterek

Név In Kötelező Típus Description
subscriptionId
 path True

string

A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
api-version
 query True

string

Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Név Kötelező Típus Description
x-ms-client-request-id

string (uuid)

Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Kérelem törzse

Név Kötelező Típus Description
name True

string

Az érvényesítendő keresési szolgáltatás neve. A keresési szolgáltatásnevek csak kisbetűket, számjegyeket vagy kötőjeleket tartalmazhatnak, nem használhatók kötőjelként az első két vagy az utolsó karakterként, nem tartalmazhatnak egymást követő kötőjeleket, és 2 és 60 karakter közötti hosszúságúak lehetnek.
type True

ResourceType

Annak az erőforrásnak a típusa, amelynek a nevét ellenőrizni kell. Ennek az értéknek mindig "searchServices" értékűnek kell lennie.

Válaszok

Név Típus Description
200 OK

CheckNameAvailabilityOutput

A névellenőrzés befejeződött. A válasz tartalmazza annak részleteit, hogy a név érvényes és elérhető-e. Ha a név érvénytelen, a válasz egy üzenetet is tartalmaz, amely elmagyarázza, hogy miért nem.
Other Status Codes

CloudError

HTTP 400 (Hibás kérés): A megadott erőforrástípus nem "searchServices".

Biztonság

azure_auth

Implicit engedélyezési folyamatot határoz meg a Microsoft Identity platformon támogatott módon.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

SearchCheckNameAvailability

Mintakérelem

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

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

Mintaválasz

Állapotkód:
200 
{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": ""
}

Definíciók

Név Description
CheckNameAvailabilityInput

Az ellenőrzőnév rendelkezésre állási API bemenete.
CheckNameAvailabilityOutput

Az ellenőrzőnév rendelkezésre állási API kimenete.
CloudError

Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
ResourceType

Annak az erőforrásnak a típusa, amelynek a nevét ellenőrizni kell. Ennek az értéknek mindig "searchServices" értékűnek kell lennie.
UnavailableNameReason

Ennek oka, hogy a név nem érhető el. Az "Érvénytelen" azt jelzi, hogy a megadott név nem felel meg az elnevezési követelményeknek (helytelen hossz, nem támogatott karakterek stb.). A "Márexists" azt jelzi, hogy a név már használatban van, ezért nem érhető el.

CheckNameAvailabilityInput

Tárgy

Az ellenőrzőnév rendelkezésre állási API bemenete.

Név Típus Description
name

string

Az érvényesítendő keresési szolgáltatás neve. A keresési szolgáltatásnevek csak kisbetűket, számjegyeket vagy kötőjeleket tartalmazhatnak, nem használhatók kötőjelként az első két vagy az utolsó karakterként, nem tartalmazhatnak egymást követő kötőjeleket, és 2 és 60 karakter közötti hosszúságúak lehetnek.
type

ResourceType

Annak az erőforrásnak a típusa, amelynek a nevét ellenőrizni kell. Ennek az értéknek mindig "searchServices" értékűnek kell lennie.

CheckNameAvailabilityOutput

Tárgy

Az ellenőrzőnév rendelkezésre állási API kimenete.

Név Típus Description
message

string

Egy üzenet, amely elmagyarázza, hogy miért érvénytelen a név, és erőforrás-elnevezési követelményeket tartalmaz. Csak akkor érhető el, ha az "Érvénytelen" értéket az "ok" tulajdonság adja vissza.
nameAvailable

boolean

Egy érték, amely jelzi, hogy a név elérhető-e.
reason

UnavailableNameReason

Ennek oka, hogy a név nem érhető el. Az "Érvénytelen" azt jelzi, hogy a megadott név nem felel meg az elnevezési követelményeknek (helytelen hossz, nem támogatott karakterek stb.). A "Márexists" azt jelzi, hogy a név már használatban van, ezért nem érhető el.

CloudError

Tárgy

Api-hibával kapcsolatos információkat tartalmaz.

Név Típus Description
error

CloudErrorBody

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
message

string

A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot).

CloudErrorBody

Tárgy

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Név Típus Description
code

string

Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details

CloudErrorBody[]

Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message

string

A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target

string

Az adott hiba célja (például a hiba tulajdonságának neve).

ResourceType

Felsorolás

Annak az erőforrásnak a típusa, amelynek a nevét ellenőrizni kell. Ennek az értéknek mindig "searchServices" értékűnek kell lennie.

Érték Description
searchServices

A "searchServices" az egyetlen erőforrástípus, amelynek a neve érvényesíthető.

UnavailableNameReason

Felsorolás

Ennek oka, hogy a név nem érhető el. Az "Érvénytelen" azt jelzi, hogy a megadott név nem felel meg az elnevezési követelményeknek (helytelen hossz, nem támogatott karakterek stb.). A "Márexists" azt jelzi, hogy a név már használatban van, ezért nem érhető el.

Érték Description
Invalid

A keresési szolgáltatás neve nem felel meg az elnevezési követelményeknek.
AlreadyExists

A keresési szolgáltatás neve már hozzá van rendelve egy másik keresési szolgáltatáshoz.