@azure/arm-search package

Klasser

SearchManagementClient

Gränssnitt

AdminKeyResult	Svar som innehåller de primära och sekundära API-nycklarna för administratörer för en viss Azure Cognitive Search tjänst.
AdminKeys	Gränssnitt som representerar en AdminKeys.
AdminKeysGetOptionalParams	Valfria parametrar.
AdminKeysRegenerateOptionalParams	Valfria parametrar.
AsyncOperationResult	Information om en långvarig asynkron resursåtgärd för delad privat länk
CheckNameAvailabilityInput	Indata för API:et för tillgänglighet för kontrollnamn.
CheckNameAvailabilityOutput	Utdata från API:et för tillgänglighet för kontrollnamn.
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
DataPlaneAadOrApiKeyAuthOption	Anger att antingen API-nyckeln eller en åtkomsttoken från Azure Active Directory kan användas för autentisering.
DataPlaneAuthOptions	Definierar alternativen för hur dataplanets API för en tjänsten Search autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på true.
EncryptionWithCmk	Beskriver en princip som avgör hur resurser i söktjänsten ska krypteras med kundhanterade nycklar.
Identity	Identitet för resursen.
IpRule	IP-begränsningsregeln för Azure Cognitive Search-tjänsten.
ListQueryKeysResult	Svar som innehåller fråge-API-nycklar för en viss Azure Cognitive Search-tjänst.
NetworkRuleSet	Nätverksspecifika regler som avgör hur den Azure Cognitive Search tjänsten kan nås.
Operation	Beskriver en REST API-åtgärd.
OperationDisplay	Objektet som beskriver åtgärden.
OperationListResult	Resultatet av begäran om att lista REST API-åtgärder. Den innehåller en lista över åtgärder och en URL för att hämta nästa uppsättning resultat.
Operations	Gränssnitt som representerar en åtgärd.
OperationsListOptionalParams	Valfria parametrar.
PrivateEndpointConnection	Beskriver en befintlig privat slutpunktsanslutning till Azure Cognitive Search-tjänsten.
PrivateEndpointConnectionListResult	Svar som innehåller en lista över privata slutpunktsanslutningar.
PrivateEndpointConnectionProperties	Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till Azure Cognitive Search-tjänsten.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Den privata slutpunktsresursen från Microsoft.Network-providern.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Beskriver det aktuella tillståndet för en befintlig Private Link Service-anslutning till den privata Azure-slutpunkten.
PrivateEndpointConnections	Gränssnitt som representerar en PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsGetOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsListByServiceNextOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsListByServiceOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsUpdateOptionalParams	Valfria parametrar.
PrivateLinkResource	Beskriver en privat länkresurs som stöds för Azure Cognitive Search-tjänsten.
PrivateLinkResourceProperties	Beskriver egenskaperna för en privat länkresurs som stöds för Azure Cognitive Search-tjänsten. För en viss API-version representerar detta groupId:erna som stöds när du skapar en resurs för delad privat länk.
PrivateLinkResources	Gränssnitt som representerar en PrivateLinkResources.
PrivateLinkResourcesListSupportedOptionalParams	Valfria parametrar.
PrivateLinkResourcesResult	Svar som innehåller en lista över Private Link resurser som stöds.
QueryKey	Beskriver en API-nyckel för en viss Azure Cognitive Search tjänst som endast har behörighet för frågeåtgärder.
QueryKeys	Gränssnitt som representerar en QueryKeys.
QueryKeysCreateOptionalParams	Valfria parametrar.
QueryKeysDeleteOptionalParams	Valfria parametrar.
QueryKeysListBySearchServiceNextOptionalParams	Valfria parametrar.
QueryKeysListBySearchServiceOptionalParams	Valfria parametrar.
QuotaUsageResult	Beskriver kvotanvändningen för en viss SKU som stöds av Azure Cognitive Search.
QuotaUsageResultName	Namnet på den SKU som stöds av Azure Cognitive Search.
QuotaUsagesListResult	Svar som innehåller kvotanvändningsinformation för alla sku:er som stöds i Azure Cognitive Search-tjänsten.
Resource	Vanliga fält som returneras i svaret för alla Azure-Resource Manager resurser
SearchManagementClientOptionalParams	Valfria parametrar.
SearchManagementRequestOptions	Parametergrupp
SearchService	Beskriver en Azure Cognitive Search tjänst och dess aktuella tillstånd.
SearchServiceListResult	Svar som innehåller en lista över Azure Cognitive Search tjänster.
SearchServiceUpdate	Parametrarna som används för att uppdatera en Azure Cognitive Search tjänst.
Services	Gränssnitt som representerar tjänster.
ServicesCheckNameAvailabilityOptionalParams	Valfria parametrar.
ServicesCreateOrUpdateOptionalParams	Valfria parametrar.
ServicesDeleteOptionalParams	Valfria parametrar.
ServicesGetOptionalParams	Valfria parametrar.
ServicesListByResourceGroupNextOptionalParams	Valfria parametrar.
ServicesListByResourceGroupOptionalParams	Valfria parametrar.
ServicesListBySubscriptionNextOptionalParams	Valfria parametrar.
ServicesListBySubscriptionOptionalParams	Valfria parametrar.
ServicesUpdateOptionalParams	Valfria parametrar.
ShareablePrivateLinkResourceProperties	Beskriver egenskaperna för en resurstyp som har registrerats för private link-tjänsten, som stöds av Azure Cognitive Search.
ShareablePrivateLinkResourceType	Beskriver en resurstyp som har registrerats för private link-tjänsten, som stöds av Azure Cognitive Search.
SharedPrivateLinkResource	Beskriver en delad Private Link resurs som hanteras av Azure Cognitive Search-tjänsten.
SharedPrivateLinkResourceListResult	Svar som innehåller en lista över delade Private Link resurser.
SharedPrivateLinkResourceProperties	Beskriver egenskaperna för en befintlig delad Private Link resurs som hanteras av Azure Cognitive Search-tjänsten.
SharedPrivateLinkResources	Gränssnitt som representerar en SharedPrivateLinkResources.
SharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Valfria parametrar.
SharedPrivateLinkResourcesDeleteOptionalParams	Valfria parametrar.
SharedPrivateLinkResourcesGetOptionalParams	Valfria parametrar.
SharedPrivateLinkResourcesListByServiceNextOptionalParams	Valfria parametrar.
SharedPrivateLinkResourcesListByServiceOptionalParams	Valfria parametrar.
Sku	Definierar SKU:n för en Azure Cognitive Search Service, som avgör prisnivå och kapacitetsgränser.
TrackedResource	Resursmodelldefinitionen för en Azure-Resource Manager spårad resurs på den översta nivån som har "taggar" och en "plats"
UsageBySubscriptionSkuOptionalParams	Valfria parametrar.
Usages	Gränssnitt som representerar en användning.
UsagesListBySubscriptionNextOptionalParams	Valfria parametrar.
UsagesListBySubscriptionOptionalParams	Valfria parametrar.

