Dela via

SearchServiceUpdate interface

  • Referens
Paket:
@azure/arm-search

Parametrarna som används för att uppdatera en Azure Cognitive Search-tjänst.

Extends
Resource

Egenskaper

authOptions

Definierar alternativen för hur dataplanets API för en söktjänst autentiserar begäranden. Det går inte att ange 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. Du kan ange 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 standard3 SKU ä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.
location

Resursens geografiska plats. Detta måste vara en av de Azure Geo-regioner som stöds och registreras (till exempel USA, västra, USA, östra, Sydostasien och så vidare). Den här egenskapen krävs när du skapar en ny resurs.
networkRuleSet

Nätverksspecifika regler som avgör hur den 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 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 Cognitive 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 när 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 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 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 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

Söktjänstens status. 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 är i degraderat, inaktiverat eller feltillstånd 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 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.
tags

Taggar som hjälper dig att kategorisera resursen i Azure Portal.

Ärvda egenskaper

id

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

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

Resurstypen. Till exempel "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 dataplanets API för en söktjänst autentiserar begäranden. Det går inte att ange 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. Du kan ange 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 standard3 SKU ä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

location

Resursens geografiska plats. Detta måste vara en av de Azure Geo-regioner som stöds och registreras (till exempel USA, västra, USA, östra, Sydostasien och så vidare). Den här egenskapen krävs när du skapar en ny resurs.

location?: string

Egenskapsvärde

string

networkRuleSet

Nätverksspecifika regler som avgör hur den 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 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 Cognitive 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 när 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 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?: 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 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 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

Söktjänstens status. 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 är i degraderat, inaktiverat eller feltillstånd 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 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

tags

Taggar som hjälper dig att kategorisera resursen i Azure Portal.

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

Egenskapsvärde

{[propertyName: string]: string}

Information om ärvda egenskaper

id

Fullständigt kvalificerat resurs-ID för resursen. 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ånResource.id

name

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

name?: string

Egenskapsvärde

string

Ärvd frånResource.name

type

Resurstypen. Till exempel "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ånResource.type