Partilhar via


Microsoft.Insights diagnosticSettings

Comentários

Para obter orientações sobre como implantar soluções de monitoramento, consulte Criar recursos de monitoramento usando o Bicep.

Definição de recursos do bíceps

O tipo de recurso diagnosticSettings pode ser implantado com operações que visam:

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.Insights/diagnosticSettings, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Insights/diagnosticSettings@2021-05-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    eventHubAuthorizationRuleId: 'string'
    eventHubName: 'string'
    logAnalyticsDestinationType: 'string'
    logs: [
      {
        category: 'string'
        categoryGroup: 'string'
        enabled: bool
        retentionPolicy: {
          days: int
          enabled: bool
        }
      }
    ]
    marketplacePartnerId: 'string'
    metrics: [
      {
        category: 'string'
        enabled: bool
        retentionPolicy: {
          days: int
          enabled: bool
        }
        timeGrain: 'string'
      }
    ]
    serviceBusRuleId: 'string'
    storageAccountId: 'string'
    workspaceId: 'string'
  }
}

Valores de propriedade

Configurações de diagnóstico

Designação Descrição Valor
eventHubAuthorizationRuleId A ID do recurso para a regra de autorização do hub de eventos. string
eventHubName O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado. string
logAnalyticsDestinationType Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics, ou usar um tipo de destino construído da seguinte maneira: <identidade de serviço normalizada>_<nome de categoria normalizado>. Os valores possíveis são: Dedicado e nulo (null é padrão.) string
registos A lista de configurações de logs. LogSettings[]
marketplacePartnerId O ID de recurso ARM completo do recurso do Marketplace para o qual você gostaria de enviar Logs de diagnóstico. string
métricas A lista de configurações métricas. MetricSettings[]
serviceBusRuleId A ID da regra do barramento de serviço da configuração de diagnóstico. Isso está aqui para manter a compatibilidade com versões anteriores. string
storageAccountId O ID do recurso da conta de armazenamento para a qual você deseja enviar Logs de Diagnóstico. string
workspaceId O ID de recurso ARM completo do espaço de trabalho do Log Analytics para o qual você deseja enviar Logs de diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 string

Configurações de log

Designação Descrição Valor
categoria Nome de uma categoria de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
categoryGrupo Nome de um grupo de categorias de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
ativado Um valor que indica se esse log está habilitado. bool (obrigatório)
retençãoPolítica A política de retenção para este log. RetentionPolicy

MetricSettings

Designação Descrição Valor
categoria Nome de uma categoria de Métrica de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de métricas de diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
ativado Um valor que indica se essa categoria está habilitada. bool (obrigatório)
retençãoPolítica A política de retenção para esta categoria. RetentionPolicy
timeGrain o timegrain da métrica em ISO8601 formato. string

Microsoft.Insights/diagnosticSettings

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
propriedades Propriedades de um recurso de configurações de diagnóstico. DiagnosticSettings
Âmbito de aplicação Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

Política de retenção

Designação Descrição Valor
Dias o número de dias para a retenção em dias. Um valor de 0 reterá os eventos indefinidamente. Int

