SearchService interface

Paket:

@azure/arm-search

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

Extends

TrackedResource

Egenskaper

authOptions	Definierar alternativen för hur api:et för dataplanet för en söktjänst autentiserar begäranden. Det går inte att ange detta om "disableLocalAuth" är inställt på true.
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.
hostingMode	Gäller endast för standard3-SKU:n. Du kan ange den här egenskapen för att aktivera upp till 3 högdensitetspartitioner som tillåter upp till 1 000 index, vilket är mycket högre än det högsta antalet index som tillåts för andra SKU:er. För standard3-SKU:n är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "default".
identity	Resursens identitet.
networkRuleSet	Nätverksspecifika regler som bestämmer hur Azure Cognitive 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 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 Cognitive Search-tjänsten. Obs! Den här egenskapen serialiseras inte. 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 "succeeded" eller "failed". 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 serialiseras inte. 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 värdet är "inaktiverat" tillåts inte trafik via offentligt gränssnitt, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.
replicaCount	Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusivt för standard-SKU:er eller mellan 1 och 3 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 Cognitive Search SKU:er på vissa platser.
sharedPrivateLinkResources	Listan över delade privata länkresurser som hanteras av Azure Cognitive Search-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
sku	SKU:n för söktjänsten, som bestämmer 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. Om tjänsten har degraderats, inaktiverats eller feltillståndet innebär det att Azure Cognitive 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 serialiseras inte. Den kan bara fyllas i av servern.
statusDetails	Information om söktjänstens status. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

Ärvda egenskaper

id	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /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.
tags	Resurstaggar.
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 api:et för dataplanet för en söktjänst autentiserar begäranden. Det går inte att ange detta om "disableLocalAuth" är inställt på true.

authOptions?: DataPlaneAuthOptions

Egenskapsvärde

DataPlaneAuthOptions

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

hostingMode

Gäller endast för standard3-SKU:n. Du kan ange den här egenskapen för att aktivera upp till 3 högdensitetspartitioner som tillåter upp till 1 000 index, vilket är mycket högre än det högsta antalet index som tillåts för andra SKU:er. För standard3-SKU:n är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "default".

hostingMode?: HostingMode

Egenskapsvärde

HostingMode

identity

Resursens identitet.

identity?: Identity

Egenskapsvärde

Identity

networkRuleSet

Nätverksspecifika regler som bestämmer hur Azure Cognitive 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 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 Cognitive Search-tjänsten. Obs! Den här egenskapen serialiseras inte. 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 "succeeded" eller "failed". 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 serialiseras inte. 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 värdet är "inaktiverat" tillåts inte trafik via offentligt gränssnitt, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.

publicNetworkAccess?: PublicNetworkAccess

Egenskapsvärde

PublicNetworkAccess

replicaCount

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusivt för standard-SKU:er eller mellan 1 och 3 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 Cognitive Search SKU:er på vissa platser.

semanticSearch?: string

Egenskapsvärde

string

sharedPrivateLinkResources

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

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Egenskapsvärde

SharedPrivateLinkResource[]

sku

SKU:n för söktjänsten, som bestämmer 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. Om tjänsten har degraderats, inaktiverats eller feltillståndet innebär det att Azure Cognitive 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 serialiseras inte. Den kan bara fyllas i av servern.

status?: SearchServiceStatus

Egenskapsvärde

SearchServiceStatus

statusDetails

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

statusDetails?: string

Egenskapsvärde

string

Information om ärvda egenskaper

id

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /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

tags

Resurstaggar.

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

Egenskapsvärde

{[propertyName: string]: string}

Ärvd 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