Freigeben über


@azure/arm-search package

Klassen

SearchManagementClient

Schnittstellen

AdminKeyResult

Antwort, die die primären und sekundären Administrator-API-Schlüssel für einen bestimmten Azure Cognitive Search Dienst enthält.

AdminKeys

Schnittstelle, die einen AdminKeys darstellt.

AdminKeysGetOptionalParams

Optionale Parameter.

AdminKeysRegenerateOptionalParams

Optionale Parameter.

AsyncOperationResult

Details eines asynchronen Vorgangs für freigegebene private Link-Ressourcen mit langer Ausführung

CheckNameAvailabilityInput

Eingabe der Verfügbarkeits-API des Prüfnamens.

CheckNameAvailabilityOutput

Ausgabe der Verfügbarkeits-API für Überprüfungsnamen.

CloudError

Enthält Informationen zu einem API-Fehler.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

DataPlaneAadOrApiKeyAuthOption

Gibt an, dass entweder der API-Schlüssel oder ein Zugriffstoken aus Azure Active Directory für die Authentifizierung verwendet werden kann.

DataPlaneAuthOptions

Definiert die Optionen, wie die Datenebenen-API eines Suchdienst Anforderungen authentifiziert. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf true festgelegt ist.

EncryptionWithCmk

Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit kundenseitig verwalteten Schlüsseln verschlüsselt werden sollen.

Identity

Identität für die Ressource.

IpRule

Die IP-Einschränkungsregel des Azure Cognitive Search Diensts.

ListQueryKeysResult

Antwort, die die Abfrage-API-Schlüssel für einen bestimmten Azure Cognitive Search Dienst enthält.

NetworkRuleSet

Netzwerkspezifische Regeln, die bestimmen, wie der Azure Cognitive Search Dienst erreicht werden kann.

Operation

Beschreibt einen REST-API-Vorgang.

OperationDisplay

Das Objekt, das den Vorgang beschreibt.

OperationListResult

Das Ergebnis der Anforderung zum Auflisten von REST-API-Vorgängen. Sie enthält eine Liste von Vorgängen und eine URL zum Abrufen der nächsten Gruppe von Ergebnissen.

Operations

Schnittstelle, die einen Vorgang darstellt.

OperationsListOptionalParams

Optionale Parameter.

PrivateEndpointConnection

Beschreibt eine vorhandene Verbindung des privaten Endpunkts mit dem Azure Cognitive Search-Dienst.

PrivateEndpointConnectionListResult

Antwort, die eine Liste von Verbindungen mit privatem Endpunkt enthält.

PrivateEndpointConnectionProperties

Beschreibt die Eigenschaften einer vorhandenen Privaten Endpunktverbindung mit dem Azure Cognitive Search Dienst.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Die private Endpunktressource des Microsoft.Network-Anbieters.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Beschreibt den aktuellen Zustand einer vorhandenen Private Link Service-Verbindung mit dem privaten Azure-Endpunkt.

PrivateEndpointConnections

Schnittstelle, die eine PrivateEndpointConnections darstellt.

PrivateEndpointConnectionsDeleteOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsGetOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsListByServiceNextOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsListByServiceOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsUpdateOptionalParams

Optionale Parameter.

PrivateLinkResource

Beschreibt eine unterstützte Private Link-Ressource für den Azure Cognitive Search-Dienst.

PrivateLinkResourceProperties

Beschreibt die Eigenschaften einer unterstützten Private Link-Ressource für den Azure Cognitive Search-Dienst. Für eine bestimmte API-Version stellt dies die "unterstützten" groupIds beim Erstellen einer freigegebenen privaten Linkressource dar.

PrivateLinkResources

Schnittstelle, die eine PrivateLinkResources darstellt.

PrivateLinkResourcesListSupportedOptionalParams

Optionale Parameter.

PrivateLinkResourcesResult

Antwort, die eine Liste der unterstützten Private Link Ressourcen enthält.

QueryKey

Beschreibt einen API-Schlüssel für einen bestimmten Azure Cognitive Search Dienst, der nur Berechtigungen für Abfragevorgänge hat.

QueryKeys

Schnittstelle, die eine QueryKeys-Schnittstelle darstellt.

QueryKeysCreateOptionalParams

Optionale Parameter.

QueryKeysDeleteOptionalParams

Optionale Parameter.

QueryKeysListBySearchServiceNextOptionalParams

Optionale Parameter.

QueryKeysListBySearchServiceOptionalParams

Optionale Parameter.

QuotaUsageResult

Beschreibt die Kontingentverwendung für eine bestimmte SKU, die von Azure Cognitive Search unterstützt wird.

QuotaUsageResultName

Der Name der von Azure Cognitive Search unterstützten SKU.

QuotaUsagesListResult

Antwort, die die Informationen zur Kontingentnutzung für alle unterstützten Skus von Azure Cognitive Search Dienst enthält.

Resource

Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden

SearchManagementClientOptionalParams

Optionale Parameter.

SearchManagementRequestOptions

Parametergruppe

SearchService