Restrições:
Valor mínimo = 0 (obrigatório)
ativado Um valor que indica se a política de retenção está habilitada. bool (obrigatório)

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Cluster AKS com um gateway NAT e um gateway de aplicativo Este exemplo mostra como implantar um cluster AKS com o NAT Gateway para conexões de saída e um Application Gateway para conexões de entrada.
cluster AKS com o Application Gateway Ingress Controller Este exemplo mostra como implantar um cluster AKS com o Application Gateway, o Application Gateway Ingress Controller, o Azure Container Registry, o Log Analytics e o Key Vault
Application Gateway com gerenciamento interno de API e de aplicativos Web Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure.
Application Gateway com WAF e de política de firewall Este modelo cria um Gateway de Aplicativo com WAF configurado junto com uma política de firewall
Registro de Contêiner do Azure com Políticas e de Diagnóstico Azure Container Registry with Policies and Diagnostics (bíceps)
Azure Data Factory com Git e de configuração vnet gerenciada Este modelo cria o Azure Data Factory com configuração Git e rede virtual gerenciada.
Máquina Virtual do Desenvolvedor de Jogos do Azure A Máquina Virtual do Desenvolvedor de Jogos do Azure inclui Mecanismos Licenciados como o Unreal.
SQL Server do Azure com Auditoria gravada no Log Analytics Este modelo permite implantar um servidor SQL do Azure com a Auditoria habilitada para gravar logs de auditoria no Log Analytics (espaço de trabalho do OMS)
Criar um Cache Redis Premium com clustering Este modelo mostra como configurar o clustering em uma instância premium do Cache Redis do Azure.
Criar um Cache Redis usando um modelo Este modelo cria um Cache Redis do Azure com dados de diagnóstico mantidos em uma conta de armazenamento.
Criar gerenciamento de API em rede virtual interna com do App Gateway Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.
Criar Cofre de Chaves com o registo ativado Este modelo cria um Cofre da Chave do Azure e uma conta de Armazenamento do Azure que é usada para registro. Opcionalmente, cria bloqueios de recursos para proteger o Cofre da Chave e os recursos de armazenamento.
Criar cache Redis Premium com persistência de dados Este modelo mostra como configurar a persistência em uma instância premium do Cache Redis do Azure.
criar o Recovery Services Vault e habilitar o diagnóstico Este modelo cria um Cofre dos Serviços de Recuperação e habilita o diagnóstico para o Backup do Azure. Isso também implanta a conta de armazenamento e o espaço de trabalho do oms.
Criar o Recovery Services Vault com políticas de backup Este modelo cria um Cofre dos Serviços de Recuperação com políticas de backup e configura recursos opcionais, como identidade do sistema, tipo de armazenamento de backup, restauração entre regiões e logs de diagnóstico e um bloqueio de exclusão.
Implantar um aplicativo de microsserviço simples do Azure Spring Apps Este modelo implanta um aplicativo de microsserviço simples do Azure Spring Apps para ser executado no Azure.
Implantar o Secure Azure AI Studio com uma rede virtual gerenciada Este modelo cria um ambiente seguro do Azure AI Studio com restrições robustas de segurança de rede e identidade.
Front Door Premium com WAF e conjuntos de regras gerenciados pela Microsoft Este modelo cria um Front Door Premium, incluindo um firewall de aplicativo Web com os conjuntos de regras padrão e de proteção de bot gerenciados pela Microsoft.
Porta da frente Standard/Premium com WAF e regras personalizadas Este modelo cria um Front Door Standard/Premium, incluindo um firewall de aplicativo da Web com uma regra personalizada.
CDN FrontDoor com WAF, domínios e logs para o EventHub Este modelo cria um novo perfil cdn do Azure FrontDoor. Crie WAF com regras personalizadas e gerenciadas, rotas cdn, origem e grupos com sua associação com WAF e rotas, configure domínios personalizados, crie hub de eventos e configurações de diagnóstico para enviar logs de acesso CDN usando hub de eventos.
espaço de trabalho do Log Analytics com soluções e fontes de dados Implanta um espaço de trabalho do Log Analytics com soluções e fontes de dados especificadas
espaço de trabalho do Log Analytics com VM Insights, Container Insights Implanta um espaço de trabalho do Log Analytics com VM Insights, soluções do Container Insights e diagnósticos.
Grupo de Segurança de Rede com logs de diagnóstico Este modelo cria um Grupo de Segurança de Rede com logs de diagnóstico e um bloqueio de recursos
Usar o Firewall do Azure como um proxy DNS em um de topologia do Hub & Spoke Este exemplo mostra como implantar uma topologia hub-spoke no Azure usando o Firewall do Azure. A rede virtual do hub atua como um ponto central de conectividade para muitas redes virtuais faladas que estão conectadas à rede virtual do hub por meio do emparelhamento de rede virtual.
Rede Virtual com logs de diagnóstico Este modelo cria uma Rede Virtual com logs de diagnóstico e permite que recursos opcionais sejam adicionados a cada sub-rede

