@azure/arm-search package

Interfejsy

AccessRule

Reguła dostępu w profilu konfiguracji obwodu zabezpieczeń sieci

AccessRuleProperties

Właściwości reguły dostępu

AccessRulePropertiesSubscriptionsItem

Konfiguracja obwodu bezpieczeństwa sieciowego

AdminKeyResult

Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi Wyszukiwanie AI platformy Azure.

AdminKeysGetOptionalParams

Parametry opcjonalne.

AdminKeysOperations

Interfejs reprezentujący operacje AdminKeys.

AdminKeysRegenerateOptionalParams

Parametry opcjonalne.

CheckNameAvailabilityInput

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

CheckNameAvailabilityOutput

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

CloudError

Zawiera informacje o błędzie interfejsu API.

CloudErrorBody

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

DataPlaneAadOrApiKeyAuthOption

Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy identyfikatora Entra firmy Microsoft.

DataPlaneAuthOptions

Definiuje opcje uwierzytelniania żądania płaszczyzny danych przez usługę 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.

Identity

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

IpRule

Reguła ograniczeń adresów IP usługi Wyszukiwanie AI platformy Azure.

NetworkRuleSet

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

NetworkSecurityPerimeter

Informacje o obwodzie zabezpieczeń sieci (NSP)

NetworkSecurityPerimeterConfiguration

Zasób konfiguracji obwodu zabezpieczeń sieci (NSP)

NetworkSecurityPerimeterConfigurationProperties

Właściwości konfiguracji zabezpieczeń sieci.

NetworkSecurityPerimeterConfigurationsGetOptionalParams

Parametry opcjonalne.

NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams

Parametry opcjonalne.

NetworkSecurityPerimeterConfigurationsOperations

Interfejs reprezentujący operacje NetworkSecurityPerimeterConfigurations.

NetworkSecurityPerimeterConfigurationsReconcileOptionalParams

Parametry opcjonalne.

NetworkSecurityProfile

Profil konfiguracji obwodu zabezpieczeń sieci

Operation

Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów

OperationDisplay

Zlokalizowane informacje wyświetlane dla operacji.

OperationsListOptionalParams

Parametry opcjonalne.

OperationsOperations

Interfejs reprezentujący operacje.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

PrivateEndpointConnection

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą Wyszukiwanie AI platformy Azure.

PrivateEndpointConnectionProperties

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

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

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

PrivateEndpointConnectionsDeleteOptionalParams

Parametry opcjonalne.

PrivateEndpointConnectionsGetOptionalParams

Parametry opcjonalne.

PrivateEndpointConnectionsListByServiceOptionalParams

Parametry opcjonalne.

PrivateEndpointConnectionsOperations

Interfejs reprezentujący operacje PrivateEndpointConnections.

PrivateEndpointConnectionsUpdateOptionalParams

Parametry opcjonalne.

PrivateLinkResource

Opisuje obsługiwany zasób łącza prywatnego dla usługi Wyszukiwanie AI platformy Azure.

PrivateLinkResourceProperties

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

PrivateLinkResourcesListSupportedOptionalParams

Parametry opcjonalne.

PrivateLinkResourcesOperations

Interfejs reprezentujący operacje PrivateLinkResources.

ProvisioningIssue

Opisuje problem z aprowizowaniem konfiguracji obwodowej zabezpieczeń sieci

ProvisioningIssueProperties

Szczegóły problemu z aprowizowaniem konfiguracji sieciowej sieci obwodowej (NSP). Dostawcy zasobów powinni wygenerować oddzielne elementy problemu z aprowizowaniem dla każdego wykrytego oddzielnego problemu i dołączyć zrozumiały i charakterystyczny opis, a także wszelkie odpowiednie sugerowane IdentyfikatoryResourceId i sugerowaneRulesy funkcjiAccess

ProxyResource

Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji

QueryKey

Opisuje klucz interfejsu API dla danej usługi Wyszukiwanie AI platformy Azure, która przekazuje uprawnienia tylko do odczytu w kolekcji dokumentacji indeksu.

QueryKeysCreateOptionalParams

Parametry opcjonalne.

QueryKeysDeleteOptionalParams

