SearchServiceUpdate interface

Pacote:

@azure/arm-search

Os parâmetros usados para atualizar um serviço Azure AI Search.

Extends

Resource

Propriedades

authOptions	Define as opções de como a API do plano de dados de um serviço de pesquisa autentica solicitações. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.
computeType	Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.
dataExfiltrationProtections	Uma lista de cenários de exfiltração de dados que não são explicitamente permitidos para o serviço de pesquisa. Atualmente, o único valor suportado é 'Todos' para desativar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.
disableLocalAuth	Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não pode ser definido como true se 'dataPlaneAuthOptions' estiver definido.
encryptionWithCmk	Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa.
endpoint	O ponto de extremidade do serviço Azure AI Search.
eTag	Uma propriedade gerada pelo sistema que representa a etag do serviço que pode ser para controle de simultaneidade otimista durante as atualizações. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
hostingMode	Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.
identity	Detalhes sobre a identidade do serviço de pesquisa. Um valor nulo indica que o serviço de pesquisa não tem nenhuma identidade atribuída.
location	A localização geográfica do recurso. Essa deve ser uma das regiões geográficas do Azure com suporte e registradas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo recurso.
networkRuleSet	Regras específicas de rede que determinam como o serviço Azure AI Search pode ser alcançado.
partitionCount	O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 só são válidos para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.
privateEndpointConnections	A lista de conexões de ponto de extremidade privado para o serviço Azure AI Search. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
provisioningState	O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState muda para 'Succeeded' ou 'Failed'. Os aplicativos cliente podem sondar o status de provisionamento (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como 'Bem-sucedido' diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicNetworkAccess	Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.
replicaCount	O número de réplicas no serviço de pesquisa. Se especificado, deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.
semanticSearch	Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs do Azure AI Search em determinados locais.
serviceUpgradedAt	A data e a hora em que o serviço de pesquisa foi atualizado pela última vez. Este campo será nulo até que o serviço seja atualizado pela primeira vez. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
sharedPrivateLinkResources	A lista de recursos de link privado compartilhado gerenciados pelo serviço Azure AI Search. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
sku	O SKU do serviço de pesquisa, que determina a camada de preço e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa.
status	O status do serviço de pesquisa. Os valores possíveis incluem: 'em execução': O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço de pesquisa está sendo provisionado ou ampliado para cima ou para baixo. «Eliminação»: O serviço de pesquisa está a ser eliminado. 'degradado': O serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desativado': O serviço de pesquisa está desativado. Nesse estado, o serviço rejeitará todas as solicitações de API. 'erro': O serviço de pesquisa está em um estado de erro. 'interrompido': o serviço de pesquisa está em uma assinatura desativada. Se o seu serviço estiver nos estados degradado, desativado ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Os serviços dedicados nesses estados ainda são cobrados com base no número de unidades de pesquisa provisionadas. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
statusDetails	Os detalhes do status do serviço de pesquisa. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags	Tags para ajudar a categorizar o recurso no portal do Azure.
upgradeAvailable	Indica se o serviço de pesquisa tem uma atualização disponível.

Propriedades Herdadas

id	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name	O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes de Propriedade

authOptions

Define as opções de como a API do plano de dados de um serviço de pesquisa autentica solicitações. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.

authOptions?: DataPlaneAuthOptions

Valor de Propriedade

DataPlaneAuthOptions

computeType

Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure.

computeType?: string

Valor de Propriedade

string

dataExfiltrationProtections

Uma lista de cenários de exfiltração de dados que não são explicitamente permitidos para o serviço de pesquisa. Atualmente, o único valor suportado é 'Todos' para desativar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.

dataExfiltrationProtections?: string[]

Valor de Propriedade

string[]

disableLocalAuth

Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não pode ser definido como true se 'dataPlaneAuthOptions' estiver definido.

disableLocalAuth?: boolean

Valor de Propriedade

boolean

encryptionWithCmk

Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa.

encryptionWithCmk?: EncryptionWithCmk

Valor de Propriedade

EncryptionWithCmk

endpoint

O ponto de extremidade do serviço Azure AI Search.

endpoint?: string

Valor de Propriedade

string

eTag

Uma propriedade gerada pelo sistema que representa a etag do serviço que pode ser para controle de simultaneidade otimista durante as atualizações. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

eTag?: string

Valor de Propriedade

string

hostingMode

Aplicável apenas para o padrão 3 SKU. Você pode definir essa propriedade para habilitar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito maior do que os índices máximos permitidos para qualquer outra SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'.

hostingMode?: HostingMode

Valor de Propriedade

HostingMode

identity

Detalhes sobre a identidade do serviço de pesquisa. Um valor nulo indica que o serviço de pesquisa não tem nenhuma identidade atribuída.

identity?: Identity

Valor de Propriedade

Identity

location

A localização geográfica do recurso. Essa deve ser uma das regiões geográficas do Azure com suporte e registradas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo recurso.

location?: string

Valor de Propriedade

string

networkRuleSet

Regras específicas de rede que determinam como o serviço Azure AI Search pode ser alcançado.

networkRuleSet?: NetworkRuleSet

Valor de Propriedade

NetworkRuleSet

partitionCount

O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 só são válidos para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.

partitionCount?: number

Valor de Propriedade

number

privateEndpointConnections

A lista de conexões de ponto de extremidade privado para o serviço Azure AI Search. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

privateEndpointConnections?: PrivateEndpointConnection[]

Valor de Propriedade

PrivateEndpointConnection[]

provisioningState

O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState muda para 'Succeeded' ou 'Failed'. Os aplicativos cliente podem sondar o status de provisionamento (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como 'Bem-sucedido' diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: ProvisioningState

Valor de Propriedade

ProvisioningState

publicNetworkAccess

Esse valor pode ser definido como 'habilitado' para evitar alterações significativas nos recursos e modelos existentes do cliente. Se definido como 'desativado', o tráfego na interface pública não é permitido, e as conexões de ponto final privado seriam o método de acesso exclusivo.

publicNetworkAccess?: string

Valor de Propriedade

string

replicaCount

O número de réplicas no serviço de pesquisa. Se especificado, deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.

replicaCount?: number

Valor de Propriedade

number

semanticSearch

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinadas SKUs do Azure AI Search em determinados locais.

semanticSearch?: string

Valor de Propriedade

string

serviceUpgradedAt

A data e a hora em que o serviço de pesquisa foi atualizado pela última vez. Este campo será nulo até que o serviço seja atualizado pela primeira vez. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

serviceUpgradedAt?: Date

Valor de Propriedade

Date

sharedPrivateLinkResources

A lista de recursos de link privado compartilhado gerenciados pelo serviço Azure AI Search. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Valor de Propriedade

SharedPrivateLinkResource[]

sku

O SKU do serviço de pesquisa, que determina a camada de preço e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa.

sku?: Sku

Valor de Propriedade

Sku

status

O status do serviço de pesquisa. Os valores possíveis incluem: 'em execução': O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisionamento': o serviço de pesquisa está sendo provisionado ou ampliado para cima ou para baixo. «Eliminação»: O serviço de pesquisa está a ser eliminado. 'degradado': O serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desativado': O serviço de pesquisa está desativado. Nesse estado, o serviço rejeitará todas as solicitações de API. 'erro': O serviço de pesquisa está em um estado de erro. 'interrompido': o serviço de pesquisa está em uma assinatura desativada. Se o seu serviço estiver nos estados degradado, desativado ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Os serviços dedicados nesses estados ainda são cobrados com base no número de unidades de pesquisa provisionadas. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

status?: SearchServiceStatus

Valor de Propriedade

SearchServiceStatus

statusDetails

Os detalhes do status do serviço de pesquisa. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

statusDetails?: string

Valor de Propriedade

string

tags

Tags para ajudar a categorizar o recurso no portal do Azure.

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

Valor de Propriedade

{[propertyName: string]: string}

upgradeAvailable

Indica se o serviço de pesquisa tem uma atualização disponível.

upgradeAvailable?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

id

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor de Propriedade

string

herdada deResource.id

name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor de Propriedade

string

herdada deResource.name

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

systemData?: SystemData

Valor de Propriedade

SystemData

herdado de Resource.systemData

type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor de Propriedade

string

herdado de Resource.type