Share via


@azure/arm-search package

Klassen

SearchManagementClient

Interfaces

AdminKeyResult

Antwoord met de primaire en secundaire beheer-API-sleutels voor een bepaalde Azure Cognitive Search-service.

AdminKeys

Interface die een AdminKeys vertegenwoordigt.

AdminKeysGetOptionalParams

Optionele parameters.

AdminKeysRegenerateOptionalParams

Optionele parameters.

AsyncOperationResult

De details van een langlopende asynchrone gedeelde private link-resourcebewerking

CheckNameAvailabilityInput

Invoer van beschikbaarheids-API voor controlenaam.

CheckNameAvailabilityOutput

Uitvoer van beschikbaarheids-API voor controlenaam.

CloudError

Bevat informatie over een API-fout.

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

DataPlaneAadOrApiKeyAuthOption

Geeft aan dat de API-sleutel of een toegangstoken van Azure Active Directory kan worden gebruikt voor verificatie.

DataPlaneAuthOptions

Definieert de opties voor de wijze waarop de gegevensvlak-API van een Search-service aanvragen verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.

EncryptionWithCmk

Beschrijft een beleid dat bepaalt hoe resources binnen de zoekservice moeten worden versleuteld met door de klant beheerde sleutels.

Identity

Identiteit voor de resource.

IpRule

De IP-beperkingsregel van de Azure Cognitive Search-service.

ListQueryKeysResult

Antwoord met de query-API-sleutels voor een bepaalde Azure Cognitive Search-service.

NetworkRuleSet

Netwerkspecifieke regels die bepalen hoe de Azure Cognitive Search service kan worden bereikt.

Operation

Beschrijft een REST API-bewerking.

OperationDisplay

Het object dat de bewerking beschrijft.

OperationListResult

Het resultaat van de aanvraag om REST API-bewerkingen weer te geven. Het bevat een lijst met bewerkingen en een URL om de volgende set resultaten op te halen.

Operations

Interface die een bewerking vertegenwoordigt.

OperationsListOptionalParams

Optionele parameters.

PrivateEndpointConnection

Beschrijft een bestaande privé-eindpuntverbinding met de Azure Cognitive Search-service.

PrivateEndpointConnectionListResult

Antwoord met een lijst met privé-eindpuntverbindingen.

PrivateEndpointConnectionProperties

Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de Azure Cognitive Search-service.

PrivateEndpointConnectionPropertiesPrivateEndpoint

De resource van het privé-eindpunt van de Microsoft.Network-provider.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Beschrijft de huidige status van een bestaande Private Link Service-verbinding met het azure-privé-eindpunt.

PrivateEndpointConnections

Interface die een PrivateEndpointConnections vertegenwoordigt.

PrivateEndpointConnectionsDeleteOptionalParams

Optionele parameters.

PrivateEndpointConnectionsGetOptionalParams

Optionele parameters.

PrivateEndpointConnectionsListByServiceNextOptionalParams

Optionele parameters.

PrivateEndpointConnectionsListByServiceOptionalParams

Optionele parameters.

PrivateEndpointConnectionsUpdateOptionalParams

Optionele parameters.

PrivateLinkResource

Beschrijft een ondersteunde Private Link-resource voor de Azure Cognitive Search-service.

PrivateLinkResourceProperties

Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de Azure Cognitive Search-service. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde privékoppelingsresource.

PrivateLinkResources

Interface die een PrivateLinkResources vertegenwoordigt.

PrivateLinkResourcesListSupportedOptionalParams

Optionele parameters.

PrivateLinkResourcesResult

Antwoord met een lijst met ondersteunde Private Link resources.

QueryKey

Beschrijft een API-sleutel voor een bepaalde Azure Cognitive Search service die alleen machtigingen heeft voor querybewerkingen.

QueryKeys

Interface die een QueryKeys vertegenwoordigt.

QueryKeysCreateOptionalParams

Optionele parameters.

QueryKeysDeleteOptionalParams

Optionele parameters.

QueryKeysListBySearchServiceNextOptionalParams

Optionele parameters.

QueryKeysListBySearchServiceOptionalParams

Optionele parameters.

QuotaUsageResult

Beschrijft het quotumgebruik voor een bepaalde SKU die wordt ondersteund door Azure Cognitive Search.

QuotaUsageResultName

De naam van de SKU die wordt ondersteund door Azure Cognitive Search.

QuotaUsagesListResult

Antwoord met de quotumgebruiksgegevens voor alle ondersteunde SKU's van Azure Cognitive Search-service.

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

SearchManagementClientOptionalParams

Optionele parameters.

SearchManagementRequestOptions

Parametergroep

SearchService

Beschrijft een Azure Cognitive Search service en de huidige status.

SearchServiceListResult

Antwoord met een lijst met Azure Cognitive Search services.

SearchServiceUpdate