Parametry opcjonalne.

QueryKeysListBySearchServiceOptionalParams

Parametry opcjonalne.

QueryKeysOperations

Interfejs reprezentujący operacje QueryKeys.

QuotaUsageResult

Opisuje użycie limitu przydziału dla określonej jednostki SKU.

QuotaUsageResultName

Informacje o nazwie SKU, w tym jej identyfikator i lokalizowana nazwa wyświetlana.

Resource

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

ResourceAssociation

Informacje o skojarzeniu zasobów

RestorePollerOptions
SearchManagementClientOptionalParams

Parametry opcjonalne dla klienta.

SearchManagementRequestOptions

interfejs modelu WyszukiwanieZarządzanieŻądaniaOpcje

SearchService

Opisuje usługę Wyszukiwanie AI platformy Azure i jej bieżący stan.

SearchServiceProperties

Właściwości usługi wyszukiwania.

SearchServiceUpdate

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

ServicesCheckNameAvailabilityOptionalParams

Parametry opcjonalne.

ServicesCreateOrUpdateOptionalParams

Parametry opcjonalne.

ServicesDeleteOptionalParams

Parametry opcjonalne.

ServicesGetOptionalParams

Parametry opcjonalne.

ServicesListByResourceGroupOptionalParams

Parametry opcjonalne.

ServicesListBySubscriptionOptionalParams

Parametry opcjonalne.

ServicesOperations

Interfejs reprezentujący operacje Usług.

ServicesUpdateOptionalParams

Parametry opcjonalne.

ServicesUpgradeOptionalParams

Parametry opcjonalne.

ShareablePrivateLinkResourceProperties

Opisuje właściwości typu zasobu, który został dołączony do usługi łącza prywatnego obsługiwany przez usługę Wyszukiwanie AI platformy Azure.

ShareablePrivateLinkResourceType

Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego obsługiwany przez usługę Wyszukiwanie AI platformy Azure.

SharedPrivateLinkResource

Opisuje udostępniony zasób łącza prywatnego zarządzany przez usługę Wyszukiwanie AI platformy Azure.

SharedPrivateLinkResourceProperties

Opisuje właściwości istniejącego udostępnionego zasobu łącza prywatnego zarządzanego przez usługę Wyszukiwanie AI platformy Azure.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Parametry opcjonalne.

SharedPrivateLinkResourcesDeleteOptionalParams

Parametry opcjonalne.

SharedPrivateLinkResourcesGetOptionalParams

Parametry opcjonalne.

SharedPrivateLinkResourcesListByServiceOptionalParams

Parametry opcjonalne.

SharedPrivateLinkResourcesOperations

Interfejs reprezentujący operacje SharedPrivateLinkResources.

SimplePollerLike

Prosty poller, który może służyć do sondowania długotrwałej operacji.

Sku

Definiuje jednostkę SKU usługi wyszukiwania, która określa stawkę rozliczeń i limity pojemności.

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TrackedResource

Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację"

UsageBySubscriptionSkuOptionalParams

Parametry opcjonalne.

UsagesListBySubscriptionOptionalParams

Parametry opcjonalne.

UsagesOperations

Interfejs reprezentujący operacje Usages.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Aliasy typu

AadAuthFailureMode

Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.

AccessRuleDirection

Reguła kierunku dostępu
KnownAccessRuleDirection można używać zamiennie z usługą AccessRuleDirection, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

ruchu przychodzącego: dotyczy przychodzącego ruchu sieciowego do zabezpieczonych zasobów.
wychodzących: dotyczy ruchu wychodzącego sieciowego z zabezpieczonych zasobów

ActionType

Rozszerzalne wyliczenie. Wskazuje typ akcji. „Internal” oznacza działania przeznaczone wyłącznie dla interfejsów API do użytku wewnętrznego.
KnownActionType może być używany zamiennie z ActionType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

wewnętrzny: akcje dotyczą interfejsów API tylko do użytku wewnętrznego.

AdminKeyKind

Typ AdminKeyKind

AzureSupportedClouds

Obsługiwane wartości ustawienia chmury jako typ literału ciągu

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.
KnownComputeType można używać zamiennie z wartością ComputeType. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Domyślne: Utwórz usługę z domyślnym obliczeniem.
Confidential: Stwórz dedykowaną usługę z Azure Confidential Compute.

