Serviços de pesquisa Microsoft.Search 2023-11-01
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.
Formato do recurso
Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte Bíceps ao seu modelo.
resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any(Azure.Bicep.Types.Concrete.AnyType)
}
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
DataPlaneAadOrApiKeyAuthOption
Designação | 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
Designação | 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. | qualquer |
EncryptionWithCmk
Designação | Descrição | Valor |
---|---|---|
execução | Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não criptografados pelo cliente. | 'Desativado' 'Habilitado' 'Não especificado' |
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 no formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido. | string |
Microsoft.Search/searchServices
Designação | Descrição | Valor |
---|---|---|
identidade | A identidade do recurso. | Identidade |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
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 taxa de faturamento e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa. | Sku |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
NetworkRuleSet
Designação | Descrição | Valor |
---|---|---|
ipRegras | Uma lista de regras de restrição de IP usadas para um firewall IP. Todos os IPs que não corresponderem às regras são bloqueados pelo firewall. Estas regras só são aplicadas quando o «publicNetworkAccess» do serviço de pesquisa está «ativado». | IpRule[] |
SearchServiceProperties
Designação | 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 |
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 |
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 da rede que determinam como o serviço de pesquisa pode ser alcançado. | NetworkRuleSet |
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. | Int Restrições: Valor mínimo = 1 Valor máximo = 12 |
publicNetworkAccess | 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 |
pesquisa semântica | Define opções que controlam a disponibilidade da pesquisa semântica. Esta configuração só é possível para determinados SKUs de pesquisa em determinados locais. | 'deficientes' 'grátis' 'Padrão' |
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' |
TrackedResourceTags
Designação | Descrição | Valor |
---|
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Arquivo Bicep | Descrição |
---|---|
Rede Restrita do Azure AI Studio | Este conjunto de modelos demonstra como configurar o Azure AI Studio 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 |
Definição de recurso de modelo ARM
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.
Formato do recurso
Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2023-11-01",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string"
},
"hostingMode": "string",
"networkRuleSet": {
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
DataPlaneAadOrApiKeyAuthOption
Designação | 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
Designação | 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. | qualquer |
EncryptionWithCmk
Designação | Descrição | Valor |
---|---|---|
execução | Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não criptografados pelo cliente. | 'Desativado' 'Habilitado' 'Não especificado' |
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 no formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido. | string |
Microsoft.Search/searchServices
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2023-11-01' |
identidade | A identidade do recurso. | Identidade |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
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 taxa de faturamento e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa. | Sku |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
tipo | O tipo de recurso | 'Microsoft.Search/searchServices' |
NetworkRuleSet
Designação | Descrição | Valor |
---|---|---|
ipRegras | Uma lista de regras de restrição de IP usadas para um firewall IP. Todos os IPs que não corresponderem às regras são bloqueados pelo firewall. Estas regras só são aplicadas quando o «publicNetworkAccess» do serviço de pesquisa está «ativado». | IpRule[] |
SearchServiceProperties
Designação | 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 |
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 |
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 da rede que determinam como o serviço de pesquisa pode ser alcançado. | NetworkRuleSet |
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. | Int Restrições: Valor mínimo = 1 Valor máximo = 12 |
publicNetworkAccess | 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 |
pesquisa semântica | Define opções que controlam a disponibilidade da pesquisa semântica. Esta configuração só é possível para determinados SKUs de pesquisa em determinados locais. | 'deficientes' 'grátis' 'Padrão' |
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' |
TrackedResourceTags
Designação | Descrição | Valor |
---|
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Rede Restrita do Azure AI Studio |
Este conjunto de modelos demonstra como configurar o Azure AI Studio 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. |
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. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso searchServices pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
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@2023-11-01"
name = "string"
identity = {
type = "string"
}
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
apiKeyOnly = ?
}
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
})
}
Valores de propriedade
DataPlaneAadOrApiKeyAuthOption
Designação | 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
Designação | 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. | qualquer |
EncryptionWithCmk
Designação | Descrição | Valor |
---|---|---|
execução | Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não criptografados pelo cliente. | 'Desativado' 'Habilitado' 'Não especificado' |
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 no formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido. | string |
Microsoft.Search/searchServices
Designação | Descrição | Valor |
---|---|---|
identidade | A identidade do recurso. | Identidade |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
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 taxa de faturamento e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa. | Sku |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. |
tipo | O tipo de recurso | "Microsoft.Search/searchServices@2023-11-01" |
NetworkRuleSet
Designação | Descrição | Valor |
---|---|---|
ipRegras | Uma lista de regras de restrição de IP usadas para um firewall IP. Todos os IPs que não corresponderem às regras são bloqueados pelo firewall. Estas regras só são aplicadas quando o «publicNetworkAccess» do serviço de pesquisa está «ativado». | IpRule[] |
SearchServiceProperties
Designação | 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 |
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 |
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 da rede que determinam como o serviço de pesquisa pode ser alcançado. | NetworkRuleSet |
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. | Int Restrições: Valor mínimo = 1 Valor máximo = 12 |
publicNetworkAccess | 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 |
pesquisa semântica | Define opções que controlam a disponibilidade da pesquisa semântica. Esta configuração só é possível para determinados SKUs de pesquisa em determinados locais. | 'deficientes' 'grátis' 'Padrão' |
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' |
TrackedResourceTags
Designação | Descrição | Valor |
---|