Serviços de pesquisa Microsoft.Search 2020-03-13

Definição de recursos do bíceps

O tipo de recurso searchServices pode ser implantado com operações direcionadas:

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.

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@2020-03-13' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.Search/searchServices

Designação Descrição Valor
identidade A identidade do recurso. Identidade
localização A localização geográfica do recurso. Esta tem de ser uma das Regiões Geográficas do Azure suportadas e registadas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo recurso. cadeia (de caracteres)
Designação O nome do recurso string (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. Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

Identidade

Designação Descrição Valor
tipo O tipo de identidade. 'Nenhuma'
'SystemAssigned' (obrigatório)

IpRule

Designação Descrição Valor
valor 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

Designação Descrição Valor
ipRegras 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[]

Tags de Recursos

Designação Descrição Valor

SearchServiceProperties

Designação Descrição Valor
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 standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'. 'Padrão'
'Alta densidade'
networkRuleSet Regras específicas de rede que determinam como o serviço de Pesquisa Cognitiva do Azure pode ser alcançado. NetworkRuleSet
númeroDePartições 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. 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. 'deficientes'
'habilitado'
replicaCount O número de réplicas no serviço de Pesquisa. 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

Referência

Designação Descrição Valor
Designação 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.' 'básico'
'grátis'
'Padrão'
«Norma2»
«Norma3»
'storage_optimized_l1'
'storage_optimized_l2'

Definição de recurso de modelo ARM

O tipo de recurso searchServices pode ser implantado com operações direcionadas:

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

Implantar no Azure
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

Implantar no 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

Implantar no Azure
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

Implantar no Azure
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

Implantar no Azure
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

Implantar no Azure
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": "2020-03-13",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.Search/searchServices

Designação Descrição Valor
Versão da API A versão api '2020-03-13'
identidade A identidade do recurso. Identidade
localização A localização geográfica do recurso. Esta tem de ser uma das Regiões Geográficas do Azure suportadas e registadas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo recurso. cadeia (de caracteres)
Designação O nome do recurso string (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. Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Search/searchServices'

Identidade

Designação Descrição Valor
tipo O tipo de identidade. 'Nenhuma'
'SystemAssigned' (obrigatório)

IpRule

Designação Descrição Valor
valor 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

Designação Descrição Valor
ipRegras 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[]

Tags de Recursos

Designação Descrição Valor

SearchServiceProperties

Designação Descrição Valor
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 standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'. 'Padrão'
'Alta densidade'
networkRuleSet Regras específicas de rede que determinam como o serviço de Pesquisa Cognitiva do Azure pode ser alcançado. NetworkRuleSet
númeroDePartições 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. 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. 'deficientes'
'habilitado'
replicaCount O número de réplicas no serviço de Pesquisa. 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

Referência

Designação Descrição Valor
Designação 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.' 'básico'
'grátis'
'Padrão'
«Norma2»
«Norma3»
'storage_optimized_l1'
'storage_optimized_l2'

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@2020-03-13"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
    }
    sku = {
      name = "string"
    }
  }
}

Valores de propriedade

Microsoft.Search/searchServices

Designação Descrição Valor
identidade A identidade do recurso. Identidade
localização A localização geográfica do recurso. Esta tem de ser uma das Regiões Geográficas do Azure suportadas e registadas (por exemplo, Oeste dos EUA, Leste dos EUA, Sudeste Asiático e assim por diante). Essa propriedade é necessária ao criar um novo recurso. cadeia (de caracteres)
Designação O nome do recurso string (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. Referência
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Search/searchServices@2020-03-13"

Identidade

Designação Descrição Valor
tipo O tipo de identidade. 'Nenhuma'
'SystemAssigned' (obrigatório)

IpRule

Designação Descrição Valor
valor 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

Designação Descrição Valor
ipRegras 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[]

Tags de Recursos

Designação Descrição Valor

SearchServiceProperties

Designação Descrição Valor
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 standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'padrão'. 'Padrão'
'Alta densidade'
networkRuleSet Regras específicas de rede que determinam como o serviço de Pesquisa Cognitiva do Azure pode ser alcançado. NetworkRuleSet
númeroDePartições 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. 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. 'deficientes'
'habilitado'
replicaCount O número de réplicas no serviço de Pesquisa. 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

Referência

Designação Descrição Valor
Designação 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.' 'básico'
'grátis'
'Padrão'
«Norma2»
«Norma3»
'storage_optimized_l1'
'storage_optimized_l2'