Microsoft.Insights diagnosticSettings 2017-05-01-preview

Article
12/20/2024

Remarques

Pour obtenir des conseils sur le déploiement de solutions de supervision, consultez Créer des ressources de supervision à l’aide de Bicep.

Définition de ressource Bicep

Le type de ressource diagnosticSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Insights/diagnosticSettings, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

DiagnosticSettings

Nom	Description	Valeur
eventHubAuthorizationRuleId	ID de ressource de la règle d’autorisation event Hub.	corde
eventHubName	Nom du hub d’événements. Si aucun n’est spécifié, le hub d’événements par défaut est sélectionné.	corde
logAnalyticsDestinationType	Chaîne indiquant si l’exportation vers Log Analytics doit utiliser le type de destination par défaut, c’est-à-dire AzureDiagnostics ou utiliser un type de destination construit comme suit : <identité de service normalisée>_<nom de catégorie normalisé>. Les valeurs possibles sont : Dédié et Null (null est par défaut.)	corde
Journaux	Liste des paramètres des journaux d’activité.	LogSettings[]
métrique	Liste des paramètres de métrique.	MetricSettings[]
serviceBusRuleId	ID de règle Service Bus du paramètre de diagnostic. Il s’agit ici de maintenir la compatibilité descendante.	corde
storageAccountId	ID de ressource du compte de stockage auquel vous souhaitez envoyer des journaux de diagnostic.	corde
workspaceId	ID de ressource ARM complet de l’espace de travail Log Analytics auquel vous souhaitez envoyer des journaux de diagnostic. Exemple : /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2	corde

LogSettings

Nom	Description	Valeur
catégorie	Nom d’une catégorie de journal de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de journaux de diagnostic pour une ressource, effectuez d’abord une opération de paramètres de diagnostic GET.	corde
Activé	valeur indiquant si ce journal est activé.	bool (obligatoire)
retentionPolicy	la stratégie de rétention pour ce journal.	RetentionPolicy

MetricSettings

Nom	Description	Valeur
catégorie	Nom d’une catégorie Métrique de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de métriques de diagnostic pour une ressource, effectuez d’abord une opération de paramètres de diagnostic GET.	corde
Activé	valeur indiquant si cette catégorie est activée.	bool (obligatoire)
retentionPolicy	la stratégie de rétention pour cette catégorie.	RetentionPolicy
timeGrain	l’intervalle de temps de la métrique au format ISO8601.	corde

Microsoft.Insights/diagnosticSettings

Nom	Description	Valeur
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés d’une ressource de paramètres de diagnostic.	DiagnosticSettings
portée	Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement.	Définissez cette propriété sur le nom symbolique d’une ressource pour appliquer la ressource d’extension .

RetentionPolicy

