SearchService interface
Descreve um serviço do Azure AI Search e seu estado atual.
- 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. |
| compute |
Configure essa propriedade para dar suporte ao serviço de pesquisa usando a Computação Padrão ou a Computação Confidencial do Azure. |
| data |
Uma lista de cenários de exfiltração de dados explicitamente não permitidos para o serviço de pesquisa. Atualmente, o único valor com suporte é "Todos" para desabilitar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro. |
| 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' estiver definido. |
| encryption |
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. |
| e |
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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| hosting |
Aplicável somente para o SKU standard3. 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 é "padrão" ou "highDensity". Para todos os outros SKUs, esse valor deve ser "padrão". |
| identity | A identidade do recurso. |
| network |
Regras específicas de rede que determinam como o serviço Azure AI Search pode ser atingido. |
| 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ão válidos apenas 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 AI 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 'Êxito' ou 'Falha'. 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: 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 significativas em modelos e recursos de clientes existentes. 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ásica. |
| semantic |
Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinados SKUs do Azure AI Search em determinados locais. |
| service |
A data e a hora em que o serviço de pesquisa foi atualizado pela última vez. Esse campo será nulo até que o serviço seja atualizado pela primeira vez. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| shared |
A lista de recursos de link privado compartilhados gerenciados pelo serviço Azure AI Search. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| sku | A SKU do serviço de pesquisa, que determina o tipo 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. 'provisionamento': o serviço de pesquisa está sendo provisionado ou expandido para cima ou para baixo. 'exclusão': 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 rejeitará todas as solicitações de API. 'error': o serviço de pesquisa está em um estado de erro. 'parado': o serviço de pesquisa está em uma assinatura desabilitada. Se o serviço estiver nos estados degradados, desabilitados 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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| status |
Os detalhes do status do serviço de pesquisa. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| upgrade |
Indica se o serviço de pesquisa tem uma atualização disponível. |
Propriedades herdadas
| id | ID de recurso totalmente qualificada para o recurso. Por exemplo, "/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 onde o recurso reside |
| name | O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| system |
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
| tags | Tags de recursos. |
| type | O 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
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 da propriedade
string
dataExfiltrationProtections
Uma lista de cenários de exfiltração de dados explicitamente não permitidos para o serviço de pesquisa. Atualmente, o único valor com suporte é "Todos" para desabilitar todos os cenários possíveis de exportação de dados com controles mais refinados planejados para o futuro.
dataExfiltrationProtections?: string[]
Valor da 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 poderá ser definido como true se 'dataPlaneAuthOptions' estiver definido.
disableLocalAuth?: boolean
Valor da 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 da propriedade
endpoint
O ponto de extremidade do serviço Azure AI Search.
endpoint?: string
Valor da 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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
eTag?: string
Valor da propriedade
string
hostingMode
Aplicável somente para o SKU standard3. 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 é "padrão" ou "highDensity". Para todos os outros SKUs, esse valor deve ser "padrão".
hostingMode?: HostingMode
Valor da propriedade
identity
networkRuleSet
Regras específicas de rede que determinam como o serviço Azure AI Search pode ser atingido.
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ão válidos apenas 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 AI 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 'Êxito' ou 'Falha'. 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: 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 significativas em modelos e recursos de clientes existentes. 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?: string
Valor da propriedade
string
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ásica.
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 do Azure AI Search em determinados locais.
semanticSearch?: string
Valor da propriedade
string
serviceUpgradedAt
A data e a hora em que o serviço de pesquisa foi atualizado pela última vez. Esse campo será nulo até que o serviço seja atualizado pela primeira vez. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
serviceUpgradedAt?: Date
Valor da propriedade
Date
sharedPrivateLinkResources
A lista de recursos de link privado compartilhados gerenciados pelo serviço Azure AI Search. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
sharedPrivateLinkResources?: SharedPrivateLinkResource[]
Valor da propriedade
sku
A SKU do serviço de pesquisa, que determina o tipo 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. 'provisionamento': o serviço de pesquisa está sendo provisionado ou expandido para cima ou para baixo. 'exclusão': 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 rejeitará todas as solicitações de API. 'error': o serviço de pesquisa está em um estado de erro. 'parado': o serviço de pesquisa está em uma assinatura desabilitada. Se o serviço estiver nos estados degradados, desabilitados 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: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
status?: SearchServiceStatus
Valor da propriedade
statusDetails
Os detalhes do status do serviço de pesquisa. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
statusDetails?: string
Valor da propriedade
string
upgradeAvailable
Indica se o serviço de pesquisa tem uma atualização disponível.
upgradeAvailable?: string
Valor da propriedade
string
Detalhes das propriedades herdadas
id
ID de recurso totalmente qualificada para o recurso. Por exemplo, "/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 onde 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
systemData
Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
systemData?: SystemData
Valor da propriedade
herdado detrackedResource.systemData
tags
Tags de recursos.
tags?: {[propertyName: string]: string}
Valor da propriedade
{[propertyName: string]: string}
Herdado deTrackedResource.tags
type
O 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