@azure/arm-search package

Klasy

SearchManagementClient

Interfejsy

AdminKeyResult	Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi Azure Cognitive Search.
AdminKeys	Interfejs reprezentujący klucz administracyjny.
AdminKeysGetOptionalParams	Parametry opcjonalne.
AdminKeysRegenerateOptionalParams	Parametry opcjonalne.
AsyncOperationResult	Szczegóły długotrwałej operacji asynchronicznego współużytkowanego zasobu łącza prywatnego
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 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ługi 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	Tożsamość zasobu.
IpRule	Reguła ograniczeń adresów IP usługi Azure Cognitive Search.
ListQueryKeysResult	Odpowiedź zawierająca klucze interfejsu API zapytania dla danej usługi Azure Cognitive Search.
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.
OperationDisplay	Obiekt opisujący operację.
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.
Operations	Interfejs reprezentujący operacje.
OperationsListOptionalParams	Parametry opcjonalne.
PrivateEndpointConnection	Opisuje istniejące połączenie prywatnego punktu końcowego z usługą Azure Cognitive Search.
PrivateEndpointConnectionListResult	Odpowiedź zawierająca listę połączeń prywatnego punktu końcowego.
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.
PrivateEndpointConnections	Interfejs reprezentujący element PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsGetOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsListByServiceNextOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsListByServiceOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsUpdateOptionalParams	Parametry opcjonalne.
PrivateLinkResource	Opisuje obsługiwany zasób łącza prywatnego dla usługi Azure Cognitive Search.
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.
PrivateLinkResources	Interfejs reprezentujący element PrivateLinkResources.
PrivateLinkResourcesListSupportedOptionalParams	Parametry opcjonalne.
PrivateLinkResourcesResult	Odpowiedź zawierająca listę obsługiwanych zasobów usługi Private Link.
QueryKey	Opisuje klucz interfejsu API dla danej usługi Azure Cognitive Search, która ma uprawnienia tylko do operacji zapytań.
QueryKeys	Interfejs reprezentujący klucz zapytania.
QueryKeysCreateOptionalParams	Parametry opcjonalne.
QueryKeysDeleteOptionalParams	Parametry opcjonalne.
QueryKeysListBySearchServiceNextOptionalParams	Parametry opcjonalne.
QueryKeysListBySearchServiceOptionalParams	Parametry opcjonalne.
QuotaUsageResult	Opisuje użycie limitu przydziału dla określonej jednostki SKU obsługiwanej przez usługę Azure Cognitive Search.
QuotaUsageResultName	Nazwa jednostki SKU obsługiwanej przez usługę Azure Cognitive Search.
QuotaUsagesListResult	Odpowiedź zawierająca informacje o użyciu limitu przydziału dla wszystkich obsługiwanych jednostek SKU usługi Azure Cognitive Search.
Resource	Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager
SearchManagementClientOptionalParams	Parametry opcjonalne.
SearchManagementRequestOptions	Grupa parametrów
SearchService	Opisuje usługę Azure Cognitive Search i jej bieżący stan.
SearchServiceListResult	Odpowiedź zawierająca listę usług Azure Cognitive Search.
SearchServiceUpdate	Parametry używane do aktualizowania usługi Azure Cognitive Search.
Services	Interfejs reprezentujący usługi.
ServicesCheckNameAvailabilityOptionalParams	Parametry opcjonalne.
ServicesCreateOrUpdateOptionalParams	Parametry opcjonalne.
ServicesDeleteOptionalParams	Parametry opcjonalne.
ServicesGetOptionalParams	Parametry opcjonalne.
ServicesListByResourceGroupNextOptionalParams	Parametry opcjonalne.
ServicesListByResourceGroupOptionalParams	Parametry opcjonalne.
ServicesListBySubscriptionNextOptionalParams	Parametry opcjonalne.
ServicesListBySubscriptionOptionalParams	Parametry opcjonalne.
ServicesUpdateOptionalParams	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ę Azure Cognitive Search.
ShareablePrivateLinkResourceType	Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego obsługiwany przez usługę Azure Cognitive Search.
SharedPrivateLinkResource	Opisuje udostępniony zasób usługi Private Link zarządzany przez usługę Azure Cognitive Search.
SharedPrivateLinkResourceListResult	Odpowiedź zawierająca listę udostępnionych zasobów usługi Private Link.
SharedPrivateLinkResourceProperties	Opisuje właściwości istniejącego udostępnionego zasobu usługi Private Link zarządzanego przez usługę Azure Cognitive Search.
SharedPrivateLinkResources	Interfejs reprezentujący element SharedPrivateLinkResources.
SharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Parametry opcjonalne.
SharedPrivateLinkResourcesDeleteOptionalParams	Parametry opcjonalne.
SharedPrivateLinkResourcesGetOptionalParams	Parametry opcjonalne.
SharedPrivateLinkResourcesListByServiceNextOptionalParams	Parametry opcjonalne.
SharedPrivateLinkResourcesListByServiceOptionalParams	Parametry opcjonalne.
Sku	Definiuje jednostkę SKU usługi Azure Cognitive Search Service, która określa warstwę cenową i limity pojemności.
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.
Usages	Interfejs reprezentujący użycie.
UsagesListBySubscriptionNextOptionalParams	Parametry opcjonalne.
UsagesListBySubscriptionOptionalParams	Parametry opcjonalne.

Aliasy typu

