SearchService interface

Pacote:

@azure/arm-search

Descreve um serviço de Azure Cognitive Search e seu estado atual.

Extends

TrackedResource

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 poderá ser definido se 'disableLocalAuth' estiver definido como true.
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 poderá ser definido como true se 'dataPlaneAuthOptions' for definido.
encryptionWithCmk	Especifica qualquer política relacionada à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa.
hostingMode	Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três 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	A identidade do recurso.
networkRuleSet	Regras específicas de rede que determinam como o serviço de Azure Cognitive 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 com o serviço Azure Cognitive Search. OBSERVAÇÃO: essa 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 é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicNetworkAccess	Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas nos recursos e modelos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo.
replicaCount	O número de réplicas no serviço de pesquisa. Se especificado, ele 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 determinados SKUs de Azure Cognitive Search em determinados locais.
sharedPrivateLinkResources	A lista de recursos de link privado compartilhado gerenciados pelo serviço Azure Cognitive Search. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
sku	O SKU do Serviço de Pesquisa, que determina o nível de preço e os limites de capacidade. Essa 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. 'provisioning': o serviço de pesquisa está sendo provisionado ou escalado verticalmente ou reduzido. 'deleting': o serviço de pesquisa está sendo excluído. '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. 'desabilitado': o serviço de pesquisa está desabilitado. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço de pesquisa está em um estado de erro. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe de Azure Cognitive Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
statusDetails	Os detalhes do serviço de pesquisa status. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Propriedades herdadas

id	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
location	A localização geográfica em que o recurso reside
name	O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags	Marcas de recurso.
type	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da 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 poderá ser definido se 'disableLocalAuth' estiver definido como true.

authOptions?: DataPlaneAuthOptions

Valor da propriedade

DataPlaneAuthOptions

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 poderá ser definido como true se 'dataPlaneAuthOptions' for definido.

disableLocalAuth?: boolean

Valor da propriedade

boolean

encryptionWithCmk

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

encryptionWithCmk?: EncryptionWithCmk

Valor da propriedade

EncryptionWithCmk

hostingMode

Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três 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 da propriedade

HostingMode

identity

A identidade do recurso.

identity?: Identity

Valor da propriedade

Identity

networkRuleSet

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

networkRuleSet?: NetworkRuleSet

Valor da 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 da propriedade

number

privateEndpointConnections

A lista de conexões de ponto de extremidade privado com o serviço Azure Cognitive Search. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

privateEndpointConnections?: PrivateEndpointConnection[]

Valor da 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 é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: ProvisioningState

Valor da propriedade

ProvisioningState

publicNetworkAccess

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

publicNetworkAccess?: PublicNetworkAccess

Valor da propriedade

PublicNetworkAccess

replicaCount

O número de réplicas no serviço de pesquisa. Se especificado, ele 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 da propriedade

number

semanticSearch

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

semanticSearch?: string

Valor da propriedade

string

sharedPrivateLinkResources

A lista de recursos de link privado compartilhado gerenciados pelo serviço Azure Cognitive Search. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Valor da propriedade

SharedPrivateLinkResource[]

sku

O SKU do Serviço de Pesquisa, que determina o nível de preço e os limites de capacidade. Essa propriedade é necessária ao criar um novo Serviço de Pesquisa.

sku?: Sku

Valor da 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. 'provisioning': o serviço de pesquisa está sendo provisionado ou escalado verticalmente ou reduzido. 'deleting': o serviço de pesquisa está sendo excluído. '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. 'desabilitado': o serviço de pesquisa está desabilitado. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço de pesquisa está em um estado de erro. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe de Azure Cognitive Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

status?: SearchServiceStatus

Valor da propriedade

SearchServiceStatus

statusDetails

Os detalhes do serviço de pesquisa status. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

statusDetails?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

Herdado deTrackedResource.id

location

A localização geográfica em que o recurso reside

location: string

Valor da propriedade

string

Herdado deTrackedResource.location

name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

Herdado deTrackedResource.name

tags

Marcas de recurso.

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

Valor da propriedade

{[propertyName: string]: string}

Herdado deTrackedResource.tags

type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deTrackedResource.type