ContinuablePage

Interfejs opisujący stronę wyników.

CreatedByType

Rodzaj jednostki, która utworzyła zasób.
KnownCreatedByType można używać zamiennie z parametrem CreatedByType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

użytkownik: jednostka została utworzona przez użytkownika.
Application: jednostka została utworzona przez aplikację.
managedIdentity: jednostka została utworzona przez tożsamość zarządzaną.
klucz: jednostka została utworzona przez klucz.

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 standard3 wartość to "Default" lub "HighDensity". W przypadku wszystkich innych jednostek SKU ta wartość musi mieć wartość "Domyślna".

IdentityType

Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno tożsamość utworzoną przez system, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie wszystkich tożsamości z usługi.
KnownIdentityType można używać zamiennie z parametrem IdentityType. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Brak: wskazuje, że należy usunąć wszystkie tożsamości skojarzone z usługą wyszukiwania.
SystemAssigned: wskazuje, że tożsamość przypisana przez system dla usługi wyszukiwania zostanie włączona.
UserAssigned: wskazuje, że co najmniej jedna tożsamość przypisana przez użytkownika zostanie przypisana do usługi wyszukiwania.
SystemAssigned, UserAssigned: wskazuje, że tożsamość przypisana przez system dla usługi wyszukiwania zostanie włączona wraz z przypisaniem co najmniej jednej tożsamości przypisanej przez użytkownika.

IssueType

Rodzaj problemu
ZnaneIssueType można używać zamiennie z IssueType. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nieznany: nieznany typ problemu
ConfigurationPropagationFailure: wystąpił błąd podczas stosowania konfiguracji sieciowej sieci obwodowej (NSP).
MissingPerimeterConfiguration: problem z łącznością sieciową występuje w zasobie, który można rozwiązać przez dodanie nowych zasobów do obwodu zabezpieczeń sieci lub przez zmodyfikowanie reguł dostępu.
MissingIdentityConfiguration: tożsamość zarządzana nie została skojarzona z zasobem. Zasób nadal będzie mógł zweryfikować ruch przychodzący z obwodu zabezpieczeń sieci (NSP) lub pasujących reguł dostępu przychodzącego, ale nie będzie mógł wykonać dostępu wychodzącego jako członek NSP.

KnowledgeRetrieval

Określa plan rozliczeń dla wyszukiwania agentycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.
KnowKnowledgeRetrieval może być używany zamiennie z KnowledgeRetrieval, ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

darmowe: Umożliwia wyszukiwanie informacji w usłudze wyszukiwania i wskazuje, że należy go używać w ramach darmowego planu. Bezpłatny plan ogranicza liczbę próśb o odzyskiwanie wiedzy i jest oferowany bez dodatkowych opłat.
Standard: Umożliwia wyszukiwanie wiedzy w usłudze wyszukiwania jako funkcję rozliczalną po wyczerpaniu darmowej kwoty, z wyższą przepustowością i liczbą żądań wyszukiwania danych.

NetworkSecurityPerimeterConfigurationProvisioningState

Stan aprowizacji konfiguracji obwodowej zabezpieczeń sieci, która jest tworzona lub aktualizowana.
ZnaneNetworkSecurityPerimeterConfigurationProvisioningState można używać zamiennie z wartościami NetworkSecurityPerimeterConfigurationProvisioningState. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Powiedziane: Konfiguracja została pomyślnie skonfigurowana.
Tworzenie: Konfiguracja jest tworzona.
Aktualizacja: Konfiguracja jest aktualizowana.
Usuwanie: Konfiguracja jest usuwana.
Zaakceptowane: Żądanie konfiguracji zostało zaakceptowane, a provisioning jeszcze się nie rozpoczął.
Niepowodzenie: Konfiguracja nie została przydzielona.
Anulowane: Anulowano konfigurację.

Origin

Zamierzony podmiot wykonujący operację; na przykład w interfejsie użytkownika kontroli dostępu opartej na zasobach (RBAC) oraz dzienników audytu. Wartość domyślna to "użytkownik,system"
KnownOrigin może być używany zamiennie z Origin, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