De parameters die worden gebruikt om een Azure Cognitive Search-service bij te werken.

Services

Interface die een Services vertegenwoordigt.

ServicesCheckNameAvailabilityOptionalParams

Optionele parameters.

ServicesCreateOrUpdateOptionalParams

Optionele parameters.

ServicesDeleteOptionalParams

Optionele parameters.

ServicesGetOptionalParams

Optionele parameters.

ServicesListByResourceGroupNextOptionalParams

Optionele parameters.

ServicesListByResourceGroupOptionalParams

Optionele parameters.

ServicesListBySubscriptionNextOptionalParams

Optionele parameters.

ServicesListBySubscriptionOptionalParams

Optionele parameters.

ServicesUpdateOptionalParams

Optionele parameters.

ShareablePrivateLinkResourceProperties

Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure Cognitive Search.

ShareablePrivateLinkResourceType

Beschrijft een resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure Cognitive Search.

SharedPrivateLinkResource

Beschrijft een gedeelde Private Link resource die wordt beheerd door de Azure Cognitive Search-service.

SharedPrivateLinkResourceListResult

Antwoord met een lijst met gedeelde Private Link-resources.

SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een bestaande gedeelde Private Link-resource die wordt beheerd door de Azure Cognitive Search-service.

SharedPrivateLinkResources

Interface die een SharedPrivateLinkResources vertegenwoordigt.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Optionele parameters.

SharedPrivateLinkResourcesDeleteOptionalParams

Optionele parameters.

SharedPrivateLinkResourcesGetOptionalParams

Optionele parameters.

SharedPrivateLinkResourcesListByServiceNextOptionalParams

Optionele parameters.

SharedPrivateLinkResourcesListByServiceOptionalParams

Optionele parameters.

Sku

Definieert de SKU van een Azure Cognitive Search Service, die prijscategorie en capaciteitslimieten bepaalt.

TrackedResource

De definitie van het resourcemodel voor een Azure Resource Manager bijgehouden resource op het hoogste niveau met 'tags' en een 'locatie'

UsageBySubscriptionSkuOptionalParams

Optionele parameters.

Usages

Interface die een gebruik vertegenwoordigt.

UsagesListBySubscriptionNextOptionalParams

Optionele parameters.

UsagesListBySubscriptionOptionalParams

Optionele parameters.

Type-aliassen

AadAuthFailureMode

Definieert waarden voor AadAuthFailureMode.

AdminKeyKind

Definieert waarden voor AdminKeyKind.

AdminKeysGetResponse

Bevat antwoordgegevens voor de get-bewerking.

AdminKeysRegenerateResponse

Bevat antwoordgegevens voor de bewerking voor opnieuw genereren.

HostingMode

Definieert waarden voor HostingMode.

IdentityType

Definieert waarden voor IdentityType.

OperationsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

PrivateEndpointConnectionsDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

PrivateEndpointConnectionsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

PrivateEndpointConnectionsListByServiceNextResponse

Bevat antwoordgegevens voor de bewerking listByServiceNext.

PrivateEndpointConnectionsListByServiceResponse

Bevat antwoordgegevens voor de listByService-bewerking.

PrivateEndpointConnectionsUpdateResponse

Bevat antwoordgegevens voor de updatebewerking.

PrivateLinkResourcesListSupportedResponse

Bevat antwoordgegevens voor de bewerking listSupported.

PrivateLinkServiceConnectionProvisioningState

Definieert waarden voor PrivateLinkServiceConnectionProvisioningState.
KnownPrivateLinkServiceConnectionProvisioningState kan door elkaar worden gebruikt met PrivateLinkServiceConnectionProvisioningState. Deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Bijwerken: de private link-serviceverbinding wordt samen met andere resources gemaakt om deze volledig functioneel te maken.
Verwijderen: de private link-serviceverbinding wordt verwijderd.
Mislukt: de private link-serviceverbinding kan niet worden ingericht of verwijderd.
Geslaagd: de private link-serviceverbinding is ingericht en is gereed voor goedkeuring.
Onvolledig: de inrichtingsaanvraag voor de verbindingsresource van de Private Link-service is geaccepteerd, maar het proces voor het maken is nog niet gestart.
Geannuleerd: inrichtingsaanvraag voor de privékoppelingsserviceverbindingsresource is geannuleerd

PrivateLinkServiceConnectionStatus

Definieert waarden voor PrivateLinkServiceConnectionStatus.

ProvisioningState

Definieert waarden voor ProvisioningState.

PublicNetworkAccess

Definieert waarden voor PublicNetworkAccess.

QueryKeysCreateResponse

Bevat antwoordgegevens voor de maakbewerking.

QueryKeysListBySearchServiceNextResponse

Bevat antwoordgegevens voor de bewerking listBySearchServiceNext.

QueryKeysListBySearchServiceResponse

