Services - Check Name Availability
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=2023-11-01URI-paraméterek
| Név | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string |
A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, a parancssori eszközökbő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 |
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 |
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 |
HTTP 400 (Hibás kérés): A megadott erőforrástípus nem "searchServices". |
Biztonság
azure_auth
Microsoft Entra ID OAuth2 engedélyezési folyamat.
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=2023-11-01
{
"name": "mysearchservice",
"type": "searchServices"
}
Mintaválasz
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": ""
}Definíciók
| Név | Description |
|---|---|
|
Check |
Az ellenőrzőnév rendelkezésre állási API bemenete. |
|
Check |
Az ellenőrzőnév rendelkezésre állási API kimenete. |
|
Cloud |
Api-hibával kapcsolatos információkat tartalmaz. |
|
Cloud |
Egy adott API-hibát ír le egy hibakóddal és egy üzenettel. |
|
Resource |
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. |
|
Unavailable |
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
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 |
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
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 |
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
Api-hibával kapcsolatos információkat tartalmaz.
| Név | Típus | Description |
|---|---|---|
| error |
Egy adott API-hibát ír le egy hibakóddal és egy üzenettel. |
CloudErrorBody
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 |
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
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
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. |