użytkownika: wskazuje, że operacja jest inicjowana przez użytkownika.
system: wskazuje, że operacja jest inicjowana przez system.
użytkownik,system: wskazuje, że operacja jest inicjowana przez użytkownika lub system.

PrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie, Niekompletne lub Anulowane.
KnownPrivateLinkServiceConnectionProvisioningState można używać zamiennie z parametrem PrivateLinkServiceConnectionProvisioningState, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Aktualizowanie: Połączenie usługi łącza prywatnego jest w trakcie tworzenia wraz z innymi zasobami, aby były w pełni funkcjonalne.
Usuwanie: połączenie usługi łącza prywatnego jest w trakcie usuwania.
Niepowodzenie: nie można zainicjować lub usunąć połączenia usługi łącza prywatnego.
Powodzenie: połączenie usługi private link zakończyło aprowizację i jest gotowe do zatwierdzenia.
Niekompletne: żądanie aprowizacji zasobu połączenia usługi łącza prywatnego zostało zaakceptowane, ale proces tworzenia nie został jeszcze rozpoczęty.
Anulowane: Żądanie aprowizacji dla zasobu połączenia usługi łącza prywatnego zostało anulowane.

PrivateLinkServiceConnectionStatus

Stan połączenia usługi private link. Prawidłowe wartości to 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 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.

PublicNetworkAccess

Tę wartość można ustawić na wartość "Włączone", aby uniknąć zmian powodujących niezgodność w istniejących zasobach i szablonach klienta. W przypadku ustawienia opcji "Wyłączone" ruch przez interfejs publiczny nie jest dozwolony, a połączenia z prywatnymi punktami końcowymi będą wyłączną metodą dostępu.
ZnanePublicNetworkAccess można używać zamiennie z funkcją PublicNetworkAccess, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Włączone: Usługa wyszukiwania jest dostępna z ruchu pochodzącego z publicznego internetu.
Niepełnosprawność: Usługa wyszukiwania nie jest dostępna z ruchu pochodzącego z publicznego internetu. Dostęp jest dozwolony tylko za pośrednictwem zatwierdzonych połączeń prywatnych punktów końcowych.
SecuredByPerimeter: Reguły konfiguracji obwodu bezpieczeństwa sieciowego pozwalają lub nie zezwalają na dostęp do zasobu w sieci publicznej. Wymaga skojarzonego obwodu zabezpieczeń sieci.

ResourceAssociationAccessMode

Tryb dostępu do asocjacji zasobów
ZnaneResourceAssociationAccessMode można używać zamiennie z elementem ResourceAssociationAccessMode. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Wymuszone: wymuszony tryb dostępu — ruch do zasobu, który zakończył się niepowodzeniem kontroli dostępu, jest blokowany
Learning: tryb dostępu do nauki — ruch do zasobu jest włączony do analizy, ale nie jest blokowany
Inspekcja: Tryb dostępu inspekcji — ruch do zasobu, który kończy się niepowodzeniem kontroli dostępu, jest rejestrowany, ale nie jest zablokowany

SearchBypass

Możliwe źródła ruchu przychodzącego, które mogą pominąć reguły zdefiniowane w sekcji "ipRules".
KnownSearchBypass może być używany zamiennie z SearchBypass, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Brak: wskazuje, że żadne źródło nie może pominąć reguł zdefiniowanych w sekcji "ipRules". Jest to wartość domyślna.
AzureServices: wskazuje, że żądania pochodzące z zaufanych usług platformy Azure mogą pomijać reguły zdefiniowane w sekcji "ipRules".

SearchDataExfiltrationProtection

Specyficzny scenariusz wyciągania danych, który jest wyłączony dla usługi.
KnownSearchDataExfiltrationProtection może być używany zamiennie z SearchDataExfiltrationProtection, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

BlockAll: wskazuje, że wszystkie scenariusze eksfiltracji danych są wyłączone.

SearchEncryptionComplianceStatus

Zwraca stan zgodności usługi wyszukiwania w odniesieniu do obiektów niezaszyfrowanych przez protokół CMK. Jeśli usługa ma więcej niż jeden niezaszyfrowany obiekt, a wymuszanie jest włączone, usługa jest oznaczona jako niezgodna.

