Dela via

SearchService interface

Paket:
@azure/arm-search

Beskriver en Azure AI Search-tjänst och dess aktuella tillstånd.

Extends
TrackedResource

Egenskaper

authOptions

Definierar alternativen för hur dataplans-API:et för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på sant.
computeType

Konfigurera den här egenskapen så att den stöder söktjänsten med hjälp av antingen Standardberäkning eller Konfidentiell Beräkning i Azure.
dataExfiltrationProtections

En lista över scenarier för dataexfiltrering som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
disableLocalAuth

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.
encryptionWithCmk

Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.
endpoint

Slutpunkten för Azure AI Search-tjänsten.
eTag

En systemgenererad egenskap som representerar tjänstens etag som kan vara för optimistisk samtidighetskontroll under uppdateringar. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
hostingMode

Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".
identity

Resursens identitet.
networkRuleSet

Nätverksspecifika regler som avgör hur Azure AI Search-tjänsten kan nås.
partitionCount

Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.
privateEndpointConnections

Listan över privata slutpunktsanslutningar till Azure AI Search-tjänsten. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
provisioningState

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "Lyckades" eller "Misslyckades". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "Lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
publicNetworkAccess

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.
replicaCount

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.
semanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure AI Search-SKU:er på vissa platser.
serviceUpgradedAt

Datum och tid då söktjänsten senast uppgraderades. Det här fältet är null tills tjänsten uppgraderas för första gången. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
sharedPrivateLinkResources

Listan över delade privata länkresurser som hanteras av Azure AI Search-tjänsten. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
sku

SKU:n för söktjänsten, som avgör prisnivå och kapacitetsgränser. Den här egenskapen krävs när du skapar en ny söktjänst.
status

Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. "etablering": Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel innebär det att Azure AI Search-teamet aktivt undersöker det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
statusDetails

Information om söktjänstens status. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
upgradeAvailable

Anger om söktjänsten har en tillgänglig uppgradering.

Ärvda egenskaper

id

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
location

Den geo-plats där resursen finns
name

Namnet på resursen OBS! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
tags

Resursetiketter.
type

Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

Egenskapsinformation

authOptions

Definierar alternativen för hur dataplans-API:et för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på sant.

authOptions?: DataPlaneAuthOptions

Egenskapsvärde

DataPlaneAuthOptions

computeType

Konfigurera den här egenskapen så att den stöder söktjänsten med hjälp av antingen Standardberäkning eller Konfidentiell Beräkning i Azure.

computeType?: string

Egenskapsvärde

string

dataExfiltrationProtections

En lista över scenarier för dataexfiltrering som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.

dataExfiltrationProtections?: string[]

Egenskapsvärde

string[]

disableLocalAuth

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.

disableLocalAuth?: boolean

Egenskapsvärde

boolean

encryptionWithCmk

Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.

encryptionWithCmk?: EncryptionWithCmk

Egenskapsvärde

EncryptionWithCmk

endpoint

Slutpunkten för Azure AI Search-tjänsten.

endpoint?: string

Egenskapsvärde

string

eTag

En systemgenererad egenskap som representerar tjänstens etag som kan vara för optimistisk samtidighetskontroll under uppdateringar. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

eTag?: string

Egenskapsvärde

string

hostingMode

Gäller endast för standard3 SKU. Du kan ställa in den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För SKU:n standard3 är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

hostingMode?: HostingMode

Egenskapsvärde

HostingMode

identity

Resursens identitet.

identity?: Identity

Egenskapsvärde

Identity

networkRuleSet

Nätverksspecifika regler som avgör hur Azure AI Search-tjänsten kan nås.

networkRuleSet?: NetworkRuleSet

Egenskapsvärde

NetworkRuleSet

partitionCount

Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.

partitionCount?: number

Egenskapsvärde

number

privateEndpointConnections

Listan över privata slutpunktsanslutningar till Azure AI Search-tjänsten. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

privateEndpointConnections?: PrivateEndpointConnection[]

Egenskapsvärde

PrivateEndpointConnection[]

provisioningState

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "Lyckades" eller "Misslyckades". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "Lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

provisioningState?: ProvisioningState

Egenskapsvärde

ProvisioningState

publicNetworkAccess

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

publicNetworkAccess?: string

Egenskapsvärde

string

replicaCount

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusive för standard-SKU:er eller mellan 1 och 3 inklusive för grundläggande SKU.

replicaCount?: number

Egenskapsvärde

number

semanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa Azure AI Search-SKU:er på vissa platser.

semanticSearch?: string

Egenskapsvärde

string

serviceUpgradedAt

Datum och tid då söktjänsten senast uppgraderades. Det här fältet är null tills tjänsten uppgraderas för första gången. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

serviceUpgradedAt?: Date

Egenskapsvärde

Date

sharedPrivateLinkResources

Listan över delade privata länkresurser som hanteras av Azure AI Search-tjänsten. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Egenskapsvärde

SharedPrivateLinkResource[]

sku

SKU:n för söktjänsten, som avgör prisnivå och kapacitetsgränser. Den här egenskapen krävs när du skapar en ny söktjänst.

sku?: Sku

Egenskapsvärde

Sku

status

Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. "etablering": Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten är i tillståndet degraderad, inaktiverad eller fel innebär det att Azure AI Search-teamet aktivt undersöker det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

status?: SearchServiceStatus

Egenskapsvärde

SearchServiceStatus

statusDetails

Information om söktjänstens status. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

statusDetails?: string

Egenskapsvärde

string

upgradeAvailable

Anger om söktjänsten har en tillgänglig uppgradering.

upgradeAvailable?: string

Egenskapsvärde

string

Information om ärvda egenskaper

id

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

id?: string

Egenskapsvärde

string

ärvd frånTrackedResource.id

location

Den geo-plats där resursen finns

location: string

Egenskapsvärde

string

ärvd frånTrackedResource.location

name

Namnet på resursen OBS! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

name?: string

Egenskapsvärde

string

ärvd frånTrackedResource.name

systemData

Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

systemData?: SystemData

Egenskapsvärde

SystemData

ärvs frånTrackedResource.systemData

tags

Resursetiketter.

tags?: {[propertyName: string]: string}

Egenskapsvärde

{[propertyName: string]: string}

ärvs frånTrackedResource.tags

type

Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

type?: string

Egenskapsvärde

string

ärvd frånTrackedResource.type