Udostępnij przez


SearchServiceUpdate interface

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

Rozszerzenie

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.

computeType

Skonfiguruj tę właściwość tak, aby obsługiwała usługę wyszukiwania przy użyciu domyślnego obliczeniowego lub poufnego obliczenia platformy Azure.

dataExfiltrationProtections

Lista scenariuszy eksfiltracji danych, które są jawnie niedozwolone dla usługi wyszukiwania. Obecnie jedyną obsługiwaną wartością jest "Wszystkie", aby wyłączyć wszystkie możliwe scenariusze eksportu danych z bardziej precyzyjnymi kontrolkami zaplanowanymi na przyszłość.

disableLocalAuth

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

encryptionWithCmk

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

endpoint

Punkt końcowy usługi Azure AI Search.

eTag

Właściwość wygenerowana przez system reprezentująca element etag usługi, który może być przeznaczony do optymistycznej kontroli współbieżności podczas aktualizacji. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

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ż maksymalne indeksy dozwolone 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 być wartością domyślną.

identity

Szczegółowe informacje o tożsamości usługi wyszukiwania. Wartość null wskazuje, że usługa wyszukiwania nie ma przypisanej tożsamości.

location

Lokalizacja geograficzna zasobu. Musi to być jeden z obsługiwanych i zarejestrowanych regionów geograficznych platformy Azure (na przykład Zachodnie stany USA, Wschodnie stany USA, Azja Południowo-Wschodnia itd.). Ta właściwość jest wymagana podczas tworzenia nowego zasobu.

networkRuleSet

Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure AI 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 AI 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 provisioningState 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 sprawdzić, kiedy operacja zostanie 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. 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. 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.

semanticSearch

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

serviceUpgradedAt

Data i godzina ostatniego uaktualnienia usługi wyszukiwania. To pole będzie mieć wartość null, dopóki usługa nie zostanie uaktualniona po raz pierwszy. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

sharedPrivateLinkResources

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

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.

status

Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": 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ć 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. "Zatrzymano": usługa wyszukiwania znajduje się w subskrypcji, która jest wyłączona. Jeśli Twoja usługa znajduje się w stanach obniżonej wydajności, wyłączonej lub błędu, oznacza to, że zespół usługi Azure AI Search aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych 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.

tags

Tagi ułatwiające kategoryzowanie zasobu w witrynie Azure Portal.

upgradeAvailable

Wskazuje, czy usługa wyszukiwania ma dostępne uaktualnienie.

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.

name

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

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

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

computeType

Skonfiguruj tę właściwość tak, aby obsługiwała usługę wyszukiwania przy użyciu domyślnego obliczeniowego lub poufnego obliczenia platformy Azure.

computeType?: string

Wartość właściwości

string

dataExfiltrationProtections

Lista scenariuszy eksfiltracji danych, które są jawnie niedozwolone dla usługi wyszukiwania. Obecnie jedyną obsługiwaną wartością jest "Wszystkie", aby wyłączyć wszystkie możliwe scenariusze eksportu danych z bardziej precyzyjnymi kontrolkami zaplanowanymi na przyszłość.

dataExfiltrationProtections?: string[]

Wartość właściwości

string[]

disableLocalAuth

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

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

endpoint

Punkt końcowy usługi Azure AI Search.

endpoint?: string

Wartość właściwości

string

eTag

Właściwość wygenerowana przez system reprezentująca element etag usługi, który może być przeznaczony do optymistycznej kontroli współbieżności podczas aktualizacji. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

eTag?: string

Wartość właściwości

string

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ż maksymalne indeksy dozwolone 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 być wartością domyślną.

hostingMode?: HostingMode

Wartość właściwości

identity

Szczegółowe informacje o tożsamości usługi wyszukiwania. Wartość null wskazuje, że usługa wyszukiwania nie ma przypisanej tożsamości.

identity?: Identity

Wartość właściwości

location

Lokalizacja geograficzna zasobu. Musi to być jeden z obsługiwanych i zarejestrowanych regionów geograficznych platformy Azure (na przykład Zachodnie stany USA, Wschodnie stany USA, Azja Południowo-Wschodnia itd.). Ta właściwość jest wymagana podczas tworzenia nowego zasobu.

location?: string

Wartość właściwości

string

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

Wartość właściwości

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

privateEndpointConnections?: PrivateEndpointConnection[]

Wartość właściwości

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

provisioningState?: ProvisioningState

Wartość właściwości

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?: string

Wartość właściwości

string

replicaCount

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.

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 usługi Azure AI Search w określonych lokalizacjach.

semanticSearch?: string

Wartość właściwości

string

serviceUpgradedAt

Data i godzina ostatniego uaktualnienia usługi wyszukiwania. To pole będzie mieć wartość null, dopóki usługa nie zostanie uaktualniona po raz pierwszy. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

serviceUpgradedAt?: Date

Wartość właściwości

Date

sharedPrivateLinkResources

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

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Wartość właściwości

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.

sku?: Sku

Wartość właściwości

Sku

status

Stan usługi wyszukiwania. Możliwe wartości obejmują: "uruchomiono": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "provisioning": 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ć 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. "Zatrzymano": usługa wyszukiwania znajduje się w subskrypcji, która jest wyłączona. Jeśli Twoja usługa znajduje się w stanach obniżonej wydajności, wyłączonej lub błędu, oznacza to, że zespół usługi Azure AI Search aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych 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

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

tags

Tagi ułatwiające kategoryzowanie zasobu w witrynie Azure Portal.

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

Wartość właściwości

{[propertyName: string]: string}

upgradeAvailable

Wskazuje, czy usługa wyszukiwania ma dostępne uaktualnienie.

upgradeAvailable?: 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 zResource.id

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 zResource.name

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

systemData?: SystemData

Wartość właściwości

dziedziczone zResource.systemData

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 zResource.type