@azure/arm-search package
Třídy
| SearchManagementClient |
Rozhraní
| AccessRule |
Pravidlo přístupu v konfiguračním profilu zabezpečení sítě |
| AccessRuleProperties |
Vlastnosti pravidla přístupu |
| AccessRulePropertiesSubscriptionsItem |
Identifikátory předplatného |
| AdminKeyResult |
Odpověď obsahující primární a sekundární klíče rozhraní API pro správu pro danou službu Azure AI Search |
| AdminKeys |
Rozhraní představující AdminKeys. |
| AdminKeysGetOptionalParams |
Volitelné parametry. |
| AdminKeysRegenerateOptionalParams |
Volitelné parametry. |
| AsyncOperationResult |
Podrobnosti o dlouhotrvající operaci prostředku asynchronního sdíleného privátního propojení. |
| CheckNameAvailabilityInput |
Vstup rozhraní API pro kontrolu dostupnosti názvu |
| CheckNameAvailabilityOutput |
Výstup rozhraní API pro kontrolu dostupnosti názvu |
| CloudError |
Obsahuje informace o chybě rozhraní API. |
| CloudErrorBody |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
| DataPlaneAadOrApiKeyAuthOption |
Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID. |
| DataPlaneAuthOptions |
Definuje možnosti, jak vyhledávací služba ověřuje požadavek roviny dat. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true. |
| EncryptionWithCmk |
Popisuje zásadu, která určuje, jak se mají prostředky ve vyhledávací službě šifrovat pomocí klíčů spravovaných zákazníkem. |
| Identity |
Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu. |
| IpRule |
Pravidlo omezení IP služby Azure AI Search. |
| ListQueryKeysResult |
Odpověď obsahující klíče rozhraní API dotazu pro danou službu Azure AI Search |
| NetworkRuleSet |
Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search. |
| NetworkSecurityPerimeter |
Informace o hraniční síti sítě (NSP) |
| NetworkSecurityPerimeterConfiguration |
Prostředek konfigurace hraniční sítě (NSP) |
| NetworkSecurityPerimeterConfigurationListResult |
Výsledek požadavku na konfiguraci NSP (zabezpečení sítě) |
| NetworkSecurityPerimeterConfigurationProperties |
Vlastnosti konfigurace zabezpečení sítě |
| NetworkSecurityPerimeterConfigurations |
Rozhraní představující NetworkSecurityPerimeterConfigurations. |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
Volitelné parametry. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams |
Volitelné parametry. |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
Volitelné parametry. |
| NetworkSecurityPerimeterConfigurationsReconcileHeaders |
Definuje hlavičky pro operaci NetworkSecurityPerimeterConfigurations_reconcile. |
| NetworkSecurityPerimeterConfigurationsReconcileOptionalParams |
Volitelné parametry. |
| NetworkSecurityProfile |
Profil konfigurace hraniční sítě zabezpečení sítě |
| Operation |
Podrobnosti o operaci ROZHRANÍ REST API vrácené z rozhraní API pro operace poskytovatele prostředků |
| OperationDisplay |
Lokalizované informace o zobrazení pro tuto konkrétní operaci |
| OperationListResult |
Výsledek požadavku na výpis operací rozhraní REST API. Obsahuje seznam operací a adresu URL pro získání další sady výsledků. |
| Operations |
Rozhraní představující operace |
| OperationsListOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnection |
Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search. |
| PrivateEndpointConnectionListResult |
Odpověď obsahující seznam připojení privátních koncových bodů |
| PrivateEndpointConnectionProperties |
Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě. |
| PrivateEndpointConnectionPropertiesPrivateEndpoint |
Prostředek privátního koncového bodu od poskytovatele Microsoft.Network. |
| PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState |
Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu. |
| PrivateEndpointConnections |
Rozhraní představující PrivateEndpointConnections |
| PrivateEndpointConnectionsDeleteOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsGetOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsListByServiceNextOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsListByServiceOptionalParams |
Volitelné parametry. |
| PrivateEndpointConnectionsUpdateOptionalParams |
Volitelné parametry. |
| PrivateLinkResource |
Popisuje podporovaný prostředek privátního propojení pro službu Azure AI Search. |
| PrivateLinkResourceProperties |
Popisuje vlastnosti podporovaného prostředku privátního propojení pro službu Azure AI Search. Pro danou verzi rozhraní API to představuje "podporované" id skupiny při vytváření prostředku sdíleného privátního propojení. |
| PrivateLinkResources |
Rozhraní představující PrivateLinkResources |
| PrivateLinkResourcesListSupportedOptionalParams |
Volitelné parametry. |
| PrivateLinkResourcesResult |
Odpověď obsahující seznam podporovaných prostředků private linku |
| ProvisioningIssue |
Popisuje problém se zřizováním konfigurace hraniční sítě zabezpečení sítě. |
| ProvisioningIssueProperties |
Podrobnosti o problému se zřizováním konfigurace hraniční sítě (NSP) zabezpečení sítě Poskytovatelé prostředků by měli pro každý zjištěný samostatný problém generovat samostatné prvky problému zřizování a měly by obsahovat smysluplný a výrazný popis, stejně jako všechny vhodné navrhované IdentifikátoryResourceId a navrhované zásadyAccessRules. |
| ProxyResource |
Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění. |
| QueryKey |
Popisuje klíč rozhraní API pro danou službu Azure AI Search, která vyjadřuje oprávnění jen pro čtení v kolekci dokumentů indexu. |
| QueryKeys |
Rozhraní představující QueryKeys. |
| QueryKeysCreateOptionalParams |
Volitelné parametry. |
| QueryKeysDeleteOptionalParams |
Volitelné parametry. |
| QueryKeysListBySearchServiceNextOptionalParams |
Volitelné parametry. |
| QueryKeysListBySearchServiceOptionalParams |
Volitelné parametry. |
| QuotaUsageResult |
Popisuje využití kvóty pro konkrétní skladovou položku. |
| QuotaUsageResultName |
Název skladové položky podporované službou Azure AI Search. |
| QuotaUsagesListResult |
Odpověď obsahující informace o využití kvóty pro všechny podporované skladové položky služby Azure AI Search |
| Resource |
Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru |
| ResourceAssociation |
Informace o přidružení prostředků |
| SearchManagementClientOptionalParams |
Volitelné parametry. |
| SearchManagementRequestOptions |
Skupina parametrů |
| SearchService |
Popisuje službu Azure AI Search a její aktuální stav. |
| SearchServiceListResult |
Odpověď obsahující seznam služeb Azure AI Search |
| SearchServiceUpdate |
Parametry používané k aktualizaci služby Azure AI Search. |
| Services |
Rozhraní představující služby |
| ServicesCheckNameAvailabilityOptionalParams |
Volitelné parametry. |
| ServicesCreateOrUpdateOptionalParams |
Volitelné parametry. |
| ServicesDeleteOptionalParams |
Volitelné parametry. |
| ServicesGetOptionalParams |
Volitelné parametry. |
| ServicesListByResourceGroupNextOptionalParams |
Volitelné parametry. |
| ServicesListByResourceGroupOptionalParams |
Volitelné parametry. |
| ServicesListBySubscriptionNextOptionalParams |
Volitelné parametry. |
| ServicesListBySubscriptionOptionalParams |
Volitelné parametry. |
| ServicesUpdateOptionalParams |
Volitelné parametry. |
| ServicesUpgradeHeaders |
Definuje hlavičky pro Services_upgrade operaci. |
| ServicesUpgradeOptionalParams |
Volitelné parametry. |
| ShareablePrivateLinkResourceProperties |
Popisuje vlastnosti typu prostředku, který byl onboardován do služby private link podporované službou Azure AI Search. |
| ShareablePrivateLinkResourceType |
Popisuje typ prostředku, který byl onboardován do služby private link podporované službou Azure AI Search. |
| SharedPrivateLinkResource |
Popisuje sdílený prostředek privátního propojení spravovaný službou Azure AI Search. |
| SharedPrivateLinkResourceListResult |
Odpověď obsahující seznam sdílených prostředků privátního propojení |
| SharedPrivateLinkResourceProperties |
Popisuje vlastnosti existujícího sdíleného prostředku privátního propojení spravovaného službou Azure AI Search. |
| SharedPrivateLinkResources |
Rozhraní představující SharedPrivateLinkResources |
| SharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
Volitelné parametry. |
| SharedPrivateLinkResourcesDeleteOptionalParams |
Volitelné parametry. |
| SharedPrivateLinkResourcesGetOptionalParams |
Volitelné parametry. |
| SharedPrivateLinkResourcesListByServiceNextOptionalParams |
Volitelné parametry. |
| SharedPrivateLinkResourcesListByServiceOptionalParams |
Volitelné parametry. |
| Sku |
Definuje skladovou položku vyhledávací služby, která určuje fakturační sazbu a limity kapacity. |
| SystemData |
Metadata týkající se vytvoření a poslední změny prostředku. |
| TrackedResource |
Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění. |
| UsageBySubscriptionSkuOptionalParams |
Volitelné parametry. |
| Usages |
Rozhraní představující využití |
| UsagesListBySubscriptionNextOptionalParams |
Volitelné parametry. |
| UsagesListBySubscriptionOptionalParams |
Volitelné parametry. |
| UserAssignedIdentity |
Vlastnosti identity přiřazené uživatelem |
Aliasy typu
| AadAuthFailureMode |
Definuje hodnoty pro AadAuthFailureMode. |
| AccessRuleDirection |
Definuje hodnoty pro AccessRuleDirection. Známé hodnoty podporované službou
Příchozí: Platí pro příchozí síťový provoz na zabezpečené prostředky. |
| ActionType |
Definuje hodnoty pro ActionType. Známé hodnoty podporované službouInternal |
| AdminKeyKind |
Definuje hodnoty pro AdminKeyKind. |
| AdminKeysGetResponse |
Obsahuje data odpovědí pro operaci get. |
| AdminKeysRegenerateResponse |
Obsahuje data odpovědí pro operaci opětovného vygenerování. |
| ComputeType |
Definuje hodnoty pro ComputeType. Známé hodnoty podporované službou
default: Vytvořte službu s výchozím výpočetním prostředím. |
| CreatedByType |
Definuje hodnoty pro CreatedByType. Známé hodnoty podporované službou
User |
| HostingMode |
Definuje hodnoty pro HostingMode. |
| IdentityType |
Definuje hodnoty pro IdentityType. Známé hodnoty podporované službou
Žádná: Označuje, že je potřeba odebrat jakoukoli identitu přidruženou k vyhledávací službě. |
| IssueType |
Definuje hodnoty pro IssueType. Známé hodnoty podporované službou
Neznámý: Neznámý typ problému |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Definuje hodnoty pro NetworkSecurityPerimeterConfigurationProvisioningState. Známé hodnoty podporované službou
Succeeded |
| NetworkSecurityPerimeterConfigurationsGetResponse |
Obsahuje data odpovědí pro operaci get. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextResponse |
Obsahuje data odpovědi pro operaci listByServiceNext. |
| NetworkSecurityPerimeterConfigurationsListByServiceResponse |
Obsahuje data odpovědi pro operaci listByService. |
| NetworkSecurityPerimeterConfigurationsReconcileResponse |
Obsahuje data odpovědí pro operaci odsouhlasení. |
| OperationsListResponse |
Obsahuje data odpovědí pro operaci seznamu. |
| Origin |
Definuje hodnoty pro Origin. Známé hodnoty podporované službou
user |
| PrivateEndpointConnectionsDeleteResponse |
Obsahuje data odpovědí pro operaci odstranění. |
| PrivateEndpointConnectionsGetResponse |
Obsahuje data odpovědí pro operaci get. |
| PrivateEndpointConnectionsListByServiceNextResponse |
Obsahuje data odpovědi pro operaci listByServiceNext. |
| PrivateEndpointConnectionsListByServiceResponse |
Obsahuje data odpovědi pro operaci listByService. |
| PrivateEndpointConnectionsUpdateResponse |
Obsahuje data odpovědí pro operaci aktualizace. |
| PrivateLinkResourcesListSupportedResponse |
Obsahuje data odpovědi pro operaci listSupported. |
| PrivateLinkServiceConnectionProvisioningState |
Definuje hodnoty pro PrivateLinkServiceConnectionProvisioningState. Známé hodnoty podporované službou
aktualizace: Připojení služby Private Link probíhá v procesu vytváření spolu s dalšími prostředky, aby bylo plně funkční. |
| PrivateLinkServiceConnectionStatus |
Definuje hodnoty pro PrivateLinkServiceConnectionStatus. |
| ProvisioningState |
Definuje hodnoty pro ProvisioningState. |
| PublicNetworkAccess |
Definuje hodnoty pro PublicNetworkAccess. Známé hodnoty podporované službou
povoleno: Vyhledávací služba je přístupná z provozu pocházejícího z veřejného internetu. |
| QueryKeysCreateResponse |
Obsahuje data odpovědí pro operaci vytvoření. |
| QueryKeysListBySearchServiceNextResponse |
Obsahuje data odpovědi pro operaci listBySearchServiceNext. |
| QueryKeysListBySearchServiceResponse |
Obsahuje data odpovědi pro operaci listBySearchService. |
| ResourceAssociationAccessMode |
Definuje hodnoty pro ResourceAssociationAccessMode. Známé hodnoty podporované službou
vynucené: Režim vynuceného přístupu – provoz do prostředku, u kterého došlo k selhání kontrol přístupu, je blokovaný. |
| SearchBypass |
Definuje hodnoty pro SearchBypass. Známé hodnoty podporované službou
Žádný: Označuje, že žádný zdroj nemůže obejít pravidla definovaná v části 'ipRules'. Toto je výchozí hodnota. |
| SearchDataExfiltrationProtection |
Definuje hodnoty pro SearchDataExfiltrationProtection. Známé hodnoty podporované službouBlockAll: Označuje, že všechny scénáře exfiltrace dat jsou zakázány. |
| SearchEncryptionComplianceStatus |
Definuje hodnoty pro SearchEncryptionComplianceStatus. |
| SearchEncryptionWithCmk |
Definuje hodnoty pro SearchEncryptionWithCmk. |
| SearchSemanticSearch |
Definuje hodnoty pro SearchSemanticSearch. Známé hodnoty podporované službou
zakázáno: Označuje, že sémantické reranker je pro vyhledávací službu zakázané. Toto je výchozí hodnota. |
| SearchServiceStatus |
Definuje hodnoty pro SearchServiceStatus. |
| ServicesCheckNameAvailabilityResponse |
Obsahuje data odpovědí pro operaci checkNameAvailability. |
| ServicesCreateOrUpdateResponse |
Obsahuje data odpovědí pro operaci createOrUpdate. |
| ServicesGetResponse |
Obsahuje data odpovědí pro operaci get. |
| ServicesListByResourceGroupNextResponse |
Obsahuje data odpovědi pro operaci listByResourceGroupNext. |
| ServicesListByResourceGroupResponse |
Obsahuje data odpovědi pro operaci listByResourceGroup. |
| ServicesListBySubscriptionNextResponse |
Obsahuje data odpovědi pro operaci listBySubscriptionNext. |
| ServicesListBySubscriptionResponse |
Obsahuje data odpovědi pro operaci listBySubscription. |
| ServicesUpdateResponse |
Obsahuje data odpovědí pro operaci aktualizace. |
| ServicesUpgradeResponse |
Obsahuje data odpovědí pro operaci upgradu. |
| Severity |
Definuje hodnoty pro závažnost. Známé hodnoty podporované službou
Warning |
| SharedPrivateLinkResourceAsyncOperationResult |
Definuje hodnoty pro SharedPrivateLinkResourceAsyncOperationResult. Známé hodnoty podporované službou
Running |
| SharedPrivateLinkResourceProvisioningState |
Definuje hodnoty pro SharedPrivateLinkResourceProvisioningState. Známé hodnoty podporované službou
Aktualizace: Sdílený prostředek privátního propojení se právě vytváří spolu s dalšími prostředky, aby byl plně funkční. |
| SharedPrivateLinkResourceStatus |
Definuje hodnoty pro SharedPrivateLinkResourceStatus. Známé hodnoty podporované službou
Čeká na vyřízení: Prostředek sdíleného privátního odkazu byl vytvořen a čeká na schválení. |
| SharedPrivateLinkResourcesCreateOrUpdateResponse |
Obsahuje data odpovědí pro operaci createOrUpdate. |
| SharedPrivateLinkResourcesGetResponse |
Obsahuje data odpovědí pro operaci get. |
| SharedPrivateLinkResourcesListByServiceNextResponse |
Obsahuje data odpovědi pro operaci listByServiceNext. |
| SharedPrivateLinkResourcesListByServiceResponse |
Obsahuje data odpovědi pro operaci listByService. |
| SkuName |
Definuje hodnoty pro SkuName. Známé hodnoty podporované službou
free: Bezplatná úroveň bez záruk SLA a s podmnožinou funkcí nabízených na fakturovatelných úrovních. |
| UnavailableNameReason |
Definuje hodnoty pro UnavailableNameReason. Známé hodnoty podporované službou
Neplatné: Název vyhledávací služby neodpovídá požadavkům na pojmenování. |
| UpgradeAvailable |
Definuje hodnoty pro UpgradeAvailable. Známé hodnoty podporované službou
notAvailable: Upgrade pro službu není v současné době k dispozici. |
| UsageBySubscriptionSkuResponse |
Obsahuje data odpovědí pro operaci usageBySubscriptionSku. |
| UsagesListBySubscriptionNextResponse |
Obsahuje data odpovědi pro operaci listBySubscriptionNext. |
| UsagesListBySubscriptionResponse |
Obsahuje data odpovědi pro operaci listBySubscription. |
Výčty
Funkce
| get |
Vzhledem k poslednímu |
Podrobnosti funkce
getContinuationToken(unknown)
Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.
function getContinuationToken(page: unknown): string | undefined
Parametry
- page
-
unknown
Objekt z přístupu k value na IteratorResult z byPage iterátoru.
Návraty
string | undefined
Token pokračování, který lze předat do byPage() během budoucích volání.