Nom	Description	Valeur
Jours	nombre de jours pour la rétention en jours. La valeur 0 conserve indéfiniment les événements.	Int Contraintes: Valeur minimale = 0 (obligatoire)
Activé	valeur indiquant si la stratégie de rétention est activée.	bool (obligatoire)

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
cluster AKS avec une passerelle NAT et un Application Gateway	Cet exemple montre comment déployer un cluster AKS avec NAT Gateway pour les connexions sortantes et une passerelle Application Gateway pour les connexions entrantes.
cluster AKS avec le contrôleur d’entrée Application Gateway	Cet exemple montre comment déployer un cluster AKS avec Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics et Key Vault
Application Gateway avec gestion des API internes et d’application web	Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure.
Application Gateway avec le pare-feu d’applications web et la stratégie de pare-feu	Ce modèle crée une passerelle Application Gateway avec WAF configurée avec une stratégie de pare-feu
Azure Container Registry avec des stratégies et des diagnostics	Azure Container Registry avec des stratégies et des diagnostics (bicep)
Azure Data Factory avec git et la configuration de réseau virtuel managé	Ce modèle crée Azure Data Factory avec la configuration Git et le réseau virtuel managé.
machine virtuelle développeur de jeux Azure	La machine virtuelle développeur de jeux Azure inclut des moteurs licencsed comme Unreal.
Azure SQL Server avec l’audit écrit dans log Analytics	Ce modèle vous permet de déployer un serveur SQL Azure avec l’audit activé pour écrire des journaux d’audit dans Log Analytics (espace de travail OMS)
Créer un cache Redis Premium avec de clustering	Ce modèle montre comment configurer le clustering dans une instance de cache Redis Azure Premium.
Créer un cache Redis à l’aide d’un modèle	Ce modèle crée un cache Redis Azure avec des données de diagnostic conservées dans un compte de stockage.
Créer une gestion des API dans un réseau virtuel interne avec app Gateway	Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Créer un coffre de clés avec journalisation activée	Ce modèle crée un coffre de clés Azure et un compte de stockage Azure utilisé pour la journalisation. Il crée éventuellement des verrous de ressources pour protéger vos ressources Key Vault et stockage.
Créer un cache Redis Premium avec persistance des données	Ce modèle montre comment configurer la persistance dans une instance de cache Redis Azure Premium.
créer un coffre Recovery Services et activer les diagnostics	Ce modèle crée un coffre Recovery Services et active les diagnostics pour sauvegarde Azure. Cela déploie également un compte de stockage et un espace de travail oms.
Créer un coffre Recovery Services avec des stratégies de sauvegarde	Ce modèle crée un coffre Recovery Services avec des stratégies de sauvegarde et configure des fonctionnalités facultatives telles que l’identité du système, le type de stockage de sauvegarde, les journaux de restauration et de diagnostic entre régions et un verrou de suppression.
Déployer une application de microservice Azure Spring Apps simple	Ce modèle déploie une application de microservice Azure Spring Apps simple à exécuter sur Azure.
Déployer Secure Azure AI Studio avec un réseau virtuel managé	Ce modèle crée un environnement Azure AI Studio sécurisé avec des restrictions de sécurité réseau et d’identité robustes.
Front Door Premium avec waf et les ensembles de règles gérés par Microsoft	Ce modèle crée un Front Door Premium, y compris un pare-feu d’applications web avec les ensembles de règles de protection par défaut gérés par Microsoft et bot.
Front Door Standard/Premium avec WAF et une règle personnalisée	Ce modèle crée un Front Door Standard/Premium, y compris un pare-feu d’applications web avec une règle personnalisée.
CDN FrontDoor avec waf, domaines et journaux d’activité sur EventHub	Ce modèle crée un profil cdn Azure FrontDoor. Créez waf avec des règles personnalisées et gérées, des itinéraires cdn, des origines et des groupes avec leur association avec WAF et des itinéraires, configure des domaines personnalisés, créez un hub d’événements et des paramètres de diagnostic pour envoyer des journaux d’accès CDN à l’aide d’Event Hub.
espace de travail Log Analytics avec des solutions et des sources de données	Déploie un espace de travail Log Analytics avec des solutions et des sources de données spécifiées
espace de travail Log Analytics avec VM Insights, Container Insights	Déploie un espace de travail Log Analytics avec VM Insights, des solutions Container Insights et des diagnostics.
groupe de sécurité réseau avec des journaux de diagnostic	Ce modèle crée un groupe de sécurité réseau avec les journaux de diagnostic et un verrou de ressource
utiliser le Pare-feu Azure comme proxy DNS dans une topologie Hub & Spoke	Cet exemple montre comment déployer une topologie hub-spoke dans Azure à l’aide du Pare-feu Azure. Le réseau virtuel hub agit comme un point central de connectivité à de nombreux réseaux virtuels spoke connectés au réseau virtuel hub via le peering de réseaux virtuels.
réseau virtuel avec les journaux de diagnostic	Ce modèle crée un réseau virtuel avec les journaux de diagnostic et permet l’ajout de fonctionnalités facultatives à chaque sous-réseau

Définition de ressource de modèle ARM

Le type de ressource diagnosticSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Insights/diagnosticSettings, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

DiagnosticSettings

Nom	Description	Valeur
eventHubAuthorizationRuleId	ID de ressource de la règle d’autorisation event Hub.	corde
eventHubName	Nom du hub d’événements. Si aucun n’est spécifié, le hub d’événements par défaut est sélectionné.	corde
logAnalyticsDestinationType	Chaîne indiquant si l’exportation vers Log Analytics doit utiliser le type de destination par défaut, c’est-à-dire AzureDiagnostics ou utiliser un type de destination construit comme suit : <identité de service normalisée>_<nom de catégorie normalisé>. Les valeurs possibles sont : Dédié et Null (null est par défaut.)	corde
Journaux	Liste des paramètres des journaux d’activité.	LogSettings[]
métrique	Liste des paramètres de métrique.	MetricSettings[]
serviceBusRuleId	ID de règle Service Bus du paramètre de diagnostic. Il s’agit ici de maintenir la compatibilité descendante.	corde
storageAccountId	ID de ressource du compte de stockage auquel vous souhaitez envoyer des journaux de diagnostic.	corde
workspaceId	ID de ressource ARM complet de l’espace de travail Log Analytics auquel vous souhaitez envoyer des journaux de diagnostic. Exemple : /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2	corde

LogSettings

Nom	Description	Valeur
catégorie	Nom d’une catégorie de journal de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de journaux de diagnostic pour une ressource, effectuez d’abord une opération de paramètres de diagnostic GET.	corde
Activé	valeur indiquant si ce journal est activé.	bool (obligatoire)
retentionPolicy	la stratégie de rétention pour ce journal.	RetentionPolicy

