Serviços de pesquisa Microsoft.Search

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 de bíceps

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.

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.

Formato do recurso

Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.Search/searchServices@2026-09-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(...)
    }
    autoGeneratedDomainNameLabelScope: 'string'
    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 @odata.type para especificar o tipo de objeto.

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

AzureActiveDirectoryApplicationCredentials

Identidade de dados

DataNoneIdentity

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

DataUserAssignedIdentity

EncryptionWithCmk

Identidade

IdentityUserAssignedIdentities

IpRule

NetworkRuleSet

SearchResourceEncryptionKey

SearchServiceProperties

Referência

TrackedResourceTags

IdentidadeAtribuídaPeloUtilizador

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.

Modelo	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.
Web App com um Banco de Dados SQL, Azure Cosmos DB, Azure Search	Este modelo provisiona um Aplicativo Web, um Banco de Dados SQL, o Azure Cosmos DB, o Azure Search e o 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-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "autoGeneratedDomainNameLabelScope": "string",
    "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 @odata.type para especificar o tipo de objeto.

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

AzureActiveDirectoryApplicationCredentials

Identidade de dados

DataNoneIdentity

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

DataUserAssignedIdentity

EncryptionWithCmk

Identidade

IdentityUserAssignedIdentities

IpRule

NetworkRuleSet

SearchResourceEncryptionKey

SearchServiceProperties

Referência

TrackedResourceTags

IdentidadeAtribuídaPeloUtilizador

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.

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-09-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 = ?
      }
      autoGeneratedDomainNameLabelScope = "string"
      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 @odata.type para especificar o tipo de objeto.

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

AzureActiveDirectoryApplicationCredentials

Identidade de dados

DataNoneIdentity

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

DataUserAssignedIdentity

EncryptionWithCmk

Identidade

IdentityUserAssignedIdentities

IpRule

NetworkRuleSet

SearchResourceEncryptionKey

SearchServiceProperties

Referência

TrackedResourceTags

IdentidadeAtribuídaPeloUtilizador