Beschreibt einen Azure Cognitive Search Dienst und seinen aktuellen Status.

SearchServiceListResult

Antwort, die eine Liste mit Azure Cognitive Search Diensten enthält.

SearchServiceUpdate

Die Parameter, die zum Aktualisieren eines Azure Cognitive Search-Diensts verwendet werden.

Services

Schnittstelle, die einen Dienst darstellt.

ServicesCheckNameAvailabilityOptionalParams

Optionale Parameter.

ServicesCreateOrUpdateOptionalParams

Optionale Parameter.

ServicesDeleteOptionalParams

Optionale Parameter.

ServicesGetOptionalParams

Optionale Parameter.

ServicesListByResourceGroupNextOptionalParams

Optionale Parameter.

ServicesListByResourceGroupOptionalParams

Optionale Parameter.

ServicesListBySubscriptionNextOptionalParams

Optionale Parameter.

ServicesListBySubscriptionOptionalParams

Optionale Parameter.

ServicesUpdateOptionalParams

Optionale Parameter.

ShareablePrivateLinkResourceProperties

Beschreibt die Eigenschaften eines Ressourcentyps, der in den Private Link-Dienst integriert wurde und von Azure Cognitive Search unterstützt wird.

ShareablePrivateLinkResourceType

Beschreibt einen Ressourcentyp, der in den Private Link-Dienst integriert wurde und von Azure Cognitive Search unterstützt wird.

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource, die vom Azure Cognitive Search-Dienst verwaltet wird.

SharedPrivateLinkResourceListResult

Antwort, die eine Liste mit freigegebenen Private Link Ressourcen enthält.

SharedPrivateLinkResourceProperties

Beschreibt die Eigenschaften einer vorhandenen shared Private Link-Ressource, die vom Azure Cognitive Search-Dienst verwaltet wird.

SharedPrivateLinkResources

Schnittstelle, die eine SharedPrivateLinkResources darstellt.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Optionale Parameter.

SharedPrivateLinkResourcesDeleteOptionalParams

Optionale Parameter.

SharedPrivateLinkResourcesGetOptionalParams

Optionale Parameter.

SharedPrivateLinkResourcesListByServiceNextOptionalParams

Optionale Parameter.

SharedPrivateLinkResourcesListByServiceOptionalParams

Optionale Parameter.

Sku

Definiert die SKU eines Azure Cognitive Search-Diensts, der preis- und kapazitätslimits bestimmt.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure-Resource Manager nachverfolgte Ressource der obersten Ebene mit "Tags" und einem "Standort"

UsageBySubscriptionSkuOptionalParams

Optionale Parameter.

Usages

Schnittstelle, die eine Verwendung darstellt.

UsagesListBySubscriptionNextOptionalParams

Optionale Parameter.

UsagesListBySubscriptionOptionalParams

Optionale Parameter.

Typaliase

AadAuthFailureMode

Definiert Werte für AadAuthFailureMode.

AdminKeyKind

Definiert Werte für AdminKeyKind.

AdminKeysGetResponse

Enthält Antwortdaten für den Get-Vorgang.

AdminKeysRegenerateResponse

Enthält Antwortdaten für den Generierungsvorgang.

HostingMode

Definiert Werte für HostingMode.

IdentityType

Definiert Werte für IdentityType.

OperationsListResponse

Enthält Antwortdaten für den Listenvorgang.

PrivateEndpointConnectionsDeleteResponse

Enthält Antwortdaten für den Löschvorgang.

PrivateEndpointConnectionsGetResponse

Enthält Antwortdaten für den Get-Vorgang.

PrivateEndpointConnectionsListByServiceNextResponse

Enthält Antwortdaten für den ListByServiceNext-Vorgang.

PrivateEndpointConnectionsListByServiceResponse

Enthält Antwortdaten für den ListByService-Vorgang.

PrivateEndpointConnectionsUpdateResponse

Enthält Antwortdaten für den Aktualisierungsvorgang.

PrivateLinkResourcesListSupportedResponse

Enthält Antwortdaten für den listSupported-Vorgang.

PrivateLinkServiceConnectionProvisioningState

Definiert Werte für PrivateLinkServiceConnectionProvisioningState.
KnownPrivateLinkServiceConnectionProvisioningState kann austauschbar mit PrivateLinkServiceConnectionProvisioningState verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Aktualisierung: Die Private Link-Dienstverbindung wird gerade zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig ist.
Löschen: Die Private Link-Dienstverbindung wird gerade gelöscht.
Fehler: Die Private Link-Dienstverbindung konnte nicht bereitgestellt oder gelöscht werden.
Erfolgreich: Die Private Link-Dienstverbindung hat die Bereitstellung abgeschlossen und kann genehmigt werden.
Unvollständig: Die Bereitstellungsanforderung für die Private Link-Dienstverbindungsressource wurde akzeptiert, aber der Erstellungsprozess wurde noch nicht begonnen.
Abgebrochen: Die Bereitstellungsanforderung für die Private Link-Dienstverbindungsressource wurde abgebrochen.

