Edit

Share via

Set-AzStorageServiceMetricsProperty

Module:
Az.Storage Module

Modifies metrics properties for the Azure Storage service.

Syntax

Default (Default) 

Set-AzStorageServiceMetricsProperty
    [-ServiceType] <StorageServiceType>
    [-MetricsType] <ServiceMetricsType>
    [-Version <Double>]
    [-RetentionDays <Int32>]
    [-MetricsLevel <MetricsLevel>]
    [-PassThru]
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Set-AzStorageServiceMetricsProperty cmdlet modifies metrics properties for the Azure Storage service.

Examples

Example 1: Modify metrics properties for the Blob service

Set-AzStorageServiceMetricsProperty -ServiceType Blob -MetricsType Hour -MetricsLevel Service -PassThru -RetentionDays 10 -Version 1.0

This command modifies version 1.0 metrics for blob storage to a level of Service. Azure Storage service metrics retains entries for 10 days. Because this command specifies the PassThru parameter, the command displays the modified metrics properties.

Parameters

-Context

Specifies an Azure storage context. To obtain a storage context, use the New-AzStorageContext cmdlet.

Parameter properties

Type:IStorageContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MetricsLevel

Specifies the metrics level that Azure Storage uses for the service. The acceptable values for this parameter are:

  • None
  • Service
  • ServiceAndApi

Parameter properties

Type:

Nullable<T>[MetricsLevel]

Default value:None
Accepted values:None, Service, ServiceAndApi
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MetricsType

Specifies a metrics type. This cmdlet sets the Azure Storage service metrics type to the value that this parameter specifies. The acceptable values for this parameter are: Hour and Minute.

Parameter properties

Type:ServiceMetricsType
Default value:None
Accepted values:Hour, Minute
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Indicates that this cmdlets returns the updated metrics properties. If you do not specify this parameter, this cmdlet does not return a value.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RetentionDays

Specifies the number of days that the Azure Storage service retains metrics information.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceType

Specifies the storage service type. This cmdlet modifies the metrics properties for the service type that this parameter specifies. The acceptable values for this parameter are:

  • Blob
  • Table
  • Queue
  • File The value of File is not currently supported.

Parameter properties

Type:StorageServiceType
Default value:None
Accepted values:Blob, Table, Queue, File
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Version

Specifies the version of the Azure Storage metrics. The default value is 1.0.

Parameter properties

Type:

Nullable<T>[Double]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Inputs

IStorageContext

Outputs

MetricsProperties