Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 2.83 KB

New-AzDiagnosticSettingMetricSettingsObject.md

File metadata and controls

123 lines (93 loc) · 2.83 KB
Raw
external help file Module Name online version schema
Az.DiagnosticSetting.psm1-help.xml
Az.Monitor
2.0.0

New-AzDiagnosticSettingMetricSettingsObject

SYNOPSIS

Create an in-memory object for MetricSettings.

SYNTAX

New-AzDiagnosticSettingMetricSettingsObject -Enabled <Boolean> [-Category <String>]
 [-RetentionPolicyDay <Int32>] [-RetentionPolicyEnabled <Boolean>] [-TimeGrain <TimeSpan>]
 [<CommonParameters>]

DESCRIPTION

Create an in-memory object for MetricSettings.

EXAMPLES

Example 1: Create metric setting object

New-AzDiagnosticSettingMetricSettingsObject -Enabled $true -Category AllMetrics -RetentionPolicyDay 7 -RetentionPolicyEnabled $true

Create metric setting object, to get supported categories for resource, please see Get-AzDiagnosticSettingCategory

PARAMETERS

-Category

Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Enabled

a value indicating whether this category is enabled.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

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

-RetentionPolicyDay

the number of days for the retention in days. A value of 0 will retain the events indefinitely.

Type: System.Int32
Parameter Sets: (All)
Aliases:

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

-RetentionPolicyEnabled

a value indicating whether the retention policy is enabled.

Type: System.Boolean
Parameter Sets: (All)
Aliases:

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

-TimeGrain

the timegrain of the metric in ISO8601 format.

Type: System.TimeSpan
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.MetricSettings

NOTES

RELATED LINKS