SearchEncryptionWithCmk

Opisuje sposób wymuszania zgodności przez usługę wyszukiwania w przypadku znalezienia obiektów, które nie są szyfrowane przy użyciu klucza zarządzanego przez klienta.

SearchSemanticSearch

Określa dostępność i plan rozliczeń dla wyszukiwania semantycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.
KnownSearchSemanticSearch można używać zamiennie z funkcją SearchSemanticSearch, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

disabled: wskazuje, że semantyczne reranker jest wyłączony dla usługi wyszukiwania.
free: Włącza semantyczny reranker w usłudze wyszukiwania i wskazuje, że ma być używany w granicach bezpłatnego planu. Plan bezpłatny ograniczy liczbę żądań klasyfikacji semantycznej i nie jest oferowany za dodatkową opłatą. Jest to ustawienie domyślne dla nowo aprowizowania usług wyszukiwania. Jest to wartość domyślna.
Standard: Umożliwia semantyczne reranker w usłudze wyszukiwania jako funkcję rozliczalną po wyczerpaniu darmowej kwoty, z wyższą przepustowością i większą liczbą semantycznie przeklasyfikowanych zapytań.

SearchServiceStatus

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 stanie degradacji, wyłączenia lub błędu, oznacza to, że zespół Wyszukiwanie AI platformy Azure aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

Severity

Ważność problemu.
Wartość KnownSeverity może być używana zamiennie z ważnością. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Ostrzeżenie: Problem jest ostrzeżeniem i nie uniemożliwia zastosowania konfiguracji.
Błąd: Problem jest błędem i uniemożliwia zastosowanie konfiguracji.

SharedPrivateLinkResourceProvisioningState

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.
KnownSharedPrivateLinkResourceProvisioningState może być używany zamiennie z SharedPrivateLinkResourceProvisioningState, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Aktualizacja: Udostępniony zasób łącza prywatnego jest w trakcie tworzenia wraz z innymi zasobami, aby był w pełni funkcjonalny.
Usuwanie: Zasób udostępnionego łącza prywatnego jest w trakcie usuwania.
Niepowodzenie: Nie można aprowizować ani usunąć udostępnionego zasobu łącza prywatnego.
Powodzenie: udostępniony zasób łącza prywatnego zakończył aprowizację i jest gotowy do zatwierdzenia.
Niekompletne: żądanie aprowizacji dla udostępnionego zasobu łącza prywatnego zostało zaakceptowane, ale proces tworzenia jeszcze się nie rozpoczął.

SharedPrivateLinkResourceStatus

Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.
KnownSharedPrivateLinkResourceStatus można używać zamiennie z atrybutem SharedPrivateLinkResourceStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Oczekujące: Udostępniony zasób łącza prywatnego został utworzony i oczekuje na zatwierdzenie.
Zatwierdzone: Udostępniony zasób łącza prywatnego jest zatwierdzony i gotowy do użycia.
Odrzucony: Udostępniony zasób łącza prywatnego został odrzucony i nie można go użyć.
Rozłączono: zasób udostępnionego łącza prywatnego został usunięty z usługi.

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": podobny do standardowego, 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 z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. 'storage_optimized_l2': Obsługuje 2TB na partycję, do 12 partycji. 'serverless': Tier serverless z możliwością automatycznego skalowania.
KnownSkuName może być używany zamiennie z SkuName, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Bezpłatna: Warstwa Bezpłatna bez gwarancji SLA i podzbiorem funkcji oferowanych w warstwach rozliczanych.
Podstawowa: Warstwa rozliczana dla dedykowanej usługi z maksymalnie 3 replikami.
Standardowa: Warstwa rozliczana dla dedykowanej usługi z maksymalnie 12 partycjami i 12 replikami.
standard2: podobny do "standardowego", 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 partycjami z większą liczbą indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity").
storage_optimized_l1: Rozliczana warstwa dla dedykowanej usługi, która obsługuje 1 TB na partycję, do 12 partycji.
storage_optimized_l2: Rozliczana warstwa dla dedykowanej usługi, która obsługuje 2 TB na partycję, maksymalnie 12 partycji.
serwerless: Tier bezserwerowy, oferujący doświadczenie o niskim kontakcie, konsumpcji i płatności na bieżąco, z możliwością automatycznego skalowania.

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.
KnownUnavailableNameReason można używać zamiennie z unavailableNameReason, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Nieprawidłowa: 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.

