Microsoft.Search searchServices
Definição de recurso do Bicep
O tipo de recurso searchServices pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Search/searchServices, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
}
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any()
}
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
}
Valores de propriedade
searchServices
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde o recurso se encontra | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | O SKU do serviço de pesquisa, que determina a taxa de faturação e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa. | SKU |
| identidade | A identidade do recurso. | Identidade |
| propriedades | Propriedades do serviço de pesquisa. | SearchServiceProperties |
Identidade
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade. | "Nenhum" "SystemAssigned" (obrigatório) |
SearchServiceProperties
| Nome | Descrição | Valor |
|---|---|---|
| authOptions | Define as opções de como a API do plano de dados de um serviço de pesquisa autentica pedidos. Isto não pode ser definido se "disableLocalAuth" estiver definido como verdadeiro. | DataPlaneAuthOptions |
| disableLocalAuth | Quando definido como verdadeiro, as chamadas para o serviço de pesquisa não serão autorizadas a utilizar chaves de API para autenticação. Isto não pode ser definido como verdadeiro se "dataPlaneAuthOptions" estiver definido. | bool |
| encryptionWithCmk | Especifica qualquer política relativa à encriptação de recursos (como índices) através de chaves do gestor de clientes num serviço de pesquisa. | EncryptionWithCmk |
| hostingMode | Aplicável apenas para o SKU standard3. Pode definir esta propriedade para ativar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito superior aos índices máximos permitidos para qualquer outro SKU. Para o SKU standard3, o valor é "predefinido" ou "highDensity". Para todos os outros SKUs, este valor tem de ser "predefinido". | "predefinição" "highDensity" |
| networkRuleSet | Regras específicas da rede que determinam a forma 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. Os valores superiores a 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 | Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos recursos e modelos de clientes existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo. | "desativado" "ativado" |
| replicaCount | O número de réplicas no serviço de pesquisa. Se especificado, tem de ser um valor entre 1 e 12 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 determinadas localizações. | "desativado" 'gratuito' "standard" |
DataPlaneAuthOptions
| Nome | Descrição | Valor |
|---|---|---|
| aadOrApiKey | Indica que a chave de API ou um token de acesso de um inquilino Microsoft Entra ID podem ser utilizados para autenticação. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica que apenas a chave de API pode ser utilizada para autenticação. | Para o Bicep, pode utilizar a função any( ). |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrição | Valor |
|---|---|---|
| aadAuthFailureMode | Descreve a resposta que a API do plano de dados de um serviço de pesquisa enviaria para pedidos que falharam na autenticação. | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| Nome | Descrição | Valor |
|---|---|---|
| imposição | Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não encriptados pelo cliente. | "Desativado" "Ativado" "Não especificado" |
NetworkRuleSet
| Nome | Descrição | Valor |
|---|---|---|
| ipRules | Uma lista das regras de restrição de IP utilizadas para uma firewall de IP. Quaisquer IPs que não correspondam às regras são bloqueados pela firewall. Estas regras só são aplicadas quando a "publicNetworkAccess" do serviço de pesquisa está "ativada". | IpRule[] |
IpRule
| Nome | 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 |
Sku
| Nome | Descrição | Valor |
|---|---|---|
| name | O SKU do serviço de pesquisa. Os valores válidos incluem: "gratuito": Serviço partilhado. "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 também definir a propriedade hostingMode como "highDensity"). "storage_optimized_l1": suporta 1 TB por partição, até 12 partições. "storage_optimized_l2": suporta 2 TB por partição, até 12 partições." | "básico" 'gratuito' "standard" "standard2" "standard3" 'storage_optimized_l1' 'storage_optimized_l2' |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Aplicação Web com um Base de Dados SQL, Azure Cosmos DB, Azure Search |
Este modelo aprovisiona uma Aplicação Web, uma Base de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights. |
| serviço Azure Cognitive Search |
Este modelo cria um serviço de Azure Cognitive Search |
| Azure Cognitive Search serviço com ponto final privado |
Este modelo cria um serviço Azure Cognitive Search com um ponto final privado. |
Definição de recurso de modelo do ARM
O tipo de recurso searchServices pode ser implementado com operações que visam:
- Grupos de recursos – veja comandos de implementação de grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "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"
}
}
Valores de propriedade
searchServices
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Search/searchServices" |
| apiVersion | A versão da API de recursos | '2023-11-01' |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde reside o recurso | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| sku | O SKU do serviço de pesquisa, que determina a taxa de faturação e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa. | SKU |
| identidade | A identidade do recurso. | Identidade |
| propriedades | Propriedades do serviço de pesquisa. | SearchServiceProperties |
Identidade
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade. | "Nenhum" "SystemAssigned" (obrigatório) |
SearchServiceProperties
| Nome | Descrição | Valor |
|---|---|---|
| authOptions | Define as opções para a forma como a API do plano de dados de um serviço de pesquisa autentica os pedidos. Isto não pode ser definido se "disableLocalAuth" estiver definido como verdadeiro. | DataPlaneAuthOptions |
| disableLocalAuth | Quando definido como verdadeiro, as chamadas para o serviço de pesquisa não serão autorizadas a utilizar chaves de API para autenticação. Isto não pode ser definido como verdadeiro se "dataPlaneAuthOptions" estiver definido. | bool |
| encryptionWithCmk | Especifica qualquer política relativa à encriptação de recursos (como índices) através de chaves do gestor de clientes num serviço de pesquisa. | EncryptionWithCmk |
| hostingMode | Aplicável apenas para o SKU standard3. Pode definir esta propriedade para ativar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito superior aos índices máximos permitidos para qualquer outro SKU. Para o SKU standard3, o valor é "predefinido" ou "highDensity". Para todos os outros SKUs, este valor tem de ser "predefinido". | "predefinição" 'highDensity' |
| networkRuleSet | Regras específicas da rede que determinam a forma 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. Os valores superiores a 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 | Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos modelos e recursos de cliente existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo. | "desativado" "ativado" |
| replicaCount | O número de réplicas no serviço de pesquisa. Se especificado, tem de 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 determinadas localizações. | "desativado" 'gratuito' "standard" |
DataPlaneAuthOptions
| Nome | Descrição | Valor |
|---|---|---|
| aadOrApiKey | Indica que a chave de API ou um token de acesso de um inquilino Microsoft Entra ID pode ser utilizado para autenticação. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica que apenas a chave de API pode ser utilizada para autenticação. |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrição | Valor |
|---|---|---|
| aadAuthFailureMode | Descreve a resposta que a API do plano de dados de um serviço de pesquisa enviaria para pedidos que falharam na autenticação. | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| Nome | Descrição | Valor |
|---|---|---|
| imposição | Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não encriptados pelo cliente. | "Desativado" "Ativado" "Não especificado" |
NetworkRuleSet
| Nome | Descrição | Valor |
|---|---|---|
| ipRules | Uma lista das regras de restrição de IP utilizadas para uma firewall de IP. Quaisquer IPs que não correspondam às regras são bloqueados pela firewall. Estas regras só são aplicadas quando a "publicNetworkAccess" do serviço de pesquisa está "ativada". | IpRule[] |
IpRule
| Nome | 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 |
Sku
| Nome | Descrição | Valor |
|---|---|---|
| name | O SKU do serviço de pesquisa. Os valores válidos incluem: "gratuito": Serviço partilhado. "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 também definir a propriedade hostingMode como "highDensity"). "storage_optimized_l1": suporta 1 TB por partição, até 12 partições. "storage_optimized_l2": suporta 2 TB por partição, até 12 partições." | "básico" 'gratuito' "standard" "standard2" "standard3" 'storage_optimized_l1' 'storage_optimized_l2' |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Aplicação Web com um Base de Dados SQL, Azure Cosmos DB, Azure Search |
Este modelo aprovisiona uma Aplicação Web, uma Base de Dados SQL, o Azure Cosmos DB, o Azure Search e o Application Insights. |
| serviço Azure Cognitive Search |
Este modelo cria um serviço de Azure Cognitive Search |
| Azure Cognitive Search serviço com ponto final privado |
Este modelo cria um serviço Azure Cognitive Search com um ponto final privado. |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso searchServices pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
}
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
Valores de propriedade
searchServices
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Search/searchServices@2023-11-01" |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde o recurso se encontra | cadeia (obrigatório) |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. |
| sku | O SKU do serviço de pesquisa, que determina a taxa de faturação e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa. | SKU |
| identidade | A identidade do recurso. | Identidade |
| propriedades | Propriedades do serviço de pesquisa. | SearchServiceProperties |
Identidade
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade. | "SystemAssigned" (obrigatório) |
SearchServiceProperties
| Nome | Descrição | Valor |
|---|---|---|
| authOptions | Define as opções de como a API do plano de dados de um serviço de pesquisa autentica pedidos. Isto não pode ser definido se "disableLocalAuth" estiver definido como verdadeiro. | DataPlaneAuthOptions |
| disableLocalAuth | Quando definido como verdadeiro, as chamadas para o serviço de pesquisa não serão autorizadas a utilizar chaves de API para autenticação. Isto não pode ser definido como verdadeiro se "dataPlaneAuthOptions" estiver definido. | bool |
| encryptionWithCmk | Especifica qualquer política relativa à encriptação de recursos (como índices) através de chaves do gestor de clientes num serviço de pesquisa. | EncryptionWithCmk |
| hostingMode | Aplicável apenas para o SKU standard3. Pode definir esta propriedade para ativar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito superior aos índices máximos permitidos para qualquer outro SKU. Para o SKU standard3, o valor é "predefinido" ou "highDensity". Para todos os outros SKUs, este valor tem de ser "predefinido". | "predefinição" "highDensity" |
| networkRuleSet | Regras específicas da rede que determinam a forma 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. Os valores superiores a 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 | Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos recursos e modelos de clientes existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo. | "desativado" "ativado" |
| replicaCount | O número de réplicas no serviço de pesquisa. Se especificado, tem de ser um valor entre 1 e 12 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 determinadas localizações. | "desativado" "gratuito" "standard" |
DataPlaneAuthOptions
| Nome | Descrição | Valor |
|---|---|---|
| aadOrApiKey | Indica que a chave de API ou um token de acesso de um inquilino Microsoft Entra ID podem ser utilizados para autenticação. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica que apenas a chave de API pode ser utilizada para autenticação. |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrição | Valor |
|---|---|---|
| aadAuthFailureMode | Descreve a resposta que a API do plano de dados de um serviço de pesquisa enviaria para pedidos que falharam na autenticação. | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| Nome | Descrição | Valor |
|---|---|---|
| imposição | Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não encriptados pelo cliente. | "Desativado" "Ativado" "Não especificado" |
NetworkRuleSet
| Nome | Descrição | Valor |
|---|---|---|
| ipRules | Uma lista das regras de restrição de IP utilizadas para uma firewall de IP. Quaisquer IPs que não correspondam às regras são bloqueados pela firewall. Estas regras só são aplicadas quando a "publicNetworkAccess" do serviço de pesquisa está "ativada". | IpRule[] |
IpRule
| Nome | 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 |
Sku
| Nome | Descrição | Valor |
|---|---|---|
| name | O SKU do serviço de pesquisa. Os valores válidos incluem: "gratuito": Serviço partilhado. "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 também definir a propriedade hostingMode como "highDensity"). "storage_optimized_l1": suporta 1 TB por partição, até 12 partições. "storage_optimized_l2": suporta 2 TB por partição, até 12 partições." | "básico" "gratuito" "standard" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2" |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários