Set-AzDiagnosticSetting

設定資源的記錄和計量設定。

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

Description

Set-AzDiagnosticSetting Cmdlet 會啟用或停用特定資源的每次粒紋和記錄類別。 記錄和計量會儲存在指定的儲存體帳戶中。 此 Cmdlet 會實作 ShouldProcess 模式,也就是在實際建立、修改或移除資源之前,可能會要求使用者確認。

範例

範例 1:啟用資源的所有計量和記錄

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

此命令會啟用 Resource01 的所有可用計量和記錄。

範例 2:停用所有計量和記錄

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

此命令會停用資源 Resource01 的所有可用計量和記錄。

範例 3:啟用/停用多個計量類別

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

此命令會停用名為 Category1 和 Category2 的計量類別。 所有其他類別都保持不變。

範例 4:啟用/停用多個記錄類別

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

此命令會啟用 Category1 和 Category2。 所有其他計量和記錄類別都保持不變。

範例 4:啟用時間粒紋和多個類別

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

此命令只啟用 Category1、Category2 和時間粒紋 PT1M。 所有其他時間粒紋和類別都會保持不變。

範例 5:使用管線

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

此命令會使用 PowerShell 管線來設定診斷設定(未進行變更)。

參數

-Category

根據 Enabled 的值,指定要啟用或停用的 記錄類別清單。 如果未指定任何類別,此命令會在所有支援的類別上運作。

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

執行 Cmdlet 之前先提示您確認。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租使用者和訂用帳戶

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enabled

指出是否要啟用診斷。 指定$True以啟用診斷,或$False停用診斷。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EventHubAuthorizationRuleId

事件中樞授權規則識別碼

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EventHubName

事件中樞名稱

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ExportToResourceSpecific

指出匯出至 LA 的旗標必須執行至資源特定資料表,也就是專用或固定架構資料表,而不是 稱為 AzureDiagnostics 的預設 動態架構資料表。

只有當引數 -workspaceId 也提供時,這個引數 才有效。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

輸入物件(可能來自管線。)名稱和 resourceId 將會從這個物件擷取。

Type:PSServiceDiagnosticSettings
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MetricCategory

計量類別清單。 如果未指定任何類別,此命令會在所有支援的類別上運作。

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

診斷設定的名稱。 預設值為 service

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

指定資源的識別碼。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RetentionEnabled

指出是否啟用診斷資訊的保留期。

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RetentionInDays

指定保留原則,以天為單位。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceBusRuleId

服務匯流排規則識別碼。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountId

指定要在其中儲存資料的儲存體帳戶識別碼。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Timegrain

根據 Enabled 的值 ,指定要啟用或停用計量的時間粒紋。 如果您未指定時間粒紋,此命令會在所有可用的時間粒紋上運作。

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceId

要傳送記錄/計量的 Log Analytics 工作區資源識別碼

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

輸入

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

輸出

PSServiceDiagnosticSettings