Definição de recurso de modelo ARM

O tipo de recurso diagnosticSettings pode ser implantado com operações que visam:

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.Insights/diagnosticSettings, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Insights/diagnosticSettings",
  "apiVersion": "2021-05-01-preview",
  "name": "string",
  "properties": {
    "eventHubAuthorizationRuleId": "string",
    "eventHubName": "string",
    "logAnalyticsDestinationType": "string",
    "logs": [
      {
        "category": "string",
        "categoryGroup": "string",
        "enabled": "bool",
        "retentionPolicy": {
          "days": "int",
          "enabled": "bool"
        }
      }
    ],
    "marketplacePartnerId": "string",
    "metrics": [
      {
        "category": "string",
        "enabled": "bool",
        "retentionPolicy": {
          "days": "int",
          "enabled": "bool"
        },
        "timeGrain": "string"
      }
    ],
    "serviceBusRuleId": "string",
    "storageAccountId": "string",
    "workspaceId": "string"
  }
}

Valores de propriedade

Configurações de diagnóstico

Designação Descrição Valor
eventHubAuthorizationRuleId A ID do recurso para a regra de autorização do hub de eventos. string
eventHubName O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado. string
logAnalyticsDestinationType Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics, ou usar um tipo de destino construído da seguinte maneira: <identidade de serviço normalizada>_<nome de categoria normalizado>. Os valores possíveis são: Dedicado e nulo (null é padrão.) string
registos A lista de configurações de logs. LogSettings[]
marketplacePartnerId O ID de recurso ARM completo do recurso do Marketplace para o qual você gostaria de enviar Logs de diagnóstico. string
métricas A lista de configurações métricas. MetricSettings[]
serviceBusRuleId A ID da regra do barramento de serviço da configuração de diagnóstico. Isso está aqui para manter a compatibilidade com versões anteriores. string
storageAccountId O ID do recurso da conta de armazenamento para a qual você deseja enviar Logs de Diagnóstico. string
workspaceId O ID de recurso ARM completo do espaço de trabalho do Log Analytics para o qual você deseja enviar Logs de diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 string

Configurações de log

Designação Descrição Valor
categoria Nome de uma categoria de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
categoryGrupo Nome de um grupo de categorias de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
ativado Um valor que indica se esse log está habilitado. bool (obrigatório)
retençãoPolítica A política de retenção para este log. RetentionPolicy

MetricSettings

Designação Descrição Valor
categoria Nome de uma categoria de Métrica de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de métricas de diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
ativado Um valor que indica se essa categoria está habilitada. bool (obrigatório)
retençãoPolítica A política de retenção para esta categoria. RetentionPolicy
timeGrain o timegrain da métrica em ISO8601 formato. string

Microsoft.Insights/diagnosticSettings

Designação Descrição Valor
apiVersion A versão api '2021-05-01-pré-visualização'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades de um recurso de configurações de diagnóstico. DiagnosticSettings
tipo O tipo de recurso 'Microsoft.Insights/diagnosticSettings'

Política de retenção

Designação Descrição Valor
Dias o número de dias para a retenção em dias. Um valor de 0 reterá os eventos indefinidamente. Int

