Services - Check Name Availability
Sprawdza, czy dana nazwa usługi wyszukiwania jest dostępna do użycia. Nazwy usług wyszukiwania muszą być globalnie unikatowe, ponieważ są częścią identyfikatora URI usługi (https://< nazwa.search.windows.net>).
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach o odpowiedzi jako sposób śledzenia żądania. |
Treść żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| name | True |
string |
Nazwa usługi wyszukiwania do zweryfikowania. Nazwy usługi wyszukiwania muszą zawierać tylko małe litery, cyfry lub kreski, nie mogą używać kreski jako pierwszych dwóch lub ostatnich znaków, nie mogą zawierać kolejnych kreski i muszą mieć długość od 2 do 60 znaków. |
| type | True |
enum:
search |
Typ zasobu, którego nazwa ma zostać zweryfikowana. Ta wartość musi zawsze mieć wartość "searchServices". |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| user_impersonation | personifikacja konta użytkownika |
Przykłady
SearchCheckNameAvailability
Przykładowe żądanie
Przykładowa odpowiedź
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
Definicje
| Nazwa | Opis |
|---|---|
|
Check |
Dane wejściowe interfejsu API sprawdzania dostępności nazwy. |
|
Check |
Dane wyjściowe interfejsu API sprawdzania dostępności nazwy. |
|
Cloud |
Zawiera informacje o błędzie interfejsu API. |
|
Cloud |
Opisuje określony błąd interfejsu API z kodem błędu i komunikatem. |
|
Unavailable |
Powód, dla którego nazwa jest niedostępna. Wartość "Invalid" wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa (nieprawidłowa długość, nieobsługiwane znaki itp.). Element "AlreadyExists" wskazuje, że nazwa jest już używana i dlatego jest niedostępna. |
CheckNameAvailabilityInput
Dane wejściowe interfejsu API sprawdzania dostępności nazwy.
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa usługi wyszukiwania do zweryfikowania. Nazwy usługi wyszukiwania muszą zawierać tylko małe litery, cyfry lub kreski, nie mogą używać kreski jako pierwszych dwóch lub ostatnich znaków, nie mogą zawierać kolejnych kreski i muszą mieć długość od 2 do 60 znaków. |
| type |
enum:
search |
Typ zasobu, którego nazwa ma zostać zweryfikowana. Ta wartość musi zawsze mieć wartość "searchServices". |
CheckNameAvailabilityOutput
Dane wyjściowe interfejsu API sprawdzania dostępności nazwy.
| Nazwa | Typ | Opis |
|---|---|---|
| message |
string |
Komunikat wyjaśniający, dlaczego nazwa jest nieprawidłowa i zawiera wymagania dotyczące nazewnictwa zasobów. Dostępne tylko wtedy, gdy właściwość "Invalid" jest zwracana we właściwości "reason". |
| nameAvailable |
boolean |
Wartość wskazująca, czy nazwa jest dostępna. |
| reason |
Powód, dla którego nazwa jest niedostępna. Wartość "Invalid" wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa (nieprawidłowa długość, nieobsługiwane znaki itp.). Element "AlreadyExists" wskazuje, że nazwa jest już używana i dlatego jest niedostępna. |
CloudError
Zawiera informacje o błędzie interfejsu API.
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Opisuje określony błąd interfejsu API z kodem błędu i komunikatem. |
|
| message |
string |
Krótki opis błędu, który wskazuje, co poszło nie tak (aby uzyskać szczegółowe informacje/debugowanie, zapoznaj się z właściwością "error.message"). |
CloudErrorBody
Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów. |
| details |
Zawiera zagnieżdżone błędy związane z tym błędem. |
|
| message |
string |
Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu. |
| target |
string |
Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). |
UnavailableNameReason
Powód, dla którego nazwa jest niedostępna. Wartość "Invalid" wskazuje, że podana nazwa nie jest zgodna z wymaganiami dotyczącymi nazewnictwa (nieprawidłowa długość, nieobsługiwane znaki itp.). Element "AlreadyExists" wskazuje, że nazwa jest już używana i dlatego jest niedostępna.
| Wartość | Opis |
|---|---|
| Invalid |
Nazwa usługi wyszukiwania nie jest zgodna z wymaganiami dotyczącymi nazewnictwa. |
| AlreadyExists |
Nazwa usługi wyszukiwania jest już przypisana do innej usługi wyszukiwania. |