PrivateLinkServiceConnectionStatus

Definiert Werte für PrivateLinkServiceConnectionStatus.

ProvisioningState

Definiert Werte für ProvisioningState.

PublicNetworkAccess

Definiert Werte für PublicNetworkAccess.

QueryKeysCreateResponse

Enthält Antwortdaten für den Erstellungsvorgang.

QueryKeysListBySearchServiceNextResponse

Enthält Antwortdaten für den ListBySearchServiceNext-Vorgang.

QueryKeysListBySearchServiceResponse

Enthält Antwortdaten für den ListBySearchService-Vorgang.

SearchEncryptionComplianceStatus

Definiert Werte für SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

Definiert Werte für SearchEncryptionWithCmk.

SearchSemanticSearch

Definiert Werte für SearchSemanticSearch.
KnownSearchSemanticSearch kann austauschbar mit SearchSemanticSearch verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

deaktiviert: Gibt an, dass die semantische Suche für den Suchdienst deaktiviert ist.
free: Aktiviert die semantische Suche für einen Suchdienst und gibt an, dass er innerhalb der Grenzen des free-Tarifs verwendet werden soll. Dies würde das Volumen der semantischen Suchanforderungen deckeln und wird ohne zusätzliche Kosten angeboten. Dies ist die Standardeinstellung für neu bereitgestellte Suchdienste.
standard: Ermöglicht die semantische Suche in einem Suchdienst als abrechenbares Feature mit höherem Durchsatz und höherem Volumen semantischer Suchabfragen.

SearchServiceStatus

Definiert Werte für SearchServiceStatus.

ServicesCheckNameAvailabilityResponse

Enthält Antwortdaten für den CheckNameAvailability-Vorgang.

ServicesCreateOrUpdateResponse

Enthält Antwortdaten für den CreateOrUpdate-Vorgang.

ServicesGetResponse

Enthält Antwortdaten für den Get-Vorgang.

ServicesListByResourceGroupNextResponse

Enthält Antwortdaten für den ListByResourceGroupNext-Vorgang.

ServicesListByResourceGroupResponse

Enthält Antwortdaten für den ListByResourceGroup-Vorgang.

ServicesListBySubscriptionNextResponse

Enthält Antwortdaten für den ListBySubscriptionNext-Vorgang.

ServicesListBySubscriptionResponse

Enthält Antwortdaten für den ListBySubscription-Vorgang.

ServicesUpdateResponse

Enthält Antwortdaten für den Aktualisierungsvorgang.

SharedPrivateLinkResourceAsyncOperationResult

Definiert Werte für SharedPrivateLinkResourceAsyncOperationResult.
KnownSharedPrivateLinkResourceAsyncOperationResult kann austauschbar mit SharedPrivateLinkResourceAsyncOperationResult verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Wird ausgeführt
Erfolgreich
Fehler

SharedPrivateLinkResourceProvisioningState

Definiert Werte für SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

Definiert Werte für SharedPrivateLinkResourceStatus.

SharedPrivateLinkResourcesCreateOrUpdateResponse

Enthält Antwortdaten für den CreateOrUpdate-Vorgang.

SharedPrivateLinkResourcesGetResponse

Enthält Antwortdaten für den Get-Vorgang.

SharedPrivateLinkResourcesListByServiceNextResponse

Enthält Antwortdaten für den ListByServiceNext-Vorgang.

SharedPrivateLinkResourcesListByServiceResponse

Enthält Antwortdaten für den ListByService-Vorgang.

SkuName

Definiert Werte für SkuName.

UnavailableNameReason

Definiert Werte für UnavailableNameReason.
KnownUnavailableNameReason kann austauschbar mit UnavailableNameReason verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Ungültig: Der Name des Suchdiensts entspricht nicht den Benennungsanforderungen.
AlreadyExists: Der Suchdienstname ist bereits einem anderen Suchdienst zugewiesen.

UsageBySubscriptionSkuResponse

Enthält Antwortdaten für den UsageBySubscriptionSku-Vorgang.

UsagesListBySubscriptionNextResponse

Enthält Antwortdaten für den ListBySubscriptionNext-Vorgang.

UsagesListBySubscriptionResponse

Enthält Antwortdaten für den ListBySubscription-Vorgang.

Enumerationen

KnownPrivateLinkServiceConnectionProvisioningState

Bekannte Werte von PrivateLinkServiceConnectionProvisioningState , die der Dienst akzeptiert.

KnownSearchSemanticSearch

Bekannte Werte von SearchSemanticSearch , die der Dienst akzeptiert.

KnownSharedPrivateLinkResourceAsyncOperationResult

Bekannte Werte von SharedPrivateLinkResourceAsyncOperationResult , die der Dienst akzeptiert.

KnownUnavailableNameReason

Bekannte Werte von UnavailableNameReason , die der Dienst akzeptiert.

Functions

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt, das von einem byPage Iterator auf iteratorResult zugreiftvalue.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das bei zukünftigen Aufrufen an byPage() übergeben werden kann.