Restrições:
Valor mínimo = 0 (obrigatório)
ativado Um valor que indica se a política de retenção está habilitada. bool (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Cluster AKS com um gateway NAT e um gateway de aplicativo

Implantar no Azure
Este exemplo mostra como implantar um cluster AKS com o NAT Gateway para conexões de saída e um Application Gateway para conexões de entrada.
cluster AKS com o Application Gateway Ingress Controller

Implantar no Azure
Este exemplo mostra como implantar um cluster AKS com o Application Gateway, o Application Gateway Ingress Controller, o Azure Container Registry, o Log Analytics e o Key Vault
Application Gateway com gerenciamento interno de API e de aplicativos Web

Implantar no Azure
Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure.
Application Gateway com WAF e de política de firewall

Implantar no Azure
Este modelo cria um Gateway de Aplicativo com WAF configurado junto com uma política de firewall
Registro de Contêiner do Azure com Políticas e de Diagnóstico

Implantar no Azure
Azure Container Registry with Policies and Diagnostics (bíceps)
Azure Data Factory com Git e de configuração vnet gerenciada

Implantar no Azure
Este modelo cria o Azure Data Factory com configuração Git e rede virtual gerenciada.
Máquina Virtual do Desenvolvedor de Jogos do Azure

Implantar no Azure
A Máquina Virtual do Desenvolvedor de Jogos do Azure inclui Mecanismos Licenciados como o Unreal.
SQL Server do Azure com Auditoria gravada no Log Analytics

Implantar no Azure
Este modelo permite implantar um servidor SQL do Azure com a Auditoria habilitada para gravar logs de auditoria no Log Analytics (espaço de trabalho do OMS)
Criar um Cache Redis Premium com clustering

Implantar no Azure
Este modelo mostra como configurar o clustering em uma instância premium do Cache Redis do Azure.
Criar um Cache Redis usando um modelo

Implantar no Azure
Este modelo cria um Cache Redis do Azure com dados de diagnóstico mantidos em uma conta de armazenamento.
Criar gerenciamento de API em rede virtual interna com do App Gateway

Implantar no Azure
Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.
Criar Cofre de Chaves com o registo ativado

Implantar no Azure
Este modelo cria um Cofre da Chave do Azure e uma conta de Armazenamento do Azure que é usada para registro. Opcionalmente, cria bloqueios de recursos para proteger o Cofre da Chave e os recursos de armazenamento.
Criar cache Redis Premium com persistência de dados

Implantar no Azure
Este modelo mostra como configurar a persistência em uma instância premium do Cache Redis do Azure.
criar o Recovery Services Vault e habilitar o diagnóstico

Implantar no Azure
Este modelo cria um Cofre dos Serviços de Recuperação e habilita o diagnóstico para o Backup do Azure. Isso também implanta a conta de armazenamento e o espaço de trabalho do oms.
Criar o Recovery Services Vault com políticas de backup

Implantar no Azure
Este modelo cria um Cofre dos Serviços de Recuperação com políticas de backup e configura recursos opcionais, como identidade do sistema, tipo de armazenamento de backup, restauração entre regiões e logs de diagnóstico e um bloqueio de exclusão.
Criar SQL MI com envio configurado de logs e métricas

Implantar no Azure
Este modelo permite implantar o SQL MI e recursos adicionais usados para armazenar logs e métricas (espaço de trabalho de diagnóstico, conta de armazenamento, hub de eventos).
Implantar um aplicativo de microsserviço simples do Azure Spring Apps

Implantar no Azure
Este modelo implanta um aplicativo de microsserviço simples do Azure Spring Apps para ser executado no Azure.
Implantar o Secure Azure AI Studio com uma rede virtual gerenciada

Implantar no Azure
Este modelo cria um ambiente seguro do Azure AI Studio com restrições robustas de segurança de rede e identidade.
Front Door Premium com WAF e conjuntos de regras gerenciados pela Microsoft

Implantar no Azure
Este modelo cria um Front Door Premium, incluindo um firewall de aplicativo Web com os conjuntos de regras padrão e de proteção de bot gerenciados pela Microsoft.
Porta da frente Standard/Premium com WAF e regras personalizadas

Implantar no Azure
Este modelo cria um Front Door Standard/Premium, incluindo um firewall de aplicativo da Web com uma regra personalizada.
CDN FrontDoor com WAF, domínios e logs para o EventHub

Implantar no Azure
Este modelo cria um novo perfil cdn do Azure FrontDoor. Crie WAF com regras personalizadas e gerenciadas, rotas cdn, origem e grupos com sua associação com WAF e rotas, configure domínios personalizados, crie hub de eventos e configurações de diagnóstico para enviar logs de acesso CDN usando hub de eventos.
espaço de trabalho do Log Analytics com soluções e fontes de dados

Implantar no Azure
Implanta um espaço de trabalho do Log Analytics com soluções e fontes de dados especificadas
espaço de trabalho do Log Analytics com VM Insights, Container Insights

Implantar no Azure
Implanta um espaço de trabalho do Log Analytics com VM Insights, soluções do Container Insights e diagnósticos.
Grupo de Segurança de Rede com logs de diagnóstico

Implantar no Azure
Este modelo cria um Grupo de Segurança de Rede com logs de diagnóstico e um bloqueio de recursos
Usar o Firewall do Azure como um proxy DNS em um de topologia do Hub & Spoke

Implantar no Azure
Este exemplo mostra como implantar uma topologia hub-spoke no Azure usando o Firewall do Azure. A rede virtual do hub atua como um ponto central de conectividade para muitas redes virtuais faladas que estão conectadas à rede virtual do hub por meio do emparelhamento de rede virtual.
Rede Virtual com logs de diagnóstico

Implantar no Azure
Este modelo cria uma Rede Virtual com logs de diagnóstico e permite que recursos opcionais sejam adicionados a cada sub-rede

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso diagnosticSettings pode ser implantado com operações que visam:

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.Insights/diagnosticSettings, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/diagnosticSettings@2021-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      eventHubAuthorizationRuleId = "string"
      eventHubName = "string"
      logAnalyticsDestinationType = "string"
      logs = [
        {
          category = "string"
          categoryGroup = "string"
          enabled = bool
          retentionPolicy = {
            days = int
            enabled = bool
          }
        }
      ]
      marketplacePartnerId = "string"
      metrics = [
        {
          category = "string"
          enabled = bool
          retentionPolicy = {
            days = int
            enabled = bool
          }
          timeGrain = "string"
        }
      ]
      serviceBusRuleId = "string"
      storageAccountId = "string"
      workspaceId = "string"
    }
  })
}