MetricSettings

Nom	Description	Valeur
catégorie	Nom d’une catégorie Métrique de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de métriques de diagnostic pour une ressource, effectuez d’abord une opération de paramètres de diagnostic GET.	corde
Activé	valeur indiquant si cette catégorie est activée.	bool (obligatoire)
retentionPolicy	la stratégie de rétention pour cette catégorie.	RetentionPolicy
timeGrain	l’intervalle de temps de la métrique au format ISO8601.	corde

Microsoft.Insights/diagnosticSettings

Nom	Description	Valeur
apiVersion	Version de l’API	'2017-05-01-preview'
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés d’une ressource de paramètres de diagnostic.	DiagnosticSettings
type	Type de ressource	'Microsoft.Insights/diagnosticSettings'

RetentionPolicy

Nom	Description	Valeur
Jours	nombre de jours pour la rétention en jours. La valeur 0 conserve indéfiniment les événements.	Int Contraintes: Valeur minimale = 0 (obligatoire)
Activé	valeur indiquant si la stratégie de rétention est activée.	bool (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
cluster AKS avec une passerelle NAT et un Application Gateway	Cet exemple montre comment déployer un cluster AKS avec NAT Gateway pour les connexions sortantes et une passerelle Application Gateway pour les connexions entrantes.
cluster AKS avec le contrôleur d’entrée Application Gateway	Cet exemple montre comment déployer un cluster AKS avec Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics et Key Vault
Application Gateway avec gestion des API internes et d’application web	Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure.
Application Gateway avec le pare-feu d’applications web et la stratégie de pare-feu	Ce modèle crée une passerelle Application Gateway avec WAF configurée avec une stratégie de pare-feu
Azure Container Registry avec des stratégies et des diagnostics	Azure Container Registry avec des stratégies et des diagnostics (bicep)
Azure Data Factory avec git et la configuration de réseau virtuel managé	Ce modèle crée Azure Data Factory avec la configuration Git et le réseau virtuel managé.
machine virtuelle développeur de jeux Azure	La machine virtuelle développeur de jeux Azure inclut des moteurs licencsed comme Unreal.
Azure SQL Server avec l’audit écrit dans log Analytics	Ce modèle vous permet de déployer un serveur SQL Azure avec l’audit activé pour écrire des journaux d’audit dans Log Analytics (espace de travail OMS)
Créer un cache Redis Premium avec de clustering	Ce modèle montre comment configurer le clustering dans une instance de cache Redis Azure Premium.
Créer un cache Redis à l’aide d’un modèle	Ce modèle crée un cache Redis Azure avec des données de diagnostic conservées dans un compte de stockage.
Créer une gestion des API dans un réseau virtuel interne avec app Gateway	Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Créer un coffre de clés avec journalisation activée	Ce modèle crée un coffre de clés Azure et un compte de stockage Azure utilisé pour la journalisation. Il crée éventuellement des verrous de ressources pour protéger vos ressources Key Vault et stockage.
Créer un cache Redis Premium avec persistance des données	Ce modèle montre comment configurer la persistance dans une instance de cache Redis Azure Premium.
créer un coffre Recovery Services et activer les diagnostics	Ce modèle crée un coffre Recovery Services et active les diagnostics pour sauvegarde Azure. Cela déploie également un compte de stockage et un espace de travail oms.
Créer un coffre Recovery Services avec des stratégies de sauvegarde	Ce modèle crée un coffre Recovery Services avec des stratégies de sauvegarde et configure des fonctionnalités facultatives telles que l’identité du système, le type de stockage de sauvegarde, les journaux de restauration et de diagnostic entre régions et un verrou de suppression.
créer sql MI avec l’envoi configuré de journaux et de métriques	Ce modèle vous permet de déployer SQL MI et des ressources supplémentaires utilisées pour stocker les journaux et les métriques (espace de travail de diagnostic, compte de stockage, event Hub).
Déployer une application de microservice Azure Spring Apps simple	Ce modèle déploie une application de microservice Azure Spring Apps simple à exécuter sur Azure.
Déployer Secure Azure AI Studio avec un réseau virtuel managé	Ce modèle crée un environnement Azure AI Studio sécurisé avec des restrictions de sécurité réseau et d’identité robustes.
Front Door Premium avec waf et les ensembles de règles gérés par Microsoft	Ce modèle crée un Front Door Premium, y compris un pare-feu d’applications web avec les ensembles de règles de protection par défaut gérés par Microsoft et bot.
Front Door Standard/Premium avec WAF et une règle personnalisée	Ce modèle crée un Front Door Standard/Premium, y compris un pare-feu d’applications web avec une règle personnalisée.
CDN FrontDoor avec waf, domaines et journaux d’activité sur EventHub	Ce modèle crée un profil cdn Azure FrontDoor. Créez waf avec des règles personnalisées et gérées, des itinéraires cdn, des origines et des groupes avec leur association avec WAF et des itinéraires, configure des domaines personnalisés, créez un hub d’événements et des paramètres de diagnostic pour envoyer des journaux d’accès CDN à l’aide d’Event Hub.
espace de travail Log Analytics avec des solutions et des sources de données	Déploie un espace de travail Log Analytics avec des solutions et des sources de données spécifiées
espace de travail Log Analytics avec VM Insights, Container Insights	Déploie un espace de travail Log Analytics avec VM Insights, des solutions Container Insights et des diagnostics.
groupe de sécurité réseau avec des journaux de diagnostic	Ce modèle crée un groupe de sécurité réseau avec les journaux de diagnostic et un verrou de ressource
utiliser le Pare-feu Azure comme proxy DNS dans une topologie Hub & Spoke	Cet exemple montre comment déployer une topologie hub-spoke dans Azure à l’aide du Pare-feu Azure. Le réseau virtuel hub agit comme un point central de connectivité à de nombreux réseaux virtuels spoke connectés au réseau virtuel hub via le peering de réseaux virtuels.
réseau virtuel avec les journaux de diagnostic	Ce modèle crée un réseau virtuel avec les journaux de diagnostic et permet l’ajout de fonctionnalités facultatives à chaque sous-réseau

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource diagnosticSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Insights/diagnosticSettings, ajoutez terraform suivant à votre modèle.

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

Valeurs de propriété

DiagnosticSettings

Nom	Description	Valeur
eventHubAuthorizationRuleId	ID de ressource de la règle d’autorisation event Hub.	corde
eventHubName	Nom du hub d’événements. Si aucun n’est spécifié, le hub d’événements par défaut est sélectionné.	corde
logAnalyticsDestinationType	Chaîne indiquant si l’exportation vers Log Analytics doit utiliser le type de destination par défaut, c’est-à-dire AzureDiagnostics ou utiliser un type de destination construit comme suit : <identité de service normalisée>_<nom de catégorie normalisé>. Les valeurs possibles sont : Dédié et Null (null est par défaut.)	corde
Journaux	Liste des paramètres des journaux d’activité.	LogSettings[]
métrique	Liste des paramètres de métrique.	MetricSettings[]
serviceBusRuleId	ID de règle Service Bus du paramètre de diagnostic. Il s’agit ici de maintenir la compatibilité descendante.	corde
storageAccountId	ID de ressource du compte de stockage auquel vous souhaitez envoyer des journaux de diagnostic.	corde
workspaceId	ID de ressource ARM complet de l’espace de travail Log Analytics auquel vous souhaitez envoyer des journaux de diagnostic. Exemple : /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2	corde

LogSettings

Nom	Description	Valeur
catégorie	Nom d’une catégorie de journal de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de journaux de diagnostic pour une ressource, effectuez d’abord une opération de paramètres de diagnostic GET.	corde
Activé	valeur indiquant si ce journal est activé.	bool (obligatoire)
retentionPolicy	la stratégie de rétention pour ce journal.	RetentionPolicy

MetricSettings

Nom	Description	Valeur
catégorie	Nom d’une catégorie Métrique de diagnostic pour un type de ressource auquel ce paramètre est appliqué. Pour obtenir la liste des catégories de métriques de diagnostic pour une ressource, effectuez d’abord une opération de paramètres de diagnostic GET.	corde
Activé	valeur indiquant si cette catégorie est activée.	bool (obligatoire)
retentionPolicy	la stratégie de rétention pour cette catégorie.	RetentionPolicy
timeGrain	l’intervalle de temps de la métrique au format ISO8601.	corde

Microsoft.Insights/diagnosticSettings

Nom	Description	Valeur
nom	Nom de la ressource	chaîne (obligatoire)
parent_id	ID de la ressource à laquelle appliquer cette ressource d’extension.	chaîne (obligatoire)
Propriétés	Propriétés d’une ressource de paramètres de diagnostic.	DiagnosticSettings
type	Type de ressource	« Microsoft.Insights/diagnosticSettings@2017-05-01-preview »

RetentionPolicy

Nom	Description	Valeur
Jours	nombre de jours pour la rétention en jours. La valeur 0 conserve indéfiniment les événements.	Int Contraintes: Valeur minimale = 0 (obligatoire)
Activé	valeur indiquant si la stratégie de rétention est activée.	bool (obligatoire)

Partager via

Microsoft.Insights diagnosticSettings 2017-05-01-preview

Remarques

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

DiagnosticSettings

LogSettings

MetricSettings

Microsoft.Insights/diagnosticSettings

RetentionPolicy

Commentaires

Ressources supplémentaires