Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Definição de recursos do bíceps
O tipo de recurso searchServices pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Exemplos de uso
Amostras do Bicep
Um exemplo básico de implantação do Serviço de Pesquisa.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource searchService 'Microsoft.Search/searchServices@2022-09-01' = {
name: resourceName
location: location
sku: {
name: 'standard'
}
properties: {
authOptions: {
apiKeyOnly: {}
}
disableLocalAuth: false
encryptionWithCmk: {
enforcement: 'Disabled'
}
hostingMode: 'default'
networkRuleSet: {
ipRules: []
}
partitionCount: 1
publicNetworkAccess: 'Enabled'
replicaCount: 1
}
tags: {
environment: 'staging'
}
}
Módulos verificados do Azure
Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.
| Módulo | Descrição |
|---|---|
| Serviço de Pesquisa | Módulo de recursos AVM para serviço de pesquisa |
Exemplos de início rápido do Azure
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.
| Arquivo Bicep | Descrição |
|---|---|
| Azure AI Foundry Network Restrito | Este conjunto de modelos demonstra como configurar o Azure AI Foundry com link privado e saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA. |
| serviço de Pesquisa Cognitiva do Azure | Este modelo cria um serviço de Pesquisa Cognitiva do Azure |
| Agente Protegido em Rede com de Identidade Gerenciada pelo Usuário | Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com isolamento de rede virtual usando a autenticação de Identidade Gerenciada pelo Usuário para a conexão AI Service/AOAI e links de rede privada para conectar o agente aos seus dados seguros. |
| Configuração do agente padrão | Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com a configuração padrão, ou seja, com a autenticação de identidade gerenciada para conexões de projeto/hub e acesso público à Internet habilitado. Os agentes usam recursos de pesquisa e armazenamento de propriedade do cliente e de locatário único. Com essa configuração, você tem total controle e visibilidade sobre esses recursos, mas incorrerá em custos com base no seu uso. |
Formato do recurso
Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte Bíceps ao seu modelo.
resource symbolicname 'Microsoft.Search/searchServices@2026-03-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any(...)
}
computeType: 'string'
dataExfiltrationProtections: [
'string'
]
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
serviceLevelEncryptionKey: {
accessCredentials: {
applicationId: 'string'
applicationSecret: 'string'
}
identity: {
@odata.type: 'string'
// For remaining properties, see DataIdentity objects
}
keyVaultKeyName: 'string'
keyVaultKeyVersion: 'string'
keyVaultUri: 'string'
}
}
endpoint: 'string'
hostingMode: 'string'
knowledgeRetrieval: 'string'
networkRuleSet: {
bypass: 'string'
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
upgradeAvailable: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Objetos DataIdentity
Defina a propriedade
Para #Microsoft.Azure.Search.DataNoneIdentity, use:
{
@odata.type: '#Microsoft.Azure.Search.DataNoneIdentity'
}
Para #Microsoft.Azure.Search.DataUserAssignedIdentity, use:
{
@odata.type: '#Microsoft.Azure.Search.DataUserAssignedIdentity'
federatedIdentityClientId: 'string'
userAssignedIdentity: 'string'
}
Valores de propriedade
Microsoft.Search/searchServices
| Nome | Descrição | valor |
|---|---|---|
| identidade | A identidade do recurso. | Identidade |
| localização | A geolocalização onde o recurso vive | string (obrigatório) |
| Nome | O nome do recurso | string Restrições: Padrão = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (obrigatório) |
| propriedades | Propriedades do serviço de pesquisa. | SearchServiceProperties |
| 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 |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
AzureActiveDirectoryApplicationCredentials
| Nome | Descrição | valor |
|---|---|---|
| applicationId | O ID da aplicação (cliente) de um registo de aplicação no tenant. | cadeia (de caracteres) |
| applicationSecret | Um segredo de cliente AAD gerado para o Registo de Aplicações usado para autenticação com o Azure Key Vault. | string Restrições: Valor sensível. Passe como um parâmetro seguro. |
Identidade de dados
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Defina como '#Microsoft.Azure.Search.DataNoneIdentity' para o tipo DataNoneIdentity. Defina como '#Microsoft.Azure.Search.DataUserAssignedIdentity' para o tipo DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obrigatório) |
DataNoneIdentity
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Um fragmento de URI especificando o tipo de identidade. | '#Microsoft.Azure.Search.DataNoneIdentity' (obrigatório) |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrição | valor |
|---|---|---|
| aadAuthFailureMode | Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação. | 'http401WithBearerChallenge' 'http403' |
DataPlaneAuthOptions
| Nome | Descrição | valor |
|---|---|---|
| aadOrApiKey | Indica que a chave de API ou um token de acesso de um locatário do Microsoft Entra ID pode ser usado para autenticação. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica que apenas a chave da API pode ser usada para autenticação. | any |
DataUserAssignedIdentity
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Um fragmento de URI especificando o tipo de identidade. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obrigatório) |
| federatedIdentityClientId | Opcional para Suporte a CMK Multi-tenant User-Assigned Managed Identity: O id do cliente (como UUID) do Registo de Aplicações multi-tenant que foi configurado para federar com o userAssignedIdentity. | cadeia (de caracteres) |
| userAssignedIdentity | A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa. | string (obrigatório) |
EncryptionWithCmk
| Nome | Descrição | valor |
|---|---|---|
| imposição | Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente. | 'Desativado' 'Habilitado' 'Não especificado' |
| serviceLevelEncryptionKey | Descreve a configuração da chave gerida pelo cliente para encriptar o serviço de pesquisa. | SearchResourceEncryptionKey |
Identidade
IdentityUserAssignedIdentities
| Nome | Descrição | valor |
|---|
IpRule
| Nome | Descrição | valor |
|---|---|---|
| value | Valor correspondente a um único endereço IPv4 (por exemplo, 123.1.2.3) ou um intervalo de IP em formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido. | cadeia (de caracteres) |
NetworkRuleSet
| Nome | Descrição | valor |
|---|---|---|
| Desvio | Possíveis origens do tráfego de entrada que pode ignorar as regras definidas na seção 'ipRules'. | 'AzurePortal' 'AzureServices' 'Nenhuma' |
| ipRules | Uma lista de regras de restrição de IP que define a(s) rede(s) de entrada com permissão de acesso ao ponto de extremidade do serviço de pesquisa. Enquanto isso, todas as outras redes IP públicas são bloqueadas pelo firewall. Estas regras de restrição são aplicadas apenas quando o «acesso públicoà rede» do serviço de pesquisa está «ativado»; caso contrário, o tráfego na interface pública não é permitido, mesmo com quaisquer regras de IP públicas, e as conexões de ponto final privadas seriam o método de acesso exclusivo. | IpRule[] |
SearchResourceEncryptionKey
| Nome | Descrição | valor |
|---|---|---|
| accessCredenciais | Credenciais opcionais do Azure Ative Directory usadas para acessar seu Cofre da Chave do Azure. Não é necessário se estiver usando a identidade gerenciada. | AzureActiveDirectoryApplicationCredentials |
| identidade | Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo. | Identidade de dados |
| keyVaultKeyName | O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso. | cadeia (de caracteres) |
| keyVaultKeyVersion | A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso. | cadeia (de caracteres) |
| keyVaultUri | O URI do seu Cofre da Chave do Azure, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser https://my-keyvault-name.vault.azure.net. |
cadeia (de caracteres) |
SearchServiceProperties
| Nome | Descrição | valor |
|---|---|---|
| authOpções | 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. | 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. | 'Confidencial' 'Default' |
| 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. | Matriz de cadeia de caracteres contendo qualquer uma das: 'BlockAll' |
| 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. | bool |
| criptografiaWithCmk | Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa. | EncryptionWithCmk |
| ponto final | O ponto de extremidade do serviço Pesquisa de IA do Azure. | cadeia (de caracteres) |
| 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 padrão3, o valor é 'Default' ou 'HighDensity'. Para todos os outros SKUs, esse valor deve ser 'Default'. | 'Default' 'Alta densidade' |
| conhecimentoRecuperação | Especifica o plano de faturação para recuperação agential no serviço Pesquisa de IA do Azure. Esta configuração está disponível apenas para certos escalões de preços em determinadas regiões. | 'grátis' 'standard' |
| networkRuleSet | Regras específicas de rede que determinam como o serviço Pesquisa de IA do Azure pode ser alcançado. | NetworkRuleSet |
| númeroDePartições | O número de partições no serviço de pesquisa dedicado; 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. | int Restrições: Valor mínimo = 1 Valor máximo = 12 |
| acesso à rede pública | 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. | 'Desativado' 'Habilitado' 'SecuredByPerimeter' |
| replicaCount | O número de réplicas no serviço de pesquisa dedicado. 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. | int Restrições: Valor mínimo = 1 Valor máximo = 12 |
| pesquisa semântica | Especifica a disponibilidade e o plano de faturação para pesquisa semântica no serviço Pesquisa de IA do Azure. Esta configuração está disponível apenas para certos escalões de preços em determinadas regiões. | 'deficientes' 'grátis' 'standard' |
| upgradeDisponível | Indica se o serviço de pesquisa tem uma atualização disponível. | 'disponível' 'não disponível' |
Sku
| Nome | Descrição | valor |
|---|---|---|
| Nome | O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições. 'serverless': Nível serverless com capacidades de auto-escalabilidade. | 'basic' 'grátis' 'Sem servidor' 'standard' «Norma2» «Norma3» 'storage_optimized_l1' 'storage_optimized_l2' |
TrackedResourceTags
| Nome | Descrição | valor |
|---|
UserAssignedIdentity
| Nome | Descrição | valor |
|---|
Definição de recurso de modelo ARM
O tipo de recurso searchServices pode ser implantado com operações direcionadas:
- Grupos de recursos - Ver comandos de implementação de grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, consulte registo de alterações.
Exemplos de uso
Modelos de início rápido do Azure
Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.
| Template | Descrição |
|---|---|
|
Azure AI Foundry Network Restrito |
Este conjunto de modelos demonstra como configurar o Azure AI Foundry com link privado e saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA. |
|
serviço de Pesquisa Cognitiva do Azure |
Este modelo cria um serviço de Pesquisa Cognitiva do Azure |
|
serviço de Pesquisa Cognitiva do Azure com de ponto de extremidade privado |
Este modelo cria um serviço de Pesquisa Cognitiva do Azure com um ponto de extremidade privado. |
|
Agente Protegido em Rede com de Identidade Gerenciada pelo Usuário |
Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com isolamento de rede virtual usando a autenticação de Identidade Gerenciada pelo Usuário para a conexão AI Service/AOAI e links de rede privada para conectar o agente aos seus dados seguros. |
|
Configuração do agente padrão |
Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com a configuração padrão, ou seja, com a autenticação de identidade gerenciada para conexões de projeto/hub e acesso público à Internet habilitado. Os agentes usam recursos de pesquisa e armazenamento de propriedade do cliente e de locatário único. Com essa configuração, você tem total controle e visibilidade sobre esses recursos, mas incorrerá em custos com base no seu uso. |
|
Aplicação Web com Base de Dados SQL, Azure Cosmos DB Azure Pesquisa |
Este modelo prevê uma Web App, uma Base de Dados SQL, Azure Cosmos DB, Azure Search e Application Insights. |
Formato do recurso
Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2026-03-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"computeType": "string",
"dataExfiltrationProtections": [ "string" ],
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string",
"serviceLevelEncryptionKey": {
"accessCredentials": {
"applicationId": "string",
"applicationSecret": "string"
},
"identity": {
"@odata.type": "string"
// For remaining properties, see DataIdentity objects
},
"keyVaultKeyName": "string",
"keyVaultKeyVersion": "string",
"keyVaultUri": "string"
}
},
"endpoint": "string",
"hostingMode": "string",
"knowledgeRetrieval": "string",
"networkRuleSet": {
"bypass": "string",
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string",
"upgradeAvailable": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Objetos DataIdentity
Defina a propriedade
Para #Microsoft.Azure.Search.DataNoneIdentity, use:
{
"@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}
Para #Microsoft.Azure.Search.DataUserAssignedIdentity, use:
{
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"federatedIdentityClientId": "string",
"userAssignedIdentity": "string"
}
Valores de propriedade
Microsoft.Search/searchServices
| Nome | Descrição | valor |
|---|---|---|
| apiVersion | A versão api | 'Pré-visualização de 2026-03-01' |
| identidade | A identidade do recurso. | Identidade |
| localização | A geolocalização onde o recurso vive | string (obrigatório) |
| Nome | O nome do recurso | string Restrições: Padrão = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (obrigatório) |
| propriedades | Propriedades do serviço de pesquisa. | SearchServiceProperties |
| 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 |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
| tipo | O tipo de recurso | 'Microsoft.Search/searchServices' |
AzureActiveDirectoryApplicationCredentials
| Nome | Descrição | valor |
|---|---|---|
| applicationId | O ID da aplicação (cliente) de um registo de aplicação no tenant. | cadeia (de caracteres) |
| applicationSecret | Um segredo de cliente AAD gerado para o Registo de Aplicações usado para autenticação com o Azure Key Vault. | string Restrições: Valor sensível. Passe como um parâmetro seguro. |
Identidade de dados
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Defina como '#Microsoft.Azure.Search.DataNoneIdentity' para o tipo DataNoneIdentity. Defina como '#Microsoft.Azure.Search.DataUserAssignedIdentity' para o tipo DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obrigatório) |
DataNoneIdentity
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Um fragmento de URI especificando o tipo de identidade. | '#Microsoft.Azure.Search.DataNoneIdentity' (obrigatório) |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrição | valor |
|---|---|---|
| aadAuthFailureMode | Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação. | 'http401WithBearerChallenge' 'http403' |
DataPlaneAuthOptions
| Nome | Descrição | valor |
|---|---|---|
| aadOrApiKey | Indica que a chave de API ou um token de acesso de um locatário do Microsoft Entra ID pode ser usado para autenticação. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica que apenas a chave da API pode ser usada para autenticação. | any |
DataUserAssignedIdentity
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Um fragmento de URI especificando o tipo de identidade. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obrigatório) |
| federatedIdentityClientId | Opcional para Suporte a CMK Multi-tenant User-Assigned Managed Identity: O id do cliente (como UUID) do Registo de Aplicações multi-tenant que foi configurado para federar com o userAssignedIdentity. | cadeia (de caracteres) |
| userAssignedIdentity | A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa. | string (obrigatório) |
EncryptionWithCmk
| Nome | Descrição | valor |
|---|---|---|
| imposição | Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente. | 'Desativado' 'Habilitado' 'Não especificado' |
| serviceLevelEncryptionKey | Descreve a configuração da chave gerida pelo cliente para encriptar o serviço de pesquisa. | SearchResourceEncryptionKey |
Identidade
IdentityUserAssignedIdentities
| Nome | Descrição | valor |
|---|
IpRule
| Nome | Descrição | valor |
|---|---|---|
| value | Valor correspondente a um único endereço IPv4 (por exemplo, 123.1.2.3) ou um intervalo de IP em formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido. | cadeia (de caracteres) |
NetworkRuleSet
| Nome | Descrição | valor |
|---|---|---|
| Desvio | Possíveis origens do tráfego de entrada que pode ignorar as regras definidas na seção 'ipRules'. | 'AzurePortal' 'AzureServices' 'Nenhuma' |
| ipRules | Uma lista de regras de restrição de IP que define a(s) rede(s) de entrada com permissão de acesso ao ponto de extremidade do serviço de pesquisa. Enquanto isso, todas as outras redes IP públicas são bloqueadas pelo firewall. Estas regras de restrição são aplicadas apenas quando o «acesso públicoà rede» do serviço de pesquisa está «ativado»; caso contrário, o tráfego na interface pública não é permitido, mesmo com quaisquer regras de IP públicas, e as conexões de ponto final privadas seriam o método de acesso exclusivo. | IpRule[] |
SearchResourceEncryptionKey
| Nome | Descrição | valor |
|---|---|---|
| accessCredenciais | Credenciais opcionais do Azure Ative Directory usadas para acessar seu Cofre da Chave do Azure. Não é necessário se estiver usando a identidade gerenciada. | AzureActiveDirectoryApplicationCredentials |
| identidade | Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo. | Identidade de dados |
| keyVaultKeyName | O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso. | cadeia (de caracteres) |
| keyVaultKeyVersion | A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso. | cadeia (de caracteres) |
| keyVaultUri | O URI do seu Cofre da Chave do Azure, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser https://my-keyvault-name.vault.azure.net. |
cadeia (de caracteres) |
SearchServiceProperties
| Nome | Descrição | valor |
|---|---|---|
| authOpções | 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. | 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. | 'Confidencial' 'Default' |
| 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. | Matriz de cadeia de caracteres contendo qualquer uma das: 'BlockAll' |
| 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. | bool |
| criptografiaWithCmk | Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa. | EncryptionWithCmk |
| ponto final | O ponto de extremidade do serviço Pesquisa de IA do Azure. | cadeia (de caracteres) |
| 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 padrão3, o valor é 'Default' ou 'HighDensity'. Para todos os outros SKUs, esse valor deve ser 'Default'. | 'Default' 'Alta densidade' |
| conhecimentoRecuperação | Especifica o plano de faturação para recuperação agential no serviço Pesquisa de IA do Azure. Esta configuração está disponível apenas para certos escalões de preços em determinadas regiões. | 'grátis' 'standard' |
| networkRuleSet | Regras específicas de rede que determinam como o serviço Pesquisa de IA do Azure pode ser alcançado. | NetworkRuleSet |
| númeroDePartições | O número de partições no serviço de pesquisa dedicado; 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. | int Restrições: Valor mínimo = 1 Valor máximo = 12 |
| acesso à rede pública | 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. | 'Desativado' 'Habilitado' 'SecuredByPerimeter' |
| replicaCount | O número de réplicas no serviço de pesquisa dedicado. 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. | int Restrições: Valor mínimo = 1 Valor máximo = 12 |
| pesquisa semântica | Especifica a disponibilidade e o plano de faturação para pesquisa semântica no serviço Pesquisa de IA do Azure. Esta configuração está disponível apenas para certos escalões de preços em determinadas regiões. | 'deficientes' 'grátis' 'standard' |
| upgradeDisponível | Indica se o serviço de pesquisa tem uma atualização disponível. | 'disponível' 'não disponível' |
Sku
| Nome | Descrição | valor |
|---|---|---|
| Nome | O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições. 'serverless': Nível serverless com capacidades de auto-escalabilidade. | 'basic' 'grátis' 'Sem servidor' 'standard' «Norma2» «Norma3» 'storage_optimized_l1' 'storage_optimized_l2' |
TrackedResourceTags
| Nome | Descrição | valor |
|---|
UserAssignedIdentity
| Nome | Descrição | valor |
|---|
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso searchServices pode ser implantado com operações direcionadas:
- Grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, veja registo de alterações.
Exemplos de uso
Amostras Terraform
Um exemplo básico de implantação do Serviço de Pesquisa.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "searchService" {
type = "Microsoft.Search/searchServices@2022-09-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
authOptions = {
apiKeyOnly = {
}
}
disableLocalAuth = false
encryptionWithCmk = {
enforcement = "Disabled"
}
hostingMode = "default"
networkRuleSet = {
ipRules = [
]
}
partitionCount = 1
publicNetworkAccess = "Enabled"
replicaCount = 1
}
sku = {
name = "standard"
}
tags = {
environment = "staging"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Módulos verificados do Azure
Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.
| Módulo | Descrição |
|---|---|
| Serviço de Pesquisa | Módulo de recursos AVM para serviço de pesquisa |
Formato do recurso
Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2026-03-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
apiKeyOnly = ?
}
computeType = "string"
dataExfiltrationProtections = [
"string"
]
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
serviceLevelEncryptionKey = {
accessCredentials = {
applicationId = "string"
applicationSecret = "string"
}
identity = {
@odata.type = "string"
// For remaining properties, see DataIdentity objects
}
keyVaultKeyName = "string"
keyVaultKeyVersion = "string"
keyVaultUri = "string"
}
}
endpoint = "string"
hostingMode = "string"
knowledgeRetrieval = "string"
networkRuleSet = {
bypass = "string"
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
upgradeAvailable = "string"
}
sku = {
name = "string"
}
}
}
Objetos DataIdentity
Defina a propriedade
Para #Microsoft.Azure.Search.DataNoneIdentity, use:
{
@odata.type = "#Microsoft.Azure.Search.DataNoneIdentity"
}
Para #Microsoft.Azure.Search.DataUserAssignedIdentity, use:
{
@odata.type = "#Microsoft.Azure.Search.DataUserAssignedIdentity"
federatedIdentityClientId = "string"
userAssignedIdentity = "string"
}
Valores de propriedade
Microsoft.Search/searchServices
| Nome | Descrição | valor |
|---|---|---|
| identidade | A identidade do recurso. | Identidade |
| localização | A geolocalização onde o recurso vive | string (obrigatório) |
| Nome | O nome do recurso | string Restrições: Padrão = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (obrigatório) |
| propriedades | Propriedades do serviço de pesquisa. | SearchServiceProperties |
| 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 |
| etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de tags. |
| tipo | O tipo de recurso | "Microsoft.Search/searchServices@2026-03-01-preview" |
AzureActiveDirectoryApplicationCredentials
| Nome | Descrição | valor |
|---|---|---|
| applicationId | O ID da aplicação (cliente) de um registo de aplicação no tenant. | cadeia (de caracteres) |
| applicationSecret | Um segredo de cliente AAD gerado para o Registo de Aplicações usado para autenticação com o Azure Key Vault. | string Restrições: Valor sensível. Passe como um parâmetro seguro. |
Identidade de dados
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Defina como '#Microsoft.Azure.Search.DataNoneIdentity' para o tipo DataNoneIdentity. Defina como '#Microsoft.Azure.Search.DataUserAssignedIdentity' para o tipo DataUserAssignedIdentity. | '#Microsoft.Azure.Search.DataNoneIdentity' '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obrigatório) |
DataNoneIdentity
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Um fragmento de URI especificando o tipo de identidade. | '#Microsoft.Azure.Search.DataNoneIdentity' (obrigatório) |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrição | valor |
|---|---|---|
| aadAuthFailureMode | Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação. | 'http401WithBearerChallenge' 'http403' |
DataPlaneAuthOptions
| Nome | Descrição | valor |
|---|---|---|
| aadOrApiKey | Indica que a chave de API ou um token de acesso de um locatário do Microsoft Entra ID pode ser usado para autenticação. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica que apenas a chave da API pode ser usada para autenticação. | any |
DataUserAssignedIdentity
| Nome | Descrição | valor |
|---|---|---|
| @odata.type | Um fragmento de URI especificando o tipo de identidade. | '#Microsoft.Azure.Search.DataUserAssignedIdentity' (obrigatório) |
| federatedIdentityClientId | Opcional para Suporte a CMK Multi-tenant User-Assigned Managed Identity: O id do cliente (como UUID) do Registo de Aplicações multi-tenant que foi configurado para federar com o userAssignedIdentity. | cadeia (de caracteres) |
| userAssignedIdentity | A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa. | string (obrigatório) |
EncryptionWithCmk
| Nome | Descrição | valor |
|---|---|---|
| imposição | Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente. | 'Desativado' 'Habilitado' 'Não especificado' |
| serviceLevelEncryptionKey | Descreve a configuração da chave gerida pelo cliente para encriptar o serviço de pesquisa. | SearchResourceEncryptionKey |
Identidade
IdentityUserAssignedIdentities
| Nome | Descrição | valor |
|---|
IpRule
| Nome | Descrição | valor |
|---|---|---|
| value | Valor correspondente a um único endereço IPv4 (por exemplo, 123.1.2.3) ou um intervalo de IP em formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido. | cadeia (de caracteres) |
NetworkRuleSet
| Nome | Descrição | valor |
|---|---|---|
| Desvio | Possíveis origens do tráfego de entrada que pode ignorar as regras definidas na seção 'ipRules'. | 'AzurePortal' 'AzureServices' 'Nenhuma' |
| ipRules | Uma lista de regras de restrição de IP que define a(s) rede(s) de entrada com permissão de acesso ao ponto de extremidade do serviço de pesquisa. Enquanto isso, todas as outras redes IP públicas são bloqueadas pelo firewall. Estas regras de restrição são aplicadas apenas quando o «acesso públicoà rede» do serviço de pesquisa está «ativado»; caso contrário, o tráfego na interface pública não é permitido, mesmo com quaisquer regras de IP públicas, e as conexões de ponto final privadas seriam o método de acesso exclusivo. | IpRule[] |
SearchResourceEncryptionKey
| Nome | Descrição | valor |
|---|---|---|
| accessCredenciais | Credenciais opcionais do Azure Ative Directory usadas para acessar seu Cofre da Chave do Azure. Não é necessário se estiver usando a identidade gerenciada. | AzureActiveDirectoryApplicationCredentials |
| identidade | Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo. | Identidade de dados |
| keyVaultKeyName | O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso. | cadeia (de caracteres) |
| keyVaultKeyVersion | A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso. | cadeia (de caracteres) |
| keyVaultUri | O URI do seu Cofre da Chave do Azure, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser https://my-keyvault-name.vault.azure.net. |
cadeia (de caracteres) |
SearchServiceProperties
| Nome | Descrição | valor |
|---|---|---|
| authOpções | 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. | 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. | 'Confidencial' 'Default' |
| 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. | Matriz de cadeia de caracteres contendo qualquer uma das: 'BlockAll' |
| 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. | bool |
| criptografiaWithCmk | Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa. | EncryptionWithCmk |
| ponto final | O ponto de extremidade do serviço Pesquisa de IA do Azure. | cadeia (de caracteres) |
| 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 padrão3, o valor é 'Default' ou 'HighDensity'. Para todos os outros SKUs, esse valor deve ser 'Default'. | 'Default' 'Alta densidade' |
| conhecimentoRecuperação | Especifica o plano de faturação para recuperação agential no serviço Pesquisa de IA do Azure. Esta configuração está disponível apenas para certos escalões de preços em determinadas regiões. | 'grátis' 'standard' |
| networkRuleSet | Regras específicas de rede que determinam como o serviço Pesquisa de IA do Azure pode ser alcançado. | NetworkRuleSet |
| númeroDePartições | O número de partições no serviço de pesquisa dedicado; 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. | int Restrições: Valor mínimo = 1 Valor máximo = 12 |
| acesso à rede pública | 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. | 'Desativado' 'Habilitado' 'SecuredByPerimeter' |
| replicaCount | O número de réplicas no serviço de pesquisa dedicado. 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. | int Restrições: Valor mínimo = 1 Valor máximo = 12 |
| pesquisa semântica | Especifica a disponibilidade e o plano de faturação para pesquisa semântica no serviço Pesquisa de IA do Azure. Esta configuração está disponível apenas para certos escalões de preços em determinadas regiões. | 'deficientes' 'grátis' 'standard' |
| upgradeDisponível | Indica se o serviço de pesquisa tem uma atualização disponível. | 'disponível' 'não disponível' |
Sku
| Nome | Descrição | valor |
|---|---|---|
| Nome | O SKU do serviço de pesquisa. Os valores válidos incluem: 'grátis': Serviço compartilhado. 'básico': Serviço dedicado com até 3 réplicas. 'standard': Serviço dedicado com até 12 partições e 12 réplicas. 'standard2': Semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': A maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': Suporta 1TB por partição, até 12 partições. 'storage_optimized_l2': Suporta 2TB por partição, até 12 partições. 'serverless': Nível serverless com capacidades de auto-escalabilidade. | 'basic' 'grátis' 'Sem servidor' 'standard' «Norma2» «Norma3» 'storage_optimized_l1' 'storage_optimized_l2' |
TrackedResourceTags
| Nome | Descrição | valor |
|---|
UserAssignedIdentity
| Nome | Descrição | valor |
|---|