Set-AzDiagnosticSetting

  • Referenz
Modul:
Az.Monitor

Legt die Protokoll- und Metrikeinstellungen für die Ressource fest.

Syntax

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>]

Beschreibung

Das Cmdlet "Set-AzDiagnosticSetting " aktiviert oder deaktiviert jedes Mal die Korn- und Protokollkategorie für die jeweilige Ressource. Die Protokolle und Metriken werden im angegebenen Speicherkonto gespeichert. Dieses Cmdlet implementiert das ShouldProcess-Muster, d. h. es kann eine Bestätigung des Benutzers anfordern, bevor die Ressource tatsächlich erstellt, geändert oder entfernt wird.

Beispiele

Beispiel 1: Aktivieren aller Metriken und Protokolle für eine Ressource

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

Mit diesem Befehl werden alle verfügbaren Metriken und Protokolle für Resource01 aktiviert.

Beispiel 2: Alle Metriken und Protokolle deaktivieren

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

Mit diesem Befehl werden alle verfügbaren Metriken und Protokolle für die Ressource Ressource01 deaktiviert.

Beispiel 3: Aktivieren/Deaktivieren mehrerer Metrikkategorien

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

Mit diesem Befehl werden die Metrikkategorien "Kategorie1" und "Kategorie2" deaktiviert. Alle anderen Kategorien bleiben gleich.

Beispiel 4: Aktivieren/Deaktivieren mehrerer Protokollkategorien

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

Dieser Befehl aktiviert Kategorie1 und Kategorie2. Alle anderen Metriken und Protokollkategorien bleiben gleich.

Beispiel 4: Aktivieren eines Zeitkorns und mehrerer Kategorien

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

Dieser Befehl aktiviert nur Kategorie1, Kategorie2 und Zeitkorn PT1M. Alle anderen Zeitkornen und Kategorien sind unverändert.

Beispiel 5: Verwenden der Pipeline

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

Dieser Befehl verwendet die PowerShell-Pipeline, um eine Diagnoseeinstellung festzulegen (keine Änderung vorgenommen).

Parameter

-Category

Gibt die Liste der zu aktivierenden oder deaktivierenden Protokollkategorien gemäß dem Wert von "Enabled" an. Wenn keine Kategorie angegeben ist, wird dieser Befehl für alle unterstützten Kategorien ausgeführt.

Typ:List<T>[String]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Enabled

Gibt an, ob die Diagnose aktiviert werden soll. Geben Sie $True an, um die Diagnose zu aktivieren, oder $False, um die Diagnose zu deaktivieren.

Typ:Boolean
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-EventHubAuthorizationRuleId

Die Ereignishub-Autorisierungsregel-ID

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-EventHubName

Der Name des Ereignishubs

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ExportToResourceSpecific

Flag, das angibt, dass der Export nach LA in eine ressourcenspezifische Tabelle(a.k.a. dedizierte oder feste Schematabelle) erfolgen muss, im Gegensatz zur standardmäßigen dynamischen Schematabelle namens AzureDiagnostics.

Dieses Argument ist nur wirksam, wenn das Argument "-workspaceId" ebenfalls angegeben wird.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-InputObject

Das Eingabeobjekt (möglich aus der Pipeline).) Der Name und die resourceId werden aus diesem Objekt extrahiert.

Typ:PSServiceDiagnosticSettings
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-MetricCategory

Die Liste der Metrikkategorien. Wenn keine Kategorie angegeben ist, wird dieser Befehl für alle unterstützten Kategorien ausgeführt.

Typ:List<T>[String]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Der Name der Diagnoseeinstellung. Der Standardwert ist "Service".

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ResourceId

Gibt die ID der Ressource an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-RetentionEnabled

Gibt an, ob die Aufbewahrung von Diagnoseinformationen aktiviert ist.

Typ:Nullable<T>[Boolean]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-RetentionInDays

Gibt die Aufbewahrungsrichtlinie in Tagen an.

Typ:Nullable<T>[Int32]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ServiceBusRuleId

Die Id der Servicebusregel.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-StorageAccountId

Gibt die ID des Speicherkontos an, in dem die Daten gespeichert werden sollen.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Timegrain

Gibt die Zeitkornen an, die für Metriken gemäß dem Wert von "Enabled" aktiviert oder deaktiviert werden sollen. Wenn Sie keinen Zeitkorn angeben, wird dieser Befehl auf allen verfügbaren Zeitkornen ausgeführt.

Typ:List<T>[String]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-WorkspaceId

Die Ressourcen-ID des Log Analytics-Arbeitsbereichs zum Senden von Protokollen/Metriken an

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

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]]

Ausgaben

PSServiceDiagnosticSettings