UpgradeAvailable

Wskazuje, czy dedykowana usługa wyszukiwania ma dostępną aktualizację.
KnownUpgradeAvailable może być używany zamiennie z UpgradeAvailable, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

niedostępne: Obecnie nie jest dostępna aktualizacja dedykowanej usługi.
dostępność: Dostępna jest aktualizacja dedykowanej usługi.

Wyliczenia

AzureClouds

Enum opisujące środowiska Azure Cloud.

KnownAccessRuleDirection

Reguła kierunku dostępu

KnownActionType

Rozszerzalne wyliczenie. Wskazuje typ akcji. „Internal” oznacza działania przeznaczone wyłącznie dla interfejsów API do użytku wewnętrznego.

KnownComputeType

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

KnownCreatedByType

Rodzaj jednostki, która utworzyła zasób.

KnownIdentityType

Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno tożsamość utworzoną przez system, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" spowoduje usunięcie wszystkich tożsamości z usługi.

KnownIssueType

Typ problemu

KnownKnowledgeRetrieval

Określa plan rozliczeń dla wyszukiwania agentycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.

KnownNetworkSecurityPerimeterConfigurationProvisioningState

Stan aprowizacji konfiguracji obwodowej zabezpieczeń sieci, która jest tworzona lub aktualizowana.

KnownOrigin

Zamierzony podmiot wykonujący operację; na przykład w interfejsie użytkownika kontroli dostępu opartej na zasobach (RBAC) oraz dzienników audytu. Wartość domyślna to "użytkownik,system"

KnownPrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie, Niekompletne lub Anulowane.

KnownPublicNetworkAccess

Tę wartość można ustawić na wartość "Włączone", aby uniknąć zmian powodujących niezgodność w istniejących zasobach i szablonach klienta. W przypadku ustawienia opcji "Wyłączone" ruch przez interfejs publiczny nie jest dozwolony, a połączenia z prywatnymi punktami końcowymi będą wyłączną metodą dostępu.

KnownResourceAssociationAccessMode

Tryb dostępu skojarzenia zasobu

KnownSearchBypass

Możliwe źródła ruchu przychodzącego, które mogą pominąć reguły zdefiniowane w sekcji "ipRules".

KnownSearchDataExfiltrationProtection

Specyficzny scenariusz wyciągania danych, który jest wyłączony dla usługi.

KnownSearchSemanticSearch

Określa dostępność i plan rozliczeń dla wyszukiwania semantycznego w usłudze Wyszukiwanie AI platformy Azure. Ta konfiguracja jest dostępna tylko dla określonych poziomów cenowych w określonych regionach.

KnownSeverity

Ważność problemu.

KnownSharedPrivateLinkResourceProvisioningState

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.

KnownSharedPrivateLinkResourceStatus

Stan udostępnionego zasobu łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

KnownSkuName

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": podobny do standardowego, 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 z większą większa większa liczba indeksów, jeśli ustawisz również właściwość hostingMode na wartość "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. 'storage_optimized_l2': Obsługuje 2TB na partycję, do 12 partycji. 'serverless': Tier serverless z możliwością automatycznego skalowania.

KnownUnavailableNameReason

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.

KnownUpgradeAvailable

Wskazuje, czy dedykowana usługa wyszukiwania ma dostępną aktualizację.

KnownVersions

Dostępne wersje interfejsu API.

Funkcje

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

restorePoller<TResponse, TResult>(SearchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

Zmienne

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Szczegóły funkcji

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e is RestError

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e is RestError

restorePoller<TResponse, TResult>(SearchManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

function restorePoller<TResponse, TResult>(client: SearchManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametry

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Zwraca

PollerLike<OperationState<TResult>, TResult>

Szczegóły zmiennej

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

RestError: RestErrorConstructor

Typ