New-AzDiagnosticDetailSetting

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.Monitor

Create PSDiagnosticDetailSetting Object, type could be metric or log

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

New-AzDiagnosticDetailSetting
   -Log
   [-RetentionInDays <Int32>]
   [-RetentionEnabled]
   -Category <String>
   [-Enabled]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzDiagnosticDetailSetting
   -Metric
   [-RetentionInDays <Int32>]
   [-RetentionEnabled]
   -Category <String>
   [-Enabled]
   [-TimeGrain <TimeSpan>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Create PSMetricSettings or PSLogSettings object. You can get categories by using Get-AzDiagnosticSettingCategory.

Examples

Example 1

PS C:\> $TimeGrain=New-TimeSpan -Days 90
PS C:\> New-AzDiagnosticDetailSetting -Metric -RetentionInDays 1 -RetentionEnabled -Category AllMetrics -Enabled -TimeGrain $TimeGrain
TimeGrain       : 90.00:00:00
Category        : AllMetrics
Enabled         : True
RetentionPolicy :
                  Enabled : True
                  Days    : 1
CategoryType    : Metrics

Create PSMetricSettings object.

Example 2

PS C:\> New-AzDiagnosticDetailSetting -Log -RetentionInDays 1 -RetentionEnabled -Category Audit -Enabled
Category Enabled RetentionPolicy               CategoryType
-------- ------- ---------------               ------------
Audit       True …                                     Logs

Create PSLogSettings object.

Parameters

-Category

Category of setting

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-Enabled

Enable the setting

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

-Log

To create log setting

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

-Metric

To create metric setting

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

-RetentionEnabled

Enable Retention policy

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

-RetentionInDays

Retention days for retention policy

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeGrain

TimeGrain for metric setting

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

Inputs

String

Outputs

PSDiagnosticDetailSettings