Bevat antwoordgegevens voor de bewerking listBySearchService.

SearchEncryptionComplianceStatus

Definieert waarden voor SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

Definieert waarden voor SearchEncryptionWithCmk.

SearchSemanticSearch

Definieert waarden voor SearchSemanticSearch.
KnownSearchSemanticSearch kan door elkaar worden gebruikt met SearchSemanticSearch. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

disabled: geeft aan dat semantisch zoeken is uitgeschakeld voor de zoekservice.
gratis: schakelt semantisch zoeken in op een zoekservice en geeft aan dat deze moet worden gebruikt binnen de limieten van de gratis laag. Dit zou het aantal semantische zoekaanvragen beperken en wordt zonder extra kosten aangeboden. Dit is de standaardinstelling voor nieuw ingerichte zoekservices.
standaard: maakt semantisch zoeken in een zoekservice mogelijk als factureerbare functie, met een hogere doorvoer en een hogere hoeveelheid semantische zoekquery's.

SearchServiceStatus

Definieert waarden voor SearchServiceStatus.

ServicesCheckNameAvailabilityResponse

Bevat antwoordgegevens voor de bewerking checkNameAvailability.

ServicesCreateOrUpdateResponse

Bevat antwoordgegevens voor de bewerking createOrUpdate.

ServicesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ServicesListByResourceGroupNextResponse

Bevat antwoordgegevens voor de bewerking listByResourceGroupNext.

ServicesListByResourceGroupResponse

Bevat antwoordgegevens voor de bewerking listByResourceGroup.

ServicesListBySubscriptionNextResponse

Bevat antwoordgegevens voor de bewerking listBySubscriptionNext.

ServicesListBySubscriptionResponse

Bevat antwoordgegevens voor de listBySubscription-bewerking.

ServicesUpdateResponse

Bevat antwoordgegevens voor de updatebewerking.

SharedPrivateLinkResourceAsyncOperationResult

Definieert waarden voor SharedPrivateLinkResourceAsyncOperationResult.
KnownSharedPrivateLinkResourceAsyncOperationResult kan door elkaar worden gebruikt met SharedPrivateLinkResourceAsyncOperationResult. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Wordt uitgevoerd
Geslaagd
Mislukt

SharedPrivateLinkResourceProvisioningState

Definieert waarden voor SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

Definieert waarden voor SharedPrivateLinkResourceStatus.

SharedPrivateLinkResourcesCreateOrUpdateResponse

Bevat antwoordgegevens voor de bewerking createOrUpdate.

SharedPrivateLinkResourcesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

SharedPrivateLinkResourcesListByServiceNextResponse

Bevat antwoordgegevens voor de bewerking listByServiceNext.

SharedPrivateLinkResourcesListByServiceResponse

Bevat antwoordgegevens voor de listByService-bewerking.

SkuName

Definieert waarden voor SkuName.

UnavailableNameReason

Definieert waarden voor UnavailableNameReason.
KnownUnavailableNameReason kan door elkaar worden gebruikt met UnavailableNameReason. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Ongeldig: de naam van de zoekservice komt niet overeen met de naamgevingsvereisten.
AlreadyExists: de naam van de zoekservice is al toegewezen aan een andere zoekservice.

UsageBySubscriptionSkuResponse

Bevat antwoordgegevens voor de bewerking usageBySubscriptionSku.

UsagesListBySubscriptionNextResponse

Bevat antwoordgegevens voor de bewerking listBySubscriptionNext.

UsagesListBySubscriptionResponse

Bevat antwoordgegevens voor de listBySubscription-bewerking.

Enums

KnownPrivateLinkServiceConnectionProvisioningState

Bekende waarden van PrivateLinkServiceConnectionProvisioningState die de service accepteert.

KnownSearchSemanticSearch

Bekende waarden van SearchSemanticSearch die door de service worden geaccepteerd.

KnownSharedPrivateLinkResourceAsyncOperationResult

Bekende waarden van SharedPrivateLinkResourceAsyncOperationResult die door de service worden geaccepteerd.

KnownUnavailableNameReason

Bekende waarden van UnavailableNameReason die de service accepteert.

Functies

getContinuationToken(unknown)

Op basis van de laatste .value die door de byPage iterator is geproduceerd, wordt een vervolgtoken geretourneerd dat later kan worden gebruikt om vanaf dat punt met paging te beginnen.

Functiedetails

getContinuationToken(unknown)

Op basis van de laatste .value die door de byPage iterator is geproduceerd, wordt een vervolgtoken geretourneerd dat later kan worden gebruikt om vanaf dat punt met paging te beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

Een object dat toegang heeft value tot de IteratorResult vanuit een byPage iterator.

Retouren

string | undefined

Het vervolgtoken dat tijdens toekomstige aanroepen kan worden doorgegeven aan byPage().