Typalias

AadAuthFailureMode	Definierar värden för AadAuthFailureMode.
AdminKeyKind	Definierar värden för AdminKeyKind.
AdminKeysGetResponse	Innehåller svarsdata för get-åtgärden.
AdminKeysRegenerateResponse	Innehåller svarsdata för den återskapade åtgärden.
HostingMode	Definierar värden för HostingMode.
IdentityType	Definierar värden för IdentityType.
OperationsListResponse	Innehåller svarsdata för liståtgärden.
PrivateEndpointConnectionsDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
PrivateEndpointConnectionsGetResponse	Innehåller svarsdata för get-åtgärden.
PrivateEndpointConnectionsListByServiceNextResponse	Innehåller svarsdata för åtgärden listByServiceNext.
PrivateEndpointConnectionsListByServiceResponse	Innehåller svarsdata för listByService-åtgärden.
PrivateEndpointConnectionsUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
PrivateLinkResourcesListSupportedResponse	Innehåller svarsdata för åtgärden listSupported.
PrivateLinkServiceConnectionProvisioningState	Definierar värden för PrivateLinkServiceConnectionProvisioningState. KnownPrivateLinkServiceConnectionProvisioningState kan användas utbytbart med PrivateLinkServiceConnectionProvisioningState. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Uppdatering: Den privata länktjänstanslutningen håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut. Ta bort: Den privata länktjänstens anslutning håller på att tas bort. Misslyckades: Den privata länktjänstens anslutning kunde inte etableras eller tas bort. Lyckades: Den privata länktjänstanslutningen har slutfört etableringen och är redo för godkännande. Ofullständig: Etableringsbegäran för den privata länktjänstens anslutningsresurs har accepterats, men processen för att skapa har inte påbörjats ännu. Avbröts: Etableringsbegäran för anslutningsresursen för den privata länken har avbrutits
PrivateLinkServiceConnectionStatus	Definierar värden för PrivateLinkServiceConnectionStatus.
ProvisioningState	Definierar värden för ProvisioningState.
PublicNetworkAccess	Definierar värden för PublicNetworkAccess.
QueryKeysCreateResponse	Innehåller svarsdata för skapandeåtgärden.
QueryKeysListBySearchServiceNextResponse	Innehåller svarsdata för åtgärden listBySearchServiceNext.
QueryKeysListBySearchServiceResponse	Innehåller svarsdata för åtgärden listBySearchService.
SearchEncryptionComplianceStatus	Definierar värden för SearchEncryptionComplianceStatus.
SearchEncryptionWithCmk	Definierar värden för SearchEncryptionWithCmk.
SearchSemanticSearch	Definierar värden för SearchSemanticSearch. KnownSearchSemanticSearch kan användas utbytbart med SearchSemanticSearch. Det här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten inaktiverad: Anger att semantisk sökning är inaktiverat för söktjänsten. kostnadsfri: Aktiverar semantisk sökning i en söktjänst och anger att den ska användas inom gränserna för den kostnadsfria nivån. Detta skulle begränsa mängden semantiska sökförfrågningar och erbjuds utan extra kostnad. Detta är standardvärdet för nyligen etablerade söktjänster. standard: Aktiverar semantisk sökning i en söktjänst som en fakturerbar funktion, med högre dataflöde och volym av semantiska sökfrågor.
SearchServiceStatus	Definierar värden för SearchServiceStatus.
ServicesCheckNameAvailabilityResponse	Innehåller svarsdata för åtgärden checkNameAvailability.
ServicesCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
ServicesGetResponse	Innehåller svarsdata för get-åtgärden.
ServicesListByResourceGroupNextResponse	Innehåller svarsdata för åtgärden listByResourceGroupNext.
ServicesListByResourceGroupResponse	Innehåller svarsdata för åtgärden listByResourceGroup.
ServicesListBySubscriptionNextResponse	Innehåller svarsdata för åtgärden listBySubscriptionNext.
ServicesListBySubscriptionResponse	Innehåller svarsdata för åtgärden listBySubscription.
ServicesUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
SharedPrivateLinkResourceAsyncOperationResult	Definierar värden för SharedPrivateLinkResourceAsyncOperationResult. KnownSharedPrivateLinkResourceAsyncOperationResult kan användas synonymt med SharedPrivateLinkResourceAsyncOperationResult. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Körs Lyckades Misslyckades
SharedPrivateLinkResourceProvisioningState	Definierar värden för SharedPrivateLinkResourceProvisioningState.
SharedPrivateLinkResourceStatus	Definierar värden för SharedPrivateLinkResourceStatus.
SharedPrivateLinkResourcesCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
SharedPrivateLinkResourcesGetResponse	Innehåller svarsdata för get-åtgärden.
SharedPrivateLinkResourcesListByServiceNextResponse	Innehåller svarsdata för åtgärden listByServiceNext.
SharedPrivateLinkResourcesListByServiceResponse	Innehåller svarsdata för åtgärden listByService.
SkuName	Definierar värden för SkuName.
UnavailableNameReason	Definierar värden för UnavailableNameReason. KnownUnavailableNameReason kan användas synonymt med UnavailableNameReason. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Ogiltigt: Söktjänstens namn matchar inte namngivningskraven. AlreadyExists: Söktjänstens namn har redan tilldelats till en annan söktjänst.
UsageBySubscriptionSkuResponse	Innehåller svarsdata för åtgärden usageBySubscriptionSku.
UsagesListBySubscriptionNextResponse	Innehåller svarsdata för åtgärden listBySubscriptionNext.
UsagesListBySubscriptionResponse	Innehåller svarsdata för åtgärden listBySubscription.

Uppräkningar

KnownPrivateLinkServiceConnectionProvisioningState	Kända värden för PrivateLinkServiceConnectionProvisioningState som tjänsten accepterar.
KnownSearchSemanticSearch	Kända värden för SearchSemanticSearch som tjänsten accepterar.
KnownSharedPrivateLinkResourceAsyncOperationResult	Kända värden för SharedPrivateLinkResourceAsyncOperationResult som tjänsten accepterar.
KnownUnavailableNameReason	Kända värden för UnavailableNameReason som tjänsten accepterar.

Funktioner

getContinuationToken(unknown)

Givet den senaste .value som skapades av byPage iteratorn returnerar en fortsättningstoken som kan användas för att börja sidindelning från den punkten senare.

Funktionsinformation

getContinuationToken(unknown)

Givet den senaste .value som skapades av byPage iteratorn returnerar en fortsättningstoken som kan användas för att börja sidindelning från den punkten senare.

function getContinuationToken(page: unknown): string | undefined

Parametrar

page

unknown

Ett objekt från att value komma åt iteratorResult från en byPage iterator.

Returer

string | undefined

Fortsättningstoken som kan skickas till byPage() under framtida anrop.