Set-AzDiagnosticSetting

Modul:: Az.Monitor Module

Sets the logs and metrics settings for the resource.

Syntax

OldSetDiagnosticSetting (Standard)

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

NewSetDiagnosticSetting

Set-AzDiagnosticSetting
    -InputObject <PSServiceDiagnosticSettings>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AzDiagnosticSetting cmdlet enables or disables each time grain and log category for the particular resource. The logs and metrics are stored in the specified storage account. This cmdlet implements the ShouldProcess pattern, i.e. it might request confirmation from the user before actually creating, modifying, or removing the resource.

Exempel

Example 1: Enable all metrics and logs for a resource

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

This command enables all available metrics and logs for Resource01.

Example 2: Disable all metrics and logs

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

This command disables all available metrics and logs for the resource Resource01.

Example 3: Enable/disable multiple metrics categories

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

This command disables the metrics categories called Category1 and Category2. All the other categories remain the same.

Example 4: Enable/disable multiple log categories

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

This command enables Category1 and Category2. All the other metrics and logs categories remain the same.

Example 4: Enable a time grain and multiple categories

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

This command enables only Category1, Category2, and time grain PT1M. All other time grains and categories are unchanged.

Example 5: Using pipeline

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

This command uses the PowerShell pipeline to set (no change made) a diagnostic setting.

Parametrar

-Category

Specifies the list of log categories to enable or disable, according to the value of Enabled. If no category is specified, this command operates on all supported categories.

Parameteregenskaper

Typ:	List<T>[String]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameteregenskaper

Typ:	SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	cf

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameteregenskaper

Typ:	IAzureContextContainer
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Enabled

Indicates whether to enable diagnostics. Specify $True to enable diagnostics, or $False to disable diagnostics.

Parameteregenskaper

Typ:	Boolean
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-EventHubAuthorizationRuleId

The event hub authorization rule id

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-EventHubName

The event hub name

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-ExportToResourceSpecific

Flag indicating that the export to LA must be done to a resource specific table, a.k.a. dedicated or fixed schema table, as opposed to the default dynamic schema table called AzureDiagnostics.

This argument is effective only when the argument -workspaceId is also given.

Parameteregenskaper

Typ:	SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-InputObject

The input object (possible from the pipeline.) The name and resourceId will be extracted from this object.

Parameteregenskaper

Typ:	PSServiceDiagnosticSettings
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

NewSetDiagnosticSetting

Position:	Named
Obligatorisk:	True
Värde från pipeline:	True
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-MetricCategory

The list of metric categories. If no category is specified, this command operates on all supported categories.

Parameteregenskaper

Typ:	List<T>[String]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-Name

The name of the diagnostic setting. The default value is service.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-ResourceId

Specifies the ID of the resource.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	True
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-RetentionEnabled

Indicates whether retention of diagnostic information is enabled.

Parameteregenskaper

Typ:	Nullable<T>[Boolean]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-RetentionInDays

Specifies the retention policy, in days.

Parameteregenskaper

Typ:	Nullable<T>[Int32]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-ServiceBusRuleId

The Service Bus Rule id.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-StorageAccountId

Specifies the ID of the Storage account in which to save the data.

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-Timegrain

Specifies the time grains to enable or disable for metrics, according to the value of Enabled. If you do not specify a time grain, this command operates on all available time grains.

Parameteregenskaper

Typ:	List<T>[String]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameteregenskaper

Typ:	SwitchParameter
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False
Alias:	wi

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-WorkspaceId

The resource Id of the Log Analytics workspace to send logs/metrics to

Parameteregenskaper

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

OldSetDiagnosticSetting

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Dela via

Set-AzDiagnosticSetting

Syntax

OldSetDiagnosticSetting (Standard)

NewSetDiagnosticSetting

Description

Exempel

Example 1: Enable all metrics and logs for a resource

Example 2: Disable all metrics and logs

Example 3: Enable/disable multiple metrics categories

Example 4: Enable/disable multiple log categories

Example 4: Enable a time grain and multiple categories

Example 5: Using pipeline

Parametrar

-Category

Parameteregenskaper

Parameteruppsättningar

-Confirm

Parameteregenskaper

Parameteruppsättningar

-DefaultProfile

Parameteregenskaper

Parameteruppsättningar

-Enabled

Parameteregenskaper

Parameteruppsättningar

-EventHubAuthorizationRuleId

Parameteregenskaper

Parameteruppsättningar

-EventHubName

Parameteregenskaper

Parameteruppsättningar

-ExportToResourceSpecific

Parameteregenskaper

Parameteruppsättningar

-InputObject

Parameteregenskaper

Parameteruppsättningar

-MetricCategory

Parameteregenskaper

Parameteruppsättningar

-Name

Parameteregenskaper

Parameteruppsättningar

-ResourceId

Parameteregenskaper

Parameteruppsättningar

-RetentionEnabled

Parameteregenskaper

Parameteruppsättningar

-RetentionInDays

Parameteregenskaper

Parameteruppsättningar

-ServiceBusRuleId

Parameteregenskaper

Parameteruppsättningar

-StorageAccountId

Parameteregenskaper

Parameteruppsättningar

-Timegrain

Parameteregenskaper

Parameteruppsättningar

-WhatIf

Parameteregenskaper

Parameteruppsättningar

-WorkspaceId

Parameteregenskaper

Parameteruppsättningar

CommonParameters

Indata

PSServiceDiagnosticSettings

String

Boolean

List<T>

Nullable<T>

Nullable<T>

Utdata

PSServiceDiagnosticSettings

Relaterade länkar