SearchService interface

Pakiet:

@azure/arm-search

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

Rozszerzenie

TrackedResource

Właściwości

authOptions	Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli parametr "disableLocalAuth" ma wartość true.
disableLocalAuth	Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły używać kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".
encryptionWithCmk	Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.
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ą.
identity	Tożsamość zasobu.
networkRuleSet	Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure Cognitive Search.
partitionCount	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.
privateEndpointConnections	Lista połączeń prywatnych punktów końcowych z usługą Azure Cognitive Search. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
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. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
publicNetworkAccess	Tę wartość można ustawić na wartość "włączone", 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.
replicaCount	Liczba replik w usłudze wyszukiwania. Jeśli jest określona, musi być wartością z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.
semanticSearch	Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko w przypadku niektórych jednostek SKU Azure Cognitive Search w niektórych lokalizacjach.
sharedPrivateLinkResources	Lista udostępnionych zasobów łącza prywatnego zarządzanych przez usługę Azure Cognitive Search. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
sku	Jednostka SKU usługi search, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.
status	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. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
statusDetails	Szczegóły stanu usługi wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Właściwości dziedziczone

id	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
location	Lokalizacja geograficzna, w której znajduje się zasób
name	Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
tags	Tagi zasobów.
type	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

authOptions

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

authOptions?: DataPlaneAuthOptions

Wartość właściwości

DataPlaneAuthOptions

disableLocalAuth

Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły używać kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".

disableLocalAuth?: boolean

Wartość właściwości

boolean

encryptionWithCmk

Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.

encryptionWithCmk?: EncryptionWithCmk

Wartość właściwości

EncryptionWithCmk

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ą.

hostingMode?: HostingMode

Wartość właściwości

HostingMode

identity

Tożsamość zasobu.

identity?: Identity

Wartość właściwości

Identity

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

Wartość właściwości

NetworkRuleSet

partitionCount

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.

partitionCount?: number

Wartość właściwości

number

privateEndpointConnections

Lista połączeń prywatnych punktów końcowych z usługą Azure Cognitive Search. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

privateEndpointConnections?: PrivateEndpointConnection[]

Wartość właściwości

PrivateEndpointConnection[]

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. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

provisioningState?: ProvisioningState

Wartość właściwości

ProvisioningState

publicNetworkAccess

Tę wartość można ustawić na wartość "włączone", 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.

publicNetworkAccess?: PublicNetworkAccess

Wartość właściwości

PublicNetworkAccess

replicaCount

Liczba replik w usłudze wyszukiwania. Jeśli jest określona, musi być wartością z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.

replicaCount?: number

Wartość właściwości

number

semanticSearch

Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko w przypadku niektórych jednostek SKU Azure Cognitive Search w niektórych lokalizacjach.

semanticSearch?: string

Wartość właściwości

string

sharedPrivateLinkResources

Lista udostępnionych zasobów łącza prywatnego zarządzanych przez usługę Azure Cognitive Search. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Wartość właściwości

SharedPrivateLinkResource[]

sku

Jednostka SKU usługi search, która określa warstwę cenową i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.

sku?: Sku

Wartość właściwości

Sku

status

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. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

status?: SearchServiceStatus

Wartość właściwości

SearchServiceStatus

statusDetails

Szczegóły stanu usługi wyszukiwania. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

statusDetails?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

Dziedziczone zTrackedResource.id

location

Lokalizacja geograficzna, w której znajduje się zasób

location: string

Wartość właściwości

string

Dziedziczone ztrackedResource.location

name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

Dziedziczone zTrackedResource.name

tags

Tagi zasobów.

tags?: {[propertyName: string]: string}

Wartość właściwości

{[propertyName: string]: string}

Dziedziczone ztrackedResource.tags

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

Dziedziczone ztrackedResource.type