Set-AzDiagnosticSetting

  • Référence
Module:
Az.Monitor

Définit les paramètres des journaux et des métriques pour la ressource.

Syntaxe

Set-AzDiagnosticSetting
   -ResourceId <String>
   [-Name <String>]
   [-StorageAccountId <String>]
   [-ServiceBusRuleId <String>]
   [-EventHubName <String>]
   [-EventHubAuthorizationRuleId <String>]
   [-Enabled <Boolean>]
   [-Category <System.Collections.Generic.List`1[System.String]>]
   [-MetricCategory <System.Collections.Generic.List`1[System.String]>]
   [-Timegrain <System.Collections.Generic.List`1[System.String]>]
   [-RetentionEnabled <Boolean>]
   [-WorkspaceId <String>]
   [-ExportToResourceSpecific]
   [-RetentionInDays <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDiagnosticSetting
   -InputObject <PSServiceDiagnosticSettings>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Set-AzDiagnosticSetting active ou désactive chaque fois que le grain et la catégorie de journal pour la ressource particulière. Les journaux et les métriques sont stockés dans le compte de stockage spécifié. Cette applet de commande implémente le modèle ShouldProcess, c’est-à-dire qu’il peut demander la confirmation de l’utilisateur avant de créer, de modifier ou de supprimer la ressource.

Exemples

Exemple 1 : Activer toutes les métriques et tous les journaux d’activité d’une ressource

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True

Cette commande active toutes les métriques et journaux disponibles pour Resource01.

Exemple 2 : Désactiver toutes les métriques et tous les journaux

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False

Cette commande désactive toutes les métriques et journaux disponibles pour la ressource Resource01.

Exemple 3 : Activer/désactiver plusieurs catégories de métriques

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $False -MetricCategory MetricCategory1,MetricCategory2
StorageAccountId   : <storageAccountId>
StorageAccountName : <storageAccountName>
Metrics
   Enabled   : False
   Category  : MetricCategory1
   Timegrain : PT1M
   Enabled   : False
   Category  : MetricCategory2
   Timegrain : PT1H
   Enabled   : True
   Category  : MetricCategory3
   Timegrain : PT1H
Logs
   Enabled  : True
   Category : Category1
   Enabled  : True
   Category : Category2
   Enabled  : True
   Category : Category3
   Enabled  : False
   Category : Category4

Cette commande désactive les catégories de métriques appelées Category1 et Category2. Toutes les autres catégories restent les mêmes.

Exemple 4 : Activer/désactiver plusieurs catégories de journaux

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2
StorageAccountId   : <storageAccountId>
StorageAccountName : <storageAccountName>
Metrics
   Enabled   : False
   Category  : MetricCategory1
   Timegrain : PT1M
   Enabled   : False
   Category  : MetricCategory2
   Timegrain : PT1H
   Enabled   : True
   Category  : MetricCategory3
   Timegrain : PT1H
Logs
   Enabled  : True
   Category : Category1
   Enabled  : True
   Category : Category2
   Enabled  : True
   Category : Category3
   Enabled  : False
   Category : Category4

Cette commande active Category1 et Category2. Toutes les autres catégories de métriques et de journaux restent identiques.

Exemple 4 : Activer un grain de temps et plusieurs catégories

PS C:\>Set-AzDiagnosticSetting -ResourceId "Resource01" -Enabled $True -Category Category1,Category2 -Timegrain PT1M

Cette commande active uniquement Category1, Category2 et time grain PT1M. Tous les autres grains et catégories de temps sont inchangés.

Exemple 5 : Utilisation du pipeline

PS C:\>Get-AzDiagnosticSetting -ResourceId "Resource01" | Set-AzDiagnosticSetting -Enabled $True -Category Category1,Category2

Cette commande utilise le pipeline PowerShell pour définir (aucune modification apportée) un paramètre de diagnostic.

Paramètres

-Category

Spécifie la liste des catégories de journaux à activer ou désactiver, en fonction de la valeur Enabled. Si aucune catégorie n’est spécifiée, cette commande fonctionne sur toutes les catégories prises en charge.

Type:List<T>[String]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Enabled

Indique s’il faut activer les diagnostics. Spécifiez $True pour activer les diagnostics ou $False pour désactiver les diagnostics.

Type:Boolean
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-EventHubAuthorizationRuleId

ID de règle d’autorisation event Hub

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-EventHubName

Nom du hub d’événements

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ExportToResourceSpecific

Indicateur indiquant que l’exportation vers LA doit être effectuée vers une table spécifique à une ressource, une table de schémas dédiée ou fixe, par opposition à la table de schéma dynamique par défaut appelée AzureDiagnostics.

Cet argument est effectif uniquement lorsque l’argument -workspaceId est également donné.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-InputObject

Objet d’entrée (possible à partir du pipeline.) Le nom et resourceId seront extraits de cet objet.

Type:PSServiceDiagnosticSettings
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-MetricCategory

Liste des catégories de métriques. Si aucune catégorie n’est spécifiée, cette commande fonctionne sur toutes les catégories prises en charge.

Type:List<T>[String]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Nom du paramètre de diagnostic. La valeur par défaut est service.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ResourceId

Spécifie l’ID de la ressource.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-RetentionEnabled

Indique si la rétention des informations de diagnostic est activée.

Type:Nullable<T>[Boolean]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-RetentionInDays

Spécifie la stratégie de rétention, en jours.

Type:Nullable<T>[Int32]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ServiceBusRuleId

ID de règle Service Bus.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-StorageAccountId

Spécifie l’ID du compte de stockage dans lequel enregistrer les données.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Timegrain

Spécifie les grains de temps à activer ou désactiver pour les métriques, en fonction de la valeur Enabled. Si vous ne spécifiez pas de grain de temps, cette commande fonctionne sur tous les grains de temps disponibles.

Type:List<T>[String]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WorkspaceId

ID de ressource de l’espace de travail log Analytique pour envoyer des journaux/métriques à

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

PSServiceDiagnosticSettings

String

Boolean

List<T>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Sorties

PSServiceDiagnosticSettings