Udostępnij za pośrednictwem


models Pakiet

Klasy

AdminKeyResult

Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

AsyncOperationResult

Szczegóły długotrwałej asynchronicznej operacji zasobu udostępnionego łącza prywatnego.

CheckNameAvailabilityInput

Dane wejściowe interfejsu API sprawdzania dostępności nazwy.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.

CheckNameAvailabilityOutput

Dane wyjściowe interfejsu API sprawdzania dostępności nazwy.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

DataPlaneAadOrApiKeyAuthOption

Wskazuje, że na potrzeby uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z usługi Azure Active Directory.

DataPlaneAuthOptions

Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługa wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.

EncryptionWithCmk

Opisuje zasady określające sposób szyfrowania zasobów w usłudze wyszukiwania za pomocą kluczy zarządzanych przez klienta.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Identity

Tożsamość zasobu.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.

IpRule

Reguła ograniczenia adresu IP usługi Azure Cognitive Search.

ListQueryKeysResult

Odpowiedź zawierająca klucze interfejsu API zapytań dla danej usługi Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

NetworkRuleSet

Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure Cognitive Search.

Operation

Opisuje operację interfejsu API REST.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

OperationDisplay

Obiekt, który opisuje operację.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

OperationListResult

Wynik żądania wyświetlania listy operacji interfejsu API REST. Zawiera listę operacji i adres URL umożliwiający uzyskanie następnego zestawu wyników.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

PrivateEndpointConnection

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

PrivateEndpointConnectionListResult

Odpowiedź zawierająca listę połączeń z prywatnym punktem końcowym.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

PrivateEndpointConnectionProperties

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą Azure Cognitive Search.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.

PrivateLinkResource

Opisuje obsługiwany zasób łącza prywatnego dla usługi Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

PrivateLinkResourceProperties

Opisuje właściwości obsługiwanego zasobu łącza prywatnego dla usługi Azure Cognitive Search. W przypadku danej wersji interfejsu API reprezentuje to "obsługiwane" identyfikatory groupId podczas tworzenia udostępnionego zasobu łącza prywatnego.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

PrivateLinkResourcesResult

Odpowiedź zawierająca listę obsługiwanych zasobów Private Link.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

QueryKey

Opisuje klucz interfejsu API dla danej usługi Azure Cognitive Search, która ma uprawnienia tylko do operacji zapytań.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Resource

Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

SearchManagementRequestOptions

Grupa parametrów.

SearchService

Opisuje usługę Azure Cognitive Search i jej bieżący stan.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.

SearchServiceListResult

Odpowiedź zawierająca listę usług Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

SearchServiceUpdate

Parametry używane do aktualizowania usługi Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

ShareablePrivateLinkResourceProperties

Opisuje właściwości typu zasobu, który został dołączony do usługi łącza prywatnego obsługiwany przez Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

ShareablePrivateLinkResourceType

Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego obsługiwany przez Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

SharedPrivateLinkResource

Opisuje udostępniony zasób Private Link zarządzany przez usługę Azure Cognitive Search.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

SharedPrivateLinkResourceListResult

Odpowiedź zawierająca listę zasobów Private Link udostępnionych.

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

SharedPrivateLinkResourceProperties

Opisuje właściwości istniejącego udostępnionego zasobu Private Link zarządzanego przez usługę Azure Cognitive Search.

Sku

Definiuje jednostkę SKU usługi Azure Cognitive Search, która określa warstwę cenową i limity pojemności.

TrackedResource

Definicja modelu zasobów dla zasobu platformy Azure Resource Manager śledzony zasób najwyższego poziomu, który ma "tagi" i "lokalizację".

Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.

Aby wysyłać na platformę Azure wszystkie wymagane parametry, należy wypełnić wszystkie wymagane parametry.

Wyliczenia

AadAuthFailureMode

Opisuje odpowiedź interfejsu API płaszczyzny danych usługa wyszukiwania wysyłać żądania, które zakończyły się niepowodzeniem uwierzytelniania.

AdminKeyKind

AdminKeyKind.

HostingMode

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które zezwalają na maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalna liczba indeksów dozwolonych dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi mieć wartość domyślną.

IdentityType

Typ tożsamości.

PrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Może to być aktualizowanie, usuwanie, niepowodzenie, powodzenie lub niekompletne.

PrivateLinkServiceConnectionStatus

Stan połączenia usługi private link. Może to być oczekujące, zatwierdzone, odrzucone lub rozłączone.

ProvisioningState

Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności stan provisioningState zmieni się na "succeeded" lub "failed". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby sprawdzić, kiedy operacja zostanie ukończona. Jeśli używasz bezpłatnej usługi, ta wartość zwykle wraca jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.

PublicNetworkAccess

Tę wartość można ustawić na wartość "enabled", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. W przypadku ustawienia wartości "disabled" ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a połączenia prywatnych punktów końcowych będą wyłączną metodą dostępu.

SearchEncryptionComplianceStatus

Opisuje, czy usługa wyszukiwania jest zgodna, czy nie ma zaszyfrowanych przez klienta zasobów. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a opcja "Wymuszanie" jest włączona, usługa zostanie oznaczona jako "nonCompliant".

SearchEncryptionWithCmk

Opisuje, w jaki sposób usługa wyszukiwania powinna wymuszać stosowanie co najmniej jednego niezaszyfrowanego zasobu przez klienta.

SearchServiceStatus

Stan usługi wyszukiwania. Możliwe wartości to: "running": Usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "Aprowizowanie": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "Obniżona wydajność": obniżona wydajność usługi wyszukiwania. Taka sytuacja może wystąpić, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać porzucone. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach obniżonej wydajności, wyłączenia lub błędu, oznacza to, że zespół Azure Cognitive Search aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal obciążane opłatami na podstawie liczby aprowizowania jednostek wyszukiwania.

SharedPrivateLinkResourceAsyncOperationResult

Bieżący stan długotrwałej asynchronicznej operacji zasobu udostępnionego łącza prywatnego.

SharedPrivateLinkResourceProvisioningState

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Może to być aktualizowanie, usuwanie, niepowodzenie, powodzenie lub niekompletne.

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego. Może to być oczekujące, zatwierdzone, odrzucone lub rozłączone.

SkuName

Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobnie jak w warstwie Standardowa, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje o większej godzinie, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, do 12 partycji".

UnavailableNameReason

Przyczyna niedostępna nazwy. "Nieprawidłowy" 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.