SearchService Klasa
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.
Aby wysyłać na platformę Azure wszystkie wymagane parametry, należy wypełnić wszystkie wymagane parametry.
- Dziedziczenie
-
azure.mgmt.search.models._models_py3.TrackedResourceSearchService
Konstruktor
SearchService(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str | _models.HostingMode = 'default', public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk: _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None, auth_options: _models.DataPlaneAuthOptions | None = None, **kwargs: Any)Parametry
- location
- str
Lokalizacja geograficzna, w której znajduje się zasób. Wymagane.
- sku
- Sku
Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.
- identity
- Identity
Tożsamość zasobu.
- replica_count
- int
Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.
- partition_count
- int
Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.
- hosting_mode
- str lub 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 umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna". Znane wartości to: "default" i "highDensity".
- public_network_access
- str lub PublicNetworkAccess
Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu. Znane wartości to: "włączone" i "wyłączone".
- network_rule_set
- NetworkRuleSet
Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę Azure Cognitive Search.
- encryption_with_cmk
- EncryptionWithCmk
Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.
- disable_local_auth
- bool
Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".
- auth_options
- DataPlaneAuthOptions
Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli dla ustawienia "disableLocalAuth" ustawiono wartość true.
Zmienne
- id
- str
W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}}.
- name
- str
Nazwa zasobu.
- type
- str
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts".
- location
- str
Lokalizacja geograficzna, w której znajduje się zasób. Wymagane.
- sku
- Sku
Jednostka SKU usługi wyszukiwania, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.
- identity
- Identity
Tożsamość zasobu.
- replica_count
- int
Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.
- partition_count
- int
Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.
- hosting_mode
- str lub 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 umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna". Znane wartości to: "default" i "highDensity".
- public_network_access
- str lub PublicNetworkAccess
Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu. Znane wartości to: "włączone" i "wyłączone".
- status
- str lub SearchServiceStatus
Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, 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ć usunięte. "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łączonej lub błędu, oznacza to, że zespół Azure Cognitive Search aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane na podstawie liczby aprowizowanych jednostek wyszukiwania. Znane wartości to: "running", "provisioning", "deleting", "degraded", "disabled", "error" i "stopped".
- status_details
- str
Szczegóły stanu usługi wyszukiwania.
- provisioning_state
- str lub 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 aprowizacjaStan zmieni się na "powodzenie" lub "niepowodzenie". 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 zobaczyć, kiedy operacja została ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu 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. Znane wartości to: "succeeded", "provisioning" i "failed".
- network_rule_set
- NetworkRuleSet
Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę Azure Cognitive Search.
- encryption_with_cmk
- EncryptionWithCmk
Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.
- disable_local_auth
- bool
Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".
- auth_options
- DataPlaneAuthOptions
Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli dla ustawienia "disableLocalAuth" ustawiono wartość true.
- private_endpoint_connections
- list[PrivateEndpointConnection]
Lista połączeń prywatnego punktu końcowego z usługą Azure Cognitive Search.
- shared_private_link_resources
- list[SharedPrivateLinkResource]
Lista udostępnionych zasobów łącza prywatnego zarządzanych przez usługę Azure Cognitive Search.