Sdílet prostřednictvím


@azure/arm-search package

Třídy

SearchManagementClient

Rozhraní

AdminKeyResult

Odpověď obsahující primární a sekundární klíče rozhraní API pro správu pro danou službu Azure Cognitive Search

AdminKeys

Rozhraní představující AdminKeys.

AdminKeysGetOptionalParams

Volitelné parametry.

AdminKeysRegenerateOptionalParams

Volitelné parametry.

AsyncOperationResult

Podrobnosti dlouhotrvající asynchronní operace sdíleného prostředku 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 Azure Active Directory.

DataPlaneAuthOptions

Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

EncryptionWithCmk

Popisuje zásadu, která určuje způsob šifrování prostředků v rámci vyhledávací služby pomocí klíčů spravovaných zákazníkem.

Identity

Identita prostředku

IpRule

Pravidlo omezení PROTOKOLU IP služby Azure Cognitive Search.

ListQueryKeysResult

Odpověď obsahující klíče rozhraní API dotazu pro danou službu Azure Cognitive Search

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak je možné dosáhnout služby Azure Cognitive Search.

Operation

Popisuje operaci rozhraní REST API.

OperationDisplay

Objekt, který popisuje 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 existující připojení privátního koncového bodu ke službě Azure Cognitive Search.

PrivateEndpointConnectionListResult

Odpověď obsahující seznam připojení privátního koncového bodu

PrivateEndpointConnectionProperties

Popisuje vlastnosti existujícího připojení privátního koncového bodu ke službě Azure Cognitive Search.

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 Private Link k privátnímu koncovému bodu Azure.

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 Cognitive Search.

PrivateLinkResourceProperties

Popisuje vlastnosti podporovaného prostředku privátního propojení pro službu Azure Cognitive 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

QueryKey

Popisuje klíč rozhraní API pro danou službu Azure Cognitive Search, která má oprávnění pouze pro operace dotazů.

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 podporovanou službou Azure Cognitive Search.

QuotaUsageResultName

Název skladové položky podporované službou Azure Cognitive Search.

QuotaUsagesListResult

Odpověď obsahující informace o využití kvóty pro všechny podporované skladové položky služby Azure Cognitive Search

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru

SearchManagementClientOptionalParams

Volitelné parametry.

SearchManagementRequestOptions

Skupina parametrů

SearchService

Popisuje službu Azure Cognitive Search a její aktuální stav.

SearchServiceListResult

Odpověď obsahující seznam služeb Azure Cognitive Search

SearchServiceUpdate

Parametry používané k aktualizaci služby Azure Cognitive 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.

ShareablePrivateLinkResourceProperties

Popisuje vlastnosti typu prostředku, který byl onboardovaný do služby private link podporovaný službou Azure Cognitive Search.

ShareablePrivateLinkResourceType

Popisuje typ prostředku, který byl onboardován do služby private link podporované službou Azure Cognitive Search.

SharedPrivateLinkResource

Popisuje prostředek sdíleného privátního propojení spravovaný službou Azure Cognitive Search.

SharedPrivateLinkResourceListResult

Odpověď obsahující seznam sdílených prostředků služby Private Link

SharedPrivateLinkResourceProperties

Popisuje vlastnosti existujícího sdíleného prostředku Private Link spravovaného službou Azure Cognitive 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 služby Azure Cognitive Search, která určuje cenové úrovně a limity kapacity.

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.

Aliasy typu

AadAuthFailureMode

Definuje hodnoty pro AadAuthFailureMode.

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

HostingMode

Definuje hodnoty pro HostingMode.

IdentityType

Definuje hodnoty pro IdentityType.

OperationsListResponse

Obsahuje data odpovědí pro operaci seznamu.

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.
KnownPrivateLinkServiceConnectionProvisioningState lze použít zaměnitelně s PrivateLinkServiceConnectionProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

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í.
Odstranění: Připojení služby Private Link probíhá v procesu odstraňování.
selhalo: Připojení služby Private Link se nepodařilo zřídit nebo odstranit.
úspěšné: Připojení služby Private Link dokončilo zřizování a je připravené ke schválení.
neúplné: Žádost o zřízení prostředku připojení služby Private Link byla přijata, ale proces vytvoření ještě nebyl zahájen.
Zrušeno: Žádost o zřízení prostředku připojení služby Private Link byla zrušena.

PrivateLinkServiceConnectionStatus

Definuje hodnoty pro PrivateLinkServiceConnectionStatus.

ProvisioningState

Definuje hodnoty pro ProvisioningState.

PublicNetworkAccess

Definuje hodnoty pro PublicNetworkAccess.

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.

SearchEncryptionComplianceStatus

Definuje hodnoty pro SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

Definuje hodnoty pro SearchEncryptionWithCmk.

SearchSemanticSearch

Definuje hodnoty pro SearchSemanticSearch.
PoleSearchSemanticSearch lze použít zaměnitelně s SearchSemanticSearch, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

zakázáno: Indikuje, že sémantické vyhledávání je pro vyhledávací službu zakázáno.
bezplatné: Povolí sémantické vyhledávání ve vyhledávací službě a indikuje, že se má používat v rámci limitů úrovně Free. To by limitoval objem sémantických žádostí o vyhledávání a nabízí se bez dalších poplatků. Toto je výchozí hodnota pro nově zřízené vyhledávací služby.
standardní: Umožňuje sémantické vyhledávání vyhledávací služby jako fakturovatelnou funkci s vyšší propustností a objemem sémantických vyhledávacích dotazů.

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.

SharedPrivateLinkResourceAsyncOperationResult

Definuje hodnoty pro SharedPrivateLinkResourceAsyncOperationResult.
PoleSharedPrivateLinkResourceAsyncOperationResult lze použít zaměnitelně s SharedPrivateLinkResourceAsyncOperationResult, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

spuštěné
úspěšné
selhalo

SharedPrivateLinkResourceProvisioningState

Definuje hodnoty pro SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

Definuje hodnoty pro SharedPrivateLinkResourceStatus.

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.

UnavailableNameReason

Definuje hodnoty pro UnavailableNameReason.
PoleUnavailableNameReason lze použít zaměnitelně s UnavailableNameReason, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Neplatný: Název vyhledávací služby neodpovídá požadavkům na pojmenování.
AlreadyExists: Název vyhledávací služby je již přiřazen k jiné vyhledávací službě.

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

KnownPrivateLinkServiceConnectionProvisioningState

Známé hodnoty PrivateLinkServiceConnectionProvisioningState, které služba přijímá.

KnownSearchSemanticSearch

Známé hodnoty SearchSemanticSearch, které služba přijímá.

KnownSharedPrivateLinkResourceAsyncOperationResult

Známé hodnoty SharedPrivateLinkResourceAsyncOperationResult, které služba přijímá.

KnownUnavailableNameReason

Známé hodnoty UnavailableNameReason, které služba přijímá.

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

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