@azure/arm-search package
Klasy
| SearchManagementClient |
Interfejsy
| AccessRule |
Reguła dostępu w profilu konfiguracji obwodu zabezpieczeń sieci |
| AccessRuleProperties |
Właściwości reguły dostępu |
| AccessRulePropertiesSubscriptionsItem |
Identyfikatory subskrypcji |
| AdminKeyResult |
Odpowiedź zawierająca podstawowe i pomocnicze klucze interfejsu API administratora dla danej usługi Azure AI Search. |
| AdminKeys |
Interfejs reprezentujący klucz administracyjny. |
| AdminKeysGetOptionalParams |
Parametry opcjonalne. |
| AdminKeysRegenerateOptionalParams |
Parametry opcjonalne. |
| AsyncOperationResult |
Szczegóły długotrwałej operacji asynchronicznego udostępnionego 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 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 Azure AI Search. |
| ListQueryKeysResult |
Odpowiedź zawierająca klucze interfejsu API zapytań dla danej usługi Azure AI Search. |
| NetworkRuleSet |
Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi Azure AI Search. |
| NetworkSecurityPerimeter |
Informacje o obwodzie zabezpieczeń sieci (NSP) |
| NetworkSecurityPerimeterConfiguration |
Zasób konfiguracji obwodu zabezpieczeń sieci (NSP) |
| NetworkSecurityPerimeterConfigurationListResult |
Wynik żądania konfiguracji NSP (obwodu zabezpieczeń sieci). |
| NetworkSecurityPerimeterConfigurationProperties |
Właściwości konfiguracji zabezpieczeń sieci. |
| NetworkSecurityPerimeterConfigurations |
Interfejs reprezentujący networkSecurityPerimeterConfigurations. |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
Parametry opcjonalne. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams |
Parametry opcjonalne. |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
Parametry opcjonalne. |
| NetworkSecurityPerimeterConfigurationsReconcileHeaders |
Definiuje nagłówki dla operacji NetworkSecurityPerimeterConfigurations_reconcile. |
| 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 o wyświetlaniu dla tej konkretnej operacji. |
| 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 AI Search. |
| PrivateEndpointConnectionListResult |
Odpowiedź zawierająca listę połączeń prywatnych punktów końcowych. |
| 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. |
| 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 AI Search. |
| PrivateLinkResourceProperties |
Opisuje właściwości obsługiwanego zasobu łącza prywatnego dla usługi Azure AI 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. |
| 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 Azure AI Search, która przekazuje uprawnienia tylko do odczytu w kolekcji dokumentacji indeksu. |
| 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. |
| QuotaUsageResultName |
Nazwa jednostki SKU obsługiwanej przez usługę Azure AI Search. |
| QuotaUsagesListResult |
Odpowiedź zawierająca informacje o użyciu limitu przydziału dla wszystkich obsługiwanych jednostek SKU usługi Azure AI Search. |
| Resource |
Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager |
| ResourceAssociation |
Informacje o skojarzeniu zasobów |
| SearchManagementClientOptionalParams |
Parametry opcjonalne. |
| SearchManagementRequestOptions |
Grupa parametrów |
| SearchService |
Opisuje usługę Azure AI Search i jej bieżący stan. |
| SearchServiceListResult |
Odpowiedź zawierająca listę usług Azure AI Search. |
| SearchServiceUpdate |
Parametry używane do aktualizowania usługi Azure AI 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. |
| ServicesUpgradeHeaders |
Definiuje nagłówki dla operacji Services_upgrade. |
| 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ę Azure AI Search. |
| ShareablePrivateLinkResourceType |
Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego obsługiwany przez usługę Azure AI Search. |
| SharedPrivateLinkResource |
Opisuje udostępniony zasób łącza prywatnego zarządzany przez usługę Azure AI Search. |
| SharedPrivateLinkResourceListResult |
Odpowiedź zawierająca listę udostępnionych zasobów łącza prywatnego. |
| SharedPrivateLinkResourceProperties |
Opisuje właściwości istniejącego udostępnionego zasobu łącza prywatnego zarządzanego przez usługę Azure AI 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 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. |
| Usages |
Interfejs reprezentujący użycie. |
| UsagesListBySubscriptionNextOptionalParams |
Parametry opcjonalne. |
| UsagesListBySubscriptionOptionalParams |
Parametry opcjonalne. |
| UserAssignedIdentity |
Właściwości tożsamości przypisanej przez użytkownika |
Aliasy typu
| AadAuthFailureMode |
Definiuje wartości dla elementu AadAuthFailureMode. |
| AccessRuleDirection |
Definiuje wartości accessRuleDirection. Znane wartości obsługiwane przez usługę
ruchu przychodzącego: dotyczy przychodzącego ruchu sieciowego do zabezpieczonych zasobów. |
| ActionType |
Definiuje wartości typu ActionType. Znane wartości obsługiwane przez usługęInternal |
| AdminKeyKind |
Definiuje wartości adminKeyKind. |
| AdminKeysGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| AdminKeysRegenerateResponse |
Zawiera dane odpowiedzi dla operacji ponownego generowania. |
| ComputeType |
Definiuje wartości parametru ComputeType. Znane wartości obsługiwane przez usługę
default: Utwórz usługę z domyślnymi obliczeniami. |
| CreatedByType |
Definiuje wartości createdByType. Znane wartości obsługiwane przez usługę
User |
| HostingMode |
Definiuje wartości dla elementu HostingMode. |
| IdentityType |
Definiuje wartości typu IdentityType. Znane wartości obsługiwane przez usługę
Brak: wskazuje, że należy usunąć wszystkie tożsamości skojarzone z usługą wyszukiwania. |
| IssueType |
Definiuje wartości parametru IssueType. Znane wartości obsługiwane przez usługę
Nieznany: nieznany typ problemu |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Definiuje wartości parametru NetworkSecurityPerimeterConfigurationProvisioningState. Znane wartości obsługiwane przez usługę
Succeeded |
| NetworkSecurityPerimeterConfigurationsGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextResponse |
Zawiera dane odpowiedzi dla operacji listByServiceNext. |
| NetworkSecurityPerimeterConfigurationsListByServiceResponse |
Zawiera dane odpowiedzi dla operacji listByService. |
| NetworkSecurityPerimeterConfigurationsReconcileResponse |
Zawiera dane odpowiedzi dla operacji uzgadniania. |
| OperationsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| Origin |
Definiuje wartości dla źródła. Znane wartości obsługiwane przez usługę
user |
| 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. 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. |
| PrivateLinkServiceConnectionStatus |
Definiuje wartości parametru PrivateLinkServiceConnectionStatus. |
| ProvisioningState |
Definiuje wartości parametru ProvisioningState. |
| PublicNetworkAccess |
Definiuje wartości dla funkcji PublicNetworkAccess. Znane wartości obsługiwane przez usługę
włączone: usługa wyszukiwania jest dostępna z ruchu pochodzącego z publicznego Internetu. |
| QueryKeysCreateResponse |
Zawiera dane odpowiedzi dla operacji tworzenia. |
| QueryKeysListBySearchServiceNextResponse |
Zawiera dane odpowiedzi dla operacji listBySearchServiceNext. |
| QueryKeysListBySearchServiceResponse |
Zawiera dane odpowiedzi dla operacji listBySearchService. |
| ResourceAssociationAccessMode |
Definiuje wartości resourceAssociationAccessMode. 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 |
| SearchBypass |
Definiuje wartości dla SearchBypass. 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. |
| SearchDataExfiltrationProtection |
Definiuje wartości dla SearchDataExfiltrationProtection. Znane wartości obsługiwane przez usługęBlockAll: wskazuje, że wszystkie scenariusze eksfiltracji danych są wyłączone. |
| SearchEncryptionComplianceStatus |
Definiuje wartości elementu SearchEncryptionComplianceStatus. |
| SearchEncryptionWithCmk |
Definiuje wartości dla elementu SearchEncryptionWithCmk. |
| SearchSemanticSearch |
Definiuje wartości searchSemanticSearch. Znane wartości obsługiwane przez usługę
disabled: wskazuje, że semantyczne reranker jest wyłączony dla usługi wyszukiwania. Jest to wartość domyślna. |
| 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. |
| ServicesUpgradeResponse |
Zawiera dane odpowiedzi dla operacji uaktualniania. |
| Severity |
Definiuje wartości ważności. Znane wartości obsługiwane przez usługę
Warning |
| SharedPrivateLinkResourceAsyncOperationResult |
Definiuje wartości sharedPrivateLinkResourceAsyncOperationResult. Znane wartości obsługiwane przez usługę
Running |
| SharedPrivateLinkResourceProvisioningState |
Definiuje wartości parametru SharedPrivateLinkResourceProvisioningState. 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. |
| SharedPrivateLinkResourceStatus |
Definiuje wartości sharedPrivateLinkResourceStatus. Znane wartości obsługiwane przez usługę
Oczekujące: Udostępniony zasób łącza prywatnego został utworzony i oczekuje na zatwierdzenie. |
| 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. Znane wartości obsługiwane przez usługę
Bezpłatna: Warstwa Bezpłatna bez gwarancji SLA i podzbiorem funkcji oferowanych w warstwach rozliczanych. |
| UnavailableNameReason |
Definiuje wartości elementu UnavailableNameReason. Znane wartości obsługiwane przez usługę
Nieprawidłowa: nazwa usługi wyszukiwania nie jest zgodna z wymaganiami dotyczącymi nazewnictwa. |
| UpgradeAvailable |
Definiuje wartości dla parametru UpgradeAvailable. Znane wartości obsługiwane przez usługę
notAvailable: Uaktualnienie usługi nie jest obecnie dostępne. |
| UsageBySubscriptionSkuResponse |
Zawiera dane odpowiedzi dla operacji usageBySubscriptionSku. |
| UsagesListBySubscriptionNextResponse |
Zawiera dane odpowiedzi dla operacji listBySubscriptionNext. |
| UsagesListBySubscriptionResponse |
Zawiera dane odpowiedzi dla operacji listBySubscription. |
Wyliczenia
Funkcje
| get |
Biorąc pod uwagę ostatni |
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ń.