@azure/arm-search package
Klassen
| SearchManagementClient |
Schnittstellen
| AccessRule |
Zugriffsregel in einem Netzwerksicherheitsperimeterkonfigurationsprofil |
| AccessRuleProperties |
Eigenschaften der Access-Regel |
| AccessRulePropertiesSubscriptionsItem |
Abonnement-IDs |
| AdminKeyResult |
Antwort, die die primären und sekundären Administrator-API-Schlüssel für einen bestimmten Azure AI Search-Dienst enthält. |
| AdminKeys |
Schnittstelle, die einen AdminKeys darstellt. |
| AdminKeysGetOptionalParams |
Optionale Parameter. |
| AdminKeysRegenerateOptionalParams |
Optionale Parameter. |
| AsyncOperationResult |
Die Details eines asynchronen Shared Private Link-Ressourcenvorgangs mit langer Ausführungszeit. |
| CheckNameAvailabilityInput |
Eingabe der Überprüfungsnamenverfügbarkeits-API. |
| CheckNameAvailabilityOutput |
Ausgabe der Überprüfungsnamenverfügbarkeits-API. |
| 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 von einem Microsoft Entra ID-Mandanten für die Authentifizierung verwendet werden kann. |
| DataPlaneAuthOptions |
Definiert die Optionen für die Authentifizierung einer Datenebenenanforderung durch den Suchdienst. Dies kann nicht festgelegt werden, wenn "disableLocalAuth" auf "true" festgelegt ist. |
| EncryptionWithCmk |
Beschreibt eine Richtlinie, die bestimmt, wie Ressourcen innerhalb des Suchdiensts mit vom Kunden verwalteten Schlüsseln verschlüsselt werden sollen. |
| Identity |
Details zur Suchdienstidentität. Ein Nullwert gibt an, dass dem Suchdienst keine Identität zugewiesen ist. |
| IpRule |
Die IP-Einschränkungsregel des Azure AI Search-Diensts. |
| ListQueryKeysResult |
Antwort, die die Abfrage-API-Schlüssel für einen bestimmten Azure AI Search-Dienst enthält. |
| NetworkRuleSet |
Netzwerkspezifische Regeln, die bestimmen, wie der Azure AI Search-Dienst erreicht werden kann. |
| NetworkSecurityPerimeter |
Informationen zu einem Netzwerksicherheitsperimeter (NSP) |
| NetworkSecurityPerimeterConfiguration |
Netzwerksicherheitsperimeter (NSP)-Konfigurationsressource |
| NetworkSecurityPerimeterConfigurationListResult |
Ergebnis einer NSP-Konfigurationsanforderung (Netzwerksicherheitsperimeter). |
| NetworkSecurityPerimeterConfigurationProperties |
Netzwerksicherheitskonfigurationseigenschaften. |
| NetworkSecurityPerimeterConfigurations |
Schnittstelle, die eine NetworkSecurityPerimeterConfigurations darstellt. |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
Optionale Parameter. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams |
Optionale Parameter. |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
Optionale Parameter. |
| NetworkSecurityPerimeterConfigurationsReconcileHeaders |
Definiert Kopfzeilen für NetworkSecurityPerimeterConfigurations_reconcile Vorgang. |
| NetworkSecurityPerimeterConfigurationsReconcileOptionalParams |
Optionale Parameter. |
| NetworkSecurityProfile |
Netzwerksicherheitsperimeterkonfigurationsprofil |
| Operation |
Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird |
| OperationDisplay |
Lokalisierte Anzeigeinformationen für diesen bestimmten Vorgang. |
| OperationListResult |
Das Ergebnis der Anforderung zum Auflisten von REST-API-Vorgängen. Sie enthält eine Liste von Vorgängen und eine URL, um den nächsten Satz von Ergebnissen abzurufen. |
| Operations |
Schnittstelle, die eine Operation darstellt. |
| OperationsListOptionalParams |
Optionale Parameter. |
| PrivateEndpointConnection |
Beschreibt eine vorhandene private Endpunktverbindung mit dem Azure AI Search-Dienst. |
| PrivateEndpointConnectionListResult |
Antwort, die eine Liste privater Endpunktverbindungen enthält. |
| PrivateEndpointConnectionProperties |
Beschreibt die Eigenschaften einer vorhandenen privaten Endpunktverbindung mit dem Suchdienst. |
| PrivateEndpointConnectionPropertiesPrivateEndpoint |
Die private Endpunktressource vom Microsoft.Network-Anbieter. |
| PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState |
Beschreibt den aktuellen Status einer vorhandenen Azure Private Link-Dienstverbindung mit dem privaten 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 Linkressource für den Azure AI Search-Dienst. |
| PrivateLinkResourceProperties |
Beschreibt die Eigenschaften einer unterstützten privaten Linkressource für den Azure AI Search-Dienst. Bei einer bestimmten API-Version stellt dies die "supported" 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 privaten Linkressourcen enthält. |
| ProvisioningIssue |
Beschreibt ein Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration |
| ProvisioningIssueProperties |
Details zu einem Bereitstellungsproblem für eine Netzwerksicherheitsperimeterkonfiguration (NSP). Ressourcenanbieter sollten separate Bereitstellungsproblemelemente für jedes separate Problem generieren, das erkannt wurde, und eine aussagekräftige und unverwechselbare Beschreibung sowie alle geeigneten vorgeschlagenenResourceIds und suggestedAccessRules enthalten. |
| ProxyResource |
Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort. |
| QueryKey |
Beschreibt einen API-Schlüssel für einen bestimmten Azure AI Search-Dienst, der schreibgeschützte Berechtigungen für die Docs-Auflistung eines Indexes vermittelt. |
| QueryKeys |
Schnittstelle, die einen QueryKeys darstellt. |
| QueryKeysCreateOptionalParams |
Optionale Parameter. |
| QueryKeysDeleteOptionalParams |
Optionale Parameter. |
| QueryKeysListBySearchServiceNextOptionalParams |
Optionale Parameter. |
| QueryKeysListBySearchServiceOptionalParams |
Optionale Parameter. |
| QuotaUsageResult |
Beschreibt die Kontingentverwendung für eine bestimmte SKU. |
| QuotaUsageResultName |
Der Name der SKU, die von Azure AI Search unterstützt wird. |
| QuotaUsagesListResult |
Antwort, die die Informationen zur Kontingentnutzung für alle unterstützten SKUs von Azure AI Search enthält. |
| Resource |
Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden |
| ResourceAssociation |
Informationen zur Ressourcenzuordnung |
| SearchManagementClientOptionalParams |
Optionale Parameter. |
| SearchManagementRequestOptions |
Gruppe "Parameter" |
| SearchService |
Beschreibt einen Azure AI Search-Dienst und seinen aktuellen Zustand. |
| SearchServiceListResult |
Antwort, die eine Liste der Azure AI Search-Dienste enthält. |
| SearchServiceUpdate |
Die Parameter, die zum Aktualisieren eines Azure AI 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. |
| ServicesUpgradeHeaders |
Definiert Header für Services_upgrade Vorgang. |
| ServicesUpgradeOptionalParams |
Optionale Parameter. |
| ShareablePrivateLinkResourceProperties |
Beschreibt die Eigenschaften eines Ressourcentyps, der in den privaten Linkdienst integriert wurde, unterstützt von Azure AI Search. |
| ShareablePrivateLinkResourceType |
Beschreibt einen Ressourcentyp, der in den privaten Linkdienst integriert wurde, der von Azure AI Search unterstützt wird. |
| SharedPrivateLinkResource |
Beschreibt eine freigegebene private Linkressource, die vom Azure AI Search-Dienst verwaltet wird. |
| SharedPrivateLinkResourceListResult |
Antwort, die eine Liste der freigegebenen privaten Linkressourcen enthält. |
| SharedPrivateLinkResourceProperties |
Beschreibt die Eigenschaften einer vorhandenen freigegebenen privaten Linkressource, die vom Azure AI 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 Suchdiensts, die Abrechnungsraten und Kapazitätsgrenzwerte bestimmt. |
| SystemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
| TrackedResource |
Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort" |
| UsageBySubscriptionSkuOptionalParams |
Optionale Parameter. |
| Usages |
Schnittstelle, die eine Verwendung darstellt. |
| UsagesListBySubscriptionNextOptionalParams |
Optionale Parameter. |
| UsagesListBySubscriptionOptionalParams |
Optionale Parameter. |
| UserAssignedIdentity |
Benutzer zugewiesene Identitätseigenschaften |
Typaliase
| AadAuthFailureMode |
Definiert Werte für AadAuthFailureMode. |
| AccessRuleDirection |
Definiert Werte für AccessRuleDirection. Bekannte Werte, die vom Dienst unterstützt werden
eingehende: Gilt für eingehenden Netzwerkdatenverkehr für die gesicherten Ressourcen. |
| ActionType |
Definiert Werte für ActionType. Bekannte Werte, die vom Dienst unterstützt werdenInternal |
| AdminKeyKind |
Definiert Werte für AdminKeyKind. |
| AdminKeysGetResponse |
Enthält Antwortdaten für den Get-Vorgang. |
| AdminKeysRegenerateResponse |
Enthält Antwortdaten für den Regenerate-Vorgang. |
| ComputeType |
Definiert Werte für ComputeType. Bekannte Werte, die vom Dienst unterstützt werden
default: Erstellen Sie den Dienst mit der Standardberechnung. |
| CreatedByType |
Definiert Werte für CreatedByType. Bekannte Werte, die vom Dienst unterstützt werden
User |
| HostingMode |
Definiert Werte für HostingMode. |
| IdentityType |
Definiert Werte für IdentityType. Bekannte Werte, die vom Dienst unterstützt werden
Keine: Gibt an, dass alle Identitäten, die dem Suchdienst zugeordnet sind, entfernt werden müssen. |
| IssueType |
Definiert Werte für IssueType. Bekannte Werte, die vom Dienst unterstützt werden
Unbekannter: Unbekannter Problemtyp |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Definiert Werte für NetworkSecurityPerimeterConfigurationProvisioningState. Bekannte Werte, die vom Dienst unterstützt werden
Succeeded |
| NetworkSecurityPerimeterConfigurationsGetResponse |
Enthält Antwortdaten für den Get-Vorgang. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextResponse |
Enthält Antwortdaten für den listByServiceNext-Vorgang. |
| NetworkSecurityPerimeterConfigurationsListByServiceResponse |
Enthält Antwortdaten für den listByService-Vorgang. |
| NetworkSecurityPerimeterConfigurationsReconcileResponse |
Enthält Antwortdaten für den Abgleichsvorgang. |
| OperationsListResponse |
Enthält Antwortdaten für den Listenvorgang. |
| Origin |
Definiert Werte für Origin. Bekannte Werte, die vom Dienst unterstützt werden
user |
| 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. Bekannte Werte, die vom Dienst unterstützt werden
Aktualisierung: Die Verbindung mit dem privaten Linkdienst wird zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig sind. |
| PrivateLinkServiceConnectionStatus |
Definiert Werte für PrivateLinkServiceConnectionStatus. |
| ProvisioningState |
Definiert Werte für ProvisioningState. |
| PublicNetworkAccess |
Definiert Werte für PublicNetworkAccess. Bekannte Werte, die vom Dienst unterstützt werden
enabled: Der Suchdienst ist über Datenverkehr zugänglich, der aus dem öffentlichen Internet stammt. |
| 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. |
| ResourceAssociationAccessMode |
Definiert Werte für ResourceAssociationAccessMode. Bekannte Werte, die vom Dienst unterstützt werden
Erzwungene: Erzwungener Zugriffsmodus – Datenverkehr zu der Ressource, die fehlgeschlagene Zugriffsprüfungen blockiert ist |
| SearchBypass |
Definiert Werte für SearchBypass. Bekannte Werte, die vom Dienst unterstützt werden
Keine: Gibt an, dass kein Ursprung die im Abschnitt "ipRules" definierten Regeln umgehen kann. Dies ist die Standardeinstellung. |
| SearchDataExfiltrationProtection |
Definiert Werte für SearchDataExfiltrationProtection. Bekannte Werte, die vom Dienst unterstützt werdenBlockAll: Gibt an, dass alle Datenexfiltrationsszenarien deaktiviert sind. |
| SearchEncryptionComplianceStatus |
Definiert Werte für SearchEncryptionComplianceStatus. |
| SearchEncryptionWithCmk |
Definiert Werte für SearchEncryptionWithCmk. |
| SearchSemanticSearch |
Definiert Werte für SearchSemanticSearch. Bekannte Werte, die vom Dienst unterstützt werden
deaktiviert: Gibt an, dass der semantische Reranker für den Suchdienst deaktiviert ist. Dies ist die Standardeinstellung. |
| 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. |
| ServicesUpgradeResponse |
Enthält Antwortdaten für den Upgradevorgang. |
| Severity |
Definiert Werte für den Schweregrad. Bekannte Werte, die vom Dienst unterstützt werden
Warning |
| SharedPrivateLinkResourceAsyncOperationResult |
Definiert Werte für SharedPrivateLinkResourceAsyncOperationResult. Bekannte Werte, die vom Dienst unterstützt werden
Running |
| SharedPrivateLinkResourceProvisioningState |
Definiert Werte für SharedPrivateLinkResourceProvisioningState. Bekannte Werte, die vom Dienst unterstützt werden
Aktualisierung: Die freigegebene Private Link-Ressource wird derzeit zusammen mit anderen Ressourcen erstellt, damit sie voll funktionsfähig ist. |
| SharedPrivateLinkResourceStatus |
Definiert Werte für SharedPrivateLinkResourceStatus. Bekannte Werte, die vom Dienst unterstützt werden
Ausstehend: Die freigegebene Private Link-Ressource wurde erstellt und muss noch genehmigt werden. |
| 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. Bekannte Werte, die vom Dienst unterstützt werden
Free: Kostenloses Kontingent ohne SLA-Garantien und nur eine Teilmenge der Funktionen, die in abrechenbaren Stufen angeboten werden. |
| UnavailableNameReason |
Definiert Werte für "UnavailableNameReason". Bekannte Werte, die vom Dienst unterstützt werden
Ungültig: Der Name des Suchdiensts entspricht nicht den Benennungsanforderungen. |
| UpgradeAvailable |
Definiert Werte für UpgradeAvailable. Bekannte Werte, die vom Dienst unterstützt werden
notAvailable: Für den Dienst ist derzeit kein Upgrade verfügbar. |
| 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
| KnownAccessRuleDirection |
Bekannte Werte von AccessRuleDirection, die der Dienst akzeptiert. |
| KnownActionType |
Bekannte Werte von ActionType, die der Dienst akzeptiert. |
| KnownComputeType |
Bekannte Werte von ComputeType, die der Dienst akzeptiert. |
| KnownCreatedByType |
Bekannte Werte von CreatedByType, die der Dienst akzeptiert. |
| KnownIdentityType |
Bekannte Werte von IdentityType, die der Dienst akzeptiert. |
| KnownIssueType |
Bekannte Werte von IssueType , die der Dienst akzeptiert. |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
Bekannte Werte von NetworkSecurityPerimeterConfigurationProvisioningState , die der Dienst akzeptiert. |
| KnownOrigin |
Bekannte Werte von Origin, die der Dienst akzeptiert. |
| KnownPrivateLinkServiceConnectionProvisioningState |
Bekannte Werte von PrivateLinkServiceConnectionProvisioningState, die der Dienst akzeptiert. |
| KnownPublicNetworkAccess |
Bekannte Werte von PublicNetworkAccess, die der Dienst akzeptiert. |
| KnownResourceAssociationAccessMode |
Bekannte Werte von ResourceAssociationAccessMode , die der Dienst akzeptiert. |
| KnownSearchBypass |
Bekannte Werte von SearchBypass , die der Dienst akzeptiert. |
| KnownSearchDataExfiltrationProtection |
Bekannte Werte von SearchDataExfiltrationProtection , die der Dienst akzeptiert. |
| KnownSearchSemanticSearch |
Bekannte Werte von SearchSemanticSearch, die der Dienst akzeptiert. |
| KnownSeverity |
Bekannte Werte des Schweregrads , den der Dienst akzeptiert. |
| KnownSharedPrivateLinkResourceAsyncOperationResult |
Bekannte Werte von SharedPrivateLinkResourceAsyncOperationResult, die der Dienst akzeptiert. |
| KnownSharedPrivateLinkResourceProvisioningState |
Bekannte Werte von SharedPrivateLinkResourceProvisioningState , die der Dienst akzeptiert. |
| KnownSharedPrivateLinkResourceStatus |
Bekannte Werte von SharedPrivateLinkResourceStatus, die der Dienst akzeptiert. |
| KnownSkuName |
Bekannte Werte von SkuName, die der Dienst akzeptiert. |
| KnownUnavailableNameReason |
Bekannte Werte von UnavailableNameReason, die der Dienst akzeptiert. |
| KnownUpgradeAvailable |
Bekannte Werte von UpgradeAvailable , die der Dienst akzeptiert. |
Functions
| get |
Gibt aufgrund der letzten |
Details zur Funktion
getContinuationToken(unknown)
Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.
function getContinuationToken(page: unknown): string | undefined
Parameter
- page
-
unknown
Ein Objekt vom Zugriff auf value im IteratorResult aus einem byPage Iterator.
Gibt zurück
string | undefined
Das Fortsetzungstoken, das während zukünftiger Aufrufe an byPage() übergeben werden kann.