SearchServiceUpdate interface
Os parâmetros usados para atualizar um serviço Azure Cognitive Search.
- Extends
Propriedades
auth |
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. |
disable |
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. |
encryption |
Especifica qualquer política relacionada à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa. |
hosting |
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. |
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 da Ásia e assim por diante). Essa propriedade é necessária ao criar um novo recurso. |
network |
Regras específicas de rede que determinam como o serviço de Azure Cognitive Search pode ser alcançado. |
partition |
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. |
private |
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. |
provisioning |
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. |
public |
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. |
replica |
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. |
semantic |
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. |
shared |
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. |
status |
Os detalhes do serviço de pesquisa status. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
tags | Marcas para ajudar a categorizar o recurso no portal do Azure. |
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. |
name | O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
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
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
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
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 da Ásia e assim por diante). Essa propriedade é necessária ao criar um novo recurso.
location?: string
Valor da propriedade
string
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
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
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
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
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
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
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
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
tags
Marcas para ajudar a categorizar o recurso no portal do Azure.
tags?: {[propertyName: string]: string}
Valor da propriedade
{[propertyName: string]: 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 deResource.id
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 deResource.name
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 deResource.type