SearchServiceUpdate interface

Pakket:

@azure/arm-search

De parameters die worden gebruikt om een Azure Cognitive Search-service bij te werken.

Uitbreiding

Resource

Eigenschappen

authOptions	Definieert de opties voor de wijze waarop de gegevensvlak-API van een zoekservice aanvragen verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.
disableLocalAuth	Als deze optie is ingesteld op true, mogen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.
encryptionWithCmk	Hiermee geeft u elk beleid met betrekking tot het versleutelen van resources (zoals indexen) met behulp van klantmanagersleutels binnen een zoekservice.
hostingMode	Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.
identity	De identiteit van de resource.
location	De geografische locatie van de resource. Dit moet een van de ondersteunde en geregistreerde Azure Geo-regio's zijn (bijvoorbeeld VS - west, VS - oost, Azië - zuidoost, enzovoort). Deze eigenschap is vereist bij het maken van een nieuwe resource.
networkRuleSet	Netwerkspecifieke regels die bepalen hoe de Azure Cognitive Search service kan worden bereikt.
partitionCount	Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden groter dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.
privateEndpointConnections	De lijst met privé-eindpuntverbindingen met de Azure Cognitive Search-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
provisioningState	De status van de laatste inrichtingsbewerking die is uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die optreedt terwijl de servicecapaciteit wordt ingesteld. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen pollinginterval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als 'geslaagd' in de aanroep naar Zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
publicNetworkAccess	Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat wijzigingen in bestaande klantresources en sjablonen fouten veroorzaken. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
replicaCount	Het aantal replica's in de zoekservice. Indien opgegeven, moet dit een waarde zijn tussen 1 en 12 voor standaard-SKU's of tussen 1 en 3 voor de Basis-SKU.
semanticSearch	Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. Deze configuratie is alleen mogelijk voor bepaalde Azure Cognitive Search SKU's op bepaalde locaties.
sharedPrivateLinkResources	De lijst met gedeelde Private Link-resources die worden beheerd door de Azure Cognitive Search-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
sku	De SKU van de zoekservice, die prijscategorie en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice.
status	De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'disabled': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'fout': de zoekservice heeft een foutstatus. Als uw service de status gedegradeerd, uitgeschakeld of fout heeft, betekent dit dat het Azure Cognitive Search team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
statusDetails	De details van de status van de zoekservice. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
tags	Tags voor het categoriseren van de resource in de Azure Portal.

Overgenomen eigenschappen

id	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name	De naam van de resource OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
type	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

authOptions

Definieert de opties voor de wijze waarop de gegevensvlak-API van een zoekservice aanvragen verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.

authOptions?: DataPlaneAuthOptions

Waarde van eigenschap

DataPlaneAuthOptions

disableLocalAuth

Als deze optie is ingesteld op true, mogen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.

disableLocalAuth?: boolean

Waarde van eigenschap

boolean

encryptionWithCmk

Hiermee geeft u elk beleid met betrekking tot het versleutelen van resources (zoals indexen) met behulp van klantmanagersleutels binnen een zoekservice.

encryptionWithCmk?: EncryptionWithCmk

Waarde van eigenschap

EncryptionWithCmk

hostingMode

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.

hostingMode?: HostingMode

Waarde van eigenschap

HostingMode

identity

De identiteit van de resource.

identity?: Identity

Waarde van eigenschap

Identity

location

De geografische locatie van de resource. Dit moet een van de ondersteunde en geregistreerde Azure Geo-regio's zijn (bijvoorbeeld VS - west, VS - oost, Azië - zuidoost, enzovoort). Deze eigenschap is vereist bij het maken van een nieuwe resource.

location?: string

Waarde van eigenschap

string

networkRuleSet

Netwerkspecifieke regels die bepalen hoe de Azure Cognitive Search service kan worden bereikt.

networkRuleSet?: NetworkRuleSet

Waarde van eigenschap

NetworkRuleSet

partitionCount

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden groter dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.

partitionCount?: number

Waarde van eigenschap

number

privateEndpointConnections

De lijst met privé-eindpuntverbindingen met de Azure Cognitive Search-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

privateEndpointConnections?: PrivateEndpointConnection[]

Waarde van eigenschap

PrivateEndpointConnection[]

provisioningState

De status van de laatste inrichtingsbewerking die is uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die optreedt terwijl de servicecapaciteit wordt ingesteld. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen pollinginterval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als 'geslaagd' in de aanroep naar Zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

provisioningState?: ProvisioningState

Waarde van eigenschap

ProvisioningState

publicNetworkAccess

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat wijzigingen in bestaande klantresources en sjablonen fouten veroorzaken. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

publicNetworkAccess?: PublicNetworkAccess

Waarde van eigenschap

PublicNetworkAccess

replicaCount

Het aantal replica's in de zoekservice. Indien opgegeven, moet dit een waarde zijn tussen 1 en 12 voor standaard-SKU's of tussen 1 en 3 voor de Basis-SKU.

replicaCount?: number

Waarde van eigenschap

number

semanticSearch

Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. Deze configuratie is alleen mogelijk voor bepaalde Azure Cognitive Search SKU's op bepaalde locaties.

semanticSearch?: string

Waarde van eigenschap

string

sharedPrivateLinkResources

De lijst met gedeelde Private Link-resources die worden beheerd door de Azure Cognitive Search-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Waarde van eigenschap

SharedPrivateLinkResource[]

sku

De SKU van de zoekservice, die prijscategorie en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice.

sku?: Sku

Waarde van eigenschap

Sku

status

De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'disabled': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'fout': de zoekservice heeft een foutstatus. Als uw service de status gedegradeerd, uitgeschakeld of fout heeft, betekent dit dat het Azure Cognitive Search team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

status?: SearchServiceStatus

Waarde van eigenschap

SearchServiceStatus

statusDetails

De details van de status van de zoekservice. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

statusDetails?: string

Waarde van eigenschap

string

tags

Tags voor het categoriseren van de resource in de Azure Portal.

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

Waarde van eigenschap

{[propertyName: string]: string}

Details van overgenomen eigenschap

id

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

Overgenomen vanResource.id

name

De naam van de resource OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

Overgenomen vanResource.name

type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

Overgenomen vanResource.type