Valores de propriedade

Configurações de diagnóstico

Designação Descrição Valor
eventHubAuthorizationRuleId A ID do recurso para a regra de autorização do hub de eventos. string
eventHubName O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado. string
logAnalyticsDestinationType Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics, ou usar um tipo de destino construído da seguinte maneira: <identidade de serviço normalizada>_<nome de categoria normalizado>. Os valores possíveis são: Dedicado e nulo (null é padrão.) string
registos A lista de configurações de logs. LogSettings[]
marketplacePartnerId O ID de recurso ARM completo do recurso do Marketplace para o qual você gostaria de enviar Logs de diagnóstico. string
métricas A lista de configurações métricas. MetricSettings[]
serviceBusRuleId A ID da regra do barramento de serviço da configuração de diagnóstico. Isso está aqui para manter a compatibilidade com versões anteriores. string
storageAccountId O ID do recurso da conta de armazenamento para a qual você deseja enviar Logs de Diagnóstico. string
workspaceId O ID de recurso ARM completo do espaço de trabalho do Log Analytics para o qual você deseja enviar Logs de diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 string

Configurações de log

Designação Descrição Valor
categoria Nome de uma categoria de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
categoryGrupo Nome de um grupo de categorias de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
ativado Um valor que indica se esse log está habilitado. bool (obrigatório)
retençãoPolítica A política de retenção para este log. RetentionPolicy

MetricSettings

Designação Descrição Valor
categoria Nome de uma categoria de Métrica de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de métricas de diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET. string
ativado Um valor que indica se essa categoria está habilitada. bool (obrigatório)
retençãoPolítica A política de retenção para esta categoria. RetentionPolicy
timeGrain o timegrain da métrica em ISO8601 formato. string

Microsoft.Insights/diagnosticSettings

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
propriedades Propriedades de um recurso de configurações de diagnóstico. DiagnosticSettings
tipo O tipo de recurso "Microsoft.Insights/diagnosticSettings@2021-05-01-pré-visualização"

Política de retenção

Designação Descrição Valor
Dias o número de dias para a retenção em dias. Um valor de 0 reterá os eventos indefinidamente. Int

Restrições:
Valor mínimo = 0 (obrigatório)
ativado Um valor que indica se a política de retenção está habilitada. bool (obrigatório)