@azure/arm-search package
Klasser
| SearchManagementClient |
Gränssnitt
| AccessRule |
Åtkomstregel i en konfigurationsprofil för nätverkssäkerhetsperimeter |
| AccessRuleProperties |
Egenskaper för åtkomstregel |
| AccessRulePropertiesSubscriptionsItem |
Prenumerationsidentifierare |
| AdminKeyResult |
Svar som innehåller api-nycklarna för primär och sekundär administratör för en viss Azure AI 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 en Microsoft Entra ID-klientorganisation kan användas för autentisering. |
| DataPlaneAuthOptions |
Definierar alternativen för hur söktjänsten autentiserar en dataplansbegäran. Det går inte att ange om "disableLocalAuth" är inställt på sant. |
| EncryptionWithCmk |
Beskriver en princip som avgör hur resurser i söktjänsten ska krypteras med kundhanterade nycklar. |
| Identity |
Information om söktjänstens identitet. Ett null-värde anger att söktjänsten inte har någon tilldelad identitet. |
| IpRule |
IP-begränsningsregeln för Azure AI Search-tjänsten. |
| ListQueryKeysResult |
Svar som innehåller fråge-API-nycklar för en viss Azure AI Search-tjänst. |
| NetworkRuleSet |
Nätverksspecifika regler som avgör hur Azure AI Search-tjänsten kan nås. |
| NetworkSecurityPerimeter |
Information om en nätverkssäkerhetsperimeter (NSP) |
| NetworkSecurityPerimeterConfiguration |
Konfigurationsresurs för nätverkssäkerhetsperimeter (NSP) |
| NetworkSecurityPerimeterConfigurationListResult |
Resultatet av en lista med en begäran om NSP-konfigurationer (nätverkssäkerhetsperimeter). |
| NetworkSecurityPerimeterConfigurationProperties |
Egenskaper för nätverkssäkerhetskonfiguration. |
| NetworkSecurityPerimeterConfigurations |
Gränssnitt som representerar ett NetworkSecurityPerimeterConfigurations. |
| NetworkSecurityPerimeterConfigurationsGetOptionalParams |
Valfria parametrar. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams |
Valfria parametrar. |
| NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams |
Valfria parametrar. |
| NetworkSecurityPerimeterConfigurationsReconcileHeaders |
Definierar rubriker för NetworkSecurityPerimeterConfigurations_reconcile åtgärd. |
| NetworkSecurityPerimeterConfigurationsReconcileOptionalParams |
Valfria parametrar. |
| NetworkSecurityProfile |
Konfigurationsprofil för nätverkssäkerhetsperimeter |
| Operation |
Information om en REST API-åtgärd som returneras från API:et för resursprovideråtgärder |
| OperationDisplay |
Lokaliserad visningsinformation för den här å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 operation. |
| OperationsListOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnection |
Beskriver en befintlig privat slutpunktsanslutning till Azure AI Search-tjänsten. |
| PrivateEndpointConnectionListResult |
Svar som innehåller en lista över privata slutpunktsanslutningar. |
| PrivateEndpointConnectionProperties |
Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten. |
| PrivateEndpointConnectionPropertiesPrivateEndpoint |
Den privata slutpunktsresursen från Microsoft.Network-providern. |
| PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState |
Beskriver det aktuella tillståndet för en befintlig Azure Private Link-tjänstanslutning till den privata 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 AI Search-tjänsten. |
| PrivateLinkResourceProperties |
Beskriver egenskaperna för en privat länkresurs som stöds för Azure AI Search-tjänsten. För en viss API-version representerar detta groupIds 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. |
| ProvisioningIssue |
Beskriver ett etableringsproblem för en nätverkssäkerhetsperimeterkonfiguration |
| ProvisioningIssueProperties |
Information om ett etableringsproblem för en NSP-konfiguration (network security perimeter). Resursprovidrar bör generera separata etableringsproblemelement för varje separat problem som identifieras och innehålla en beskrivande och distinkt beskrivning, samt lämpliga föreslagnaResourceIds och föreslagnaAccessRules |
| ProxyResource |
Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats |
| QueryKey |
Beskriver en API-nyckel för en viss Azure AI Search-tjänst som förmedlar skrivskyddade behörigheter för dokumentsamlingen för ett index. |
| 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. |
| QuotaUsageResultName |
Namnet på den SKU som stöds av Azure AI Search. |
| QuotaUsagesListResult |
Svar som innehåller information om kvotanvändning för alla SKU:er som stöds i Azure AI Search. |
| Resource |
Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser |
| ResourceAssociation |
Information om resursassociation |
| SearchManagementClientOptionalParams |
Valfria parametrar. |
| SearchManagementRequestOptions |
Parameter grupp |
| SearchService |
Beskriver en Azure AI Search-tjänst och dess aktuella tillstånd. |
| SearchServiceListResult |
Svar som innehåller en lista över Azure AI Search-tjänster. |
| SearchServiceUpdate |
Parametrarna som används för att uppdatera en Azure AI Search-tjänst. |
| Services |
Gränssnitt som representerar en tjänst. |
| 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. |
| ServicesUpgradeHeaders |
Definierar rubriker för Services_upgrade åtgärd. |
| ServicesUpgradeOptionalParams |
Valfria parametrar. |
| ShareablePrivateLinkResourceProperties |
Beskriver egenskaperna för en resurstyp som har registrerats för private link-tjänsten, som stöds av Azure AI Search. |
| ShareablePrivateLinkResourceType |
Beskriver en resurstyp som har registrerats för private link-tjänsten, som stöds av Azure AI Search. |
| SharedPrivateLinkResource |
Beskriver en resurs för delad privat länk som hanteras av Azure AI Search-tjänsten. |
| SharedPrivateLinkResourceListResult |
Svar som innehåller en lista över resurser för delad privat länk. |
| SharedPrivateLinkResourceProperties |
Beskriver egenskaperna för en befintlig resurs för delad privat länk som hanteras av Azure AI 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 söktjänst, som avgör faktureringshastighet och kapacitetsbegränsningar. |
| SystemData |
Metadata som rör skapande och senaste ändring av resursen. |
| 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. |
| UserAssignedIdentity |
Användartilldelade identitetsegenskaper |
Typalias
| AadAuthFailureMode |
Definierar värden för AadAuthFailureMode. |
| AccessRuleDirection |
Definierar värden för AccessRuleDirection. Kända värden som stöds av tjänsten
Inkommande: Gäller för inkommande nätverkstrafik för de skyddade resurserna. |
| ActionType |
Definierar värden för ActionType. Kända värden som stöds av tjänstenInternal |
| 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. |
| ComputeType |
Definierar värden för ComputeType. Kända värden som stöds av tjänsten
standard: Skapa tjänsten med standardberäkningen. |
| CreatedByType |
Definierar värden för CreatedByType. Kända värden som stöds av tjänsten
User |
| HostingMode |
Definierar värden för HostingMode. |
| IdentityType |
Definierar värden för IdentityType. Kända värden som stöds av tjänsten
Ingen: Anger att alla identiteter som är associerade med söktjänsten måste tas bort. |
| IssueType |
Definierar värden för IssueType. Kända värden som stöds av tjänsten
Okänd: Okänd problemtyp |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Definierar värden för NetworkSecurityPerimeterConfigurationProvisioningState. Kända värden som stöds av tjänsten
Succeeded |
| NetworkSecurityPerimeterConfigurationsGetResponse |
Innehåller svarsdata för get-åtgärden. |
| NetworkSecurityPerimeterConfigurationsListByServiceNextResponse |
Innehåller svarsdata för åtgärden listByServiceNext. |
| NetworkSecurityPerimeterConfigurationsListByServiceResponse |
Innehåller svarsdata för listByService-åtgärden. |
| NetworkSecurityPerimeterConfigurationsReconcileResponse |
Innehåller svarsdata för avstämningsåtgärden. |
| OperationsListResponse |
Innehåller svarsdata för liståtgärden. |
| Origin |
Definierar värden för Ursprung. Kända värden som stöds av tjänsten
user |
| 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. Kända värden som stöds av tjänsten
Uppdatera: Den privata länktjänstens anslutning håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut. |
| PrivateLinkServiceConnectionStatus |
Definierar värden för PrivateLinkServiceConnectionStatus. |
| ProvisioningState |
Definierar värden för ProvisioningState. |
| PublicNetworkAccess |
Definierar värden för PublicNetworkAccess. Kända värden som stöds av tjänsten
aktiverad: Söktjänsten är tillgänglig för trafik som kommer från det offentliga Internet. |
| 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. |
| ResourceAssociationAccessMode |
Definierar värden för ResourceAssociationAccessMode. Kända värden som stöds av tjänsten
Framtvingad: Framtvingat åtkomstläge – trafik till resursen som misslyckades med åtkomstkontroller blockeras |
| SearchBypass |
Definierar värden för SearchBypass. Kända värden som stöds av tjänsten
Ingen: Anger att inget ursprung kan kringgå de regler som definierats i avsnittet "ipRules". Det här är standardinställningen. |
| SearchDataExfiltrationProtection |
Definierar värden för SearchDataExfiltrationProtection. Kända värden som stöds av tjänstenBlockAll: Anger att alla scenarier för dataexfiltrering är inaktiverade. |
| SearchEncryptionComplianceStatus |
Definierar värden för SearchEncryptionComplianceStatus. |
| SearchEncryptionWithCmk |
Definierar värden för SearchEncryptionWithCmk. |
| SearchSemanticSearch |
Definierar värden för SearchSemanticSearch. Kända värden som stöds av tjänsten
disabled: Anger att semantisk omrankning är inaktiverad för söktjänsten. Det här är standardinställningen. |
| 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 listBySubscription-åtgärden. |
| ServicesUpdateResponse |
Innehåller svarsdata för uppdateringsåtgärden. |
| ServicesUpgradeResponse |
Innehåller svarsdata för uppgraderingsåtgärden. |
| Severity |
Definierar värden för allvarlighetsgrad. Kända värden som stöds av tjänsten
Warning |
| SharedPrivateLinkResourceAsyncOperationResult |
Definierar värden för SharedPrivateLinkResourceAsyncOperationResult. Kända värden som stöds av tjänsten
Running |
| SharedPrivateLinkResourceProvisioningState |
Definierar värden för SharedPrivateLinkResourceProvisioningState. Kända värden som stöds av tjänsten
Uppdaterar: Den delade privata länkresursen håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut. |
| SharedPrivateLinkResourceStatus |
Definierar värden för SharedPrivateLinkResourceStatus. Kända värden som stöds av tjänsten
Väntande: Den delade privata länkresursen har skapats och väntar på godkännande. |
| 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 listByService-åtgärden. |
| SkuName |
Definierar värden för SkuName. Kända värden som stöds av tjänsten
kostnadsfri: Kostnadsfri nivå, utan SLA-garantier och en delmängd av de funktioner som erbjuds på fakturerbara nivåer. |
| UnavailableNameReason |
Definierar värden för UnavailableNameReason. Kända värden som stöds av tjänsten
Ogiltig: Söktjänstens namn matchar inte namngivningskraven. |
| UpgradeAvailable |
Definierar värden för UpgradeAvailable. Kända värden som stöds av tjänsten
notAvailable: En uppgradering är för närvarande inte tillgänglig för tjänsten. |
| UsageBySubscriptionSkuResponse |
Innehåller svarsdata för åtgärden usageBySubscriptionSku. |
| UsagesListBySubscriptionNextResponse |
Innehåller svarsdata för åtgärden listBySubscriptionNext. |
| UsagesListBySubscriptionResponse |
Innehåller svarsdata för listBySubscription-åtgärden. |
Uppräkningar
Funktioner
| get |
Med tanke på den senaste |
Funktionsinformation
getContinuationToken(unknown)
Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.
function getContinuationToken(page: unknown): string | undefined
Parametrar
- page
-
unknown
Ett objekt från att komma åt value på IteratorResult från en byPage iterator.
Returer
string | undefined
Fortsättningstoken som kan skickas till byPage() under framtida anrop.