AadAuthFailureMode	Definiuje wartości dla elementu AadAuthFailureMode.
AdminKeyKind	Definiuje wartości adminKeyKind.
AdminKeysGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
AdminKeysRegenerateResponse	Zawiera dane odpowiedzi dla operacji ponownego generowania.
HostingMode	Definiuje wartości dla elementu HostingMode.
IdentityType	Definiuje wartości typu IdentityType.
OperationsListResponse	Zawiera dane odpowiedzi dla operacji listy.
PrivateEndpointConnectionsDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
PrivateEndpointConnectionsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
PrivateEndpointConnectionsListByServiceNextResponse	Zawiera dane odpowiedzi dla operacji listByServiceNext.
PrivateEndpointConnectionsListByServiceResponse	Zawiera dane odpowiedzi dla operacji listByService.
PrivateEndpointConnectionsUpdateResponse	Zawiera dane odpowiedzi dla operacji aktualizacji.
PrivateLinkResourcesListSupportedResponse	Zawiera dane odpowiedzi dla operacji listSupported.
PrivateLinkServiceConnectionProvisioningState	Definiuje wartości parametru PrivateLinkServiceConnectionProvisioningState. 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 zasobu połączenia usługi łącza prywatnego zostało anulowane
PrivateLinkServiceConnectionStatus	Definiuje wartości parametru PrivateLinkServiceConnectionStatus.
ProvisioningState	Definiuje wartości parametru ProvisioningState.
PublicNetworkAccess	Definiuje wartości dla funkcji PublicNetworkAccess.
QueryKeysCreateResponse	Zawiera dane odpowiedzi dla operacji tworzenia.
QueryKeysListBySearchServiceNextResponse	Zawiera dane odpowiedzi dla operacji listBySearchServiceNext.
QueryKeysListBySearchServiceResponse	Zawiera dane odpowiedzi dla operacji listBySearchService.
SearchEncryptionComplianceStatus	Definiuje wartości elementu SearchEncryptionComplianceStatus.
SearchEncryptionWithCmk	Definiuje wartości dla elementu SearchEncryptionWithCmk.
SearchSemanticSearch	Definiuje wartości searchSemanticSearch. 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ę wyłączone: wskazuje, że wyszukiwanie semantyczne jest wyłączone dla usługi wyszukiwania. bezpłatne: włącza semantyczne wyszukiwanie w usłudze wyszukiwania i wskazuje, że ma być używany w ramach limitów warstwy Bezpłatna. Spowoduje to ograniczenie liczby semantycznych żądań wyszukiwania i jest oferowane bez dodatkowych opłat. Jest to ustawienie domyślne dla nowo aprowizowania usług wyszukiwania. standardowe: umożliwia semantyczne wyszukiwanie w usłudze wyszukiwania jako funkcję rozliczaną z wyższą przepływnością i ilością semantycznych zapytań wyszukiwania.
SearchServiceStatus	Definiuje wartości parametru SearchServiceStatus.
ServicesCheckNameAvailabilityResponse	Zawiera dane odpowiedzi dla operacji checkNameAvailability.
ServicesCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
ServicesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ServicesListByResourceGroupNextResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroupNext.
ServicesListByResourceGroupResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroup.
ServicesListBySubscriptionNextResponse	Zawiera dane odpowiedzi dla operacji listBySubscriptionNext.
ServicesListBySubscriptionResponse	Zawiera dane odpowiedzi dla operacji listBySubscription.
ServicesUpdateResponse	Zawiera dane odpowiedzi dla operacji aktualizacji.
SharedPrivateLinkResourceAsyncOperationResult	Definiuje wartości sharedPrivateLinkResourceAsyncOperationResult. KnownSharedPrivateLinkResourceAsyncOperationResult można używać zamiennie z funkcją SharedPrivateLinkResourceAsyncOperationResult, wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Uruchomiona powodzeniem niepowodzenie
SharedPrivateLinkResourceProvisioningState	Definiuje wartości parametru SharedPrivateLinkResourceProvisioningState.
SharedPrivateLinkResourceStatus	Definiuje wartości sharedPrivateLinkResourceStatus.
SharedPrivateLinkResourcesCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
SharedPrivateLinkResourcesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
SharedPrivateLinkResourcesListByServiceNextResponse	Zawiera dane odpowiedzi dla operacji listByServiceNext.
SharedPrivateLinkResourcesListByServiceResponse	Zawiera dane odpowiedzi dla operacji listByService.
SkuName	Definiuje wartości skuName.
UnavailableNameReason	Definiuje wartości elementu UnavailableNameReason. 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.
UsageBySubscriptionSkuResponse	Zawiera dane odpowiedzi dla operacji usageBySubscriptionSku.
UsagesListBySubscriptionNextResponse	Zawiera dane odpowiedzi dla operacji listBySubscriptionNext.
UsagesListBySubscriptionResponse	Zawiera dane odpowiedzi dla operacji listBySubscription.

Wyliczenia

KnownPrivateLinkServiceConnectionProvisioningState	Znane wartości PrivateLinkServiceConnectionProvisioningState, które akceptuje usługa.
KnownSearchSemanticSearch	Znane wartości SearchSemanticSearch, które akceptuje usługa.
KnownSharedPrivateLinkResourceAsyncOperationResult	Znane wartości SharedPrivateLinkResourceAsyncOperationResult, które akceptuje usługa.
KnownUnavailableNameReason	Znane wartości UnavailableNameReason, które akceptuje usługa.

Funkcje

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez iterator byPage, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

Szczegóły funkcji

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez iterator byPage, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Obiekt z uzyskiwania dostępu do value w iteratorzeResult z iteratora byPage.

Zwraca

string | undefined

Token kontynuacji, który można przekazać do elementu byPage() podczas przyszłych wywołań.