Set-AzureStorageServiceMetricsProperty

Modifies metrics properties for the Azure Storage service.

Syntax

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

Description

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

Examples

Example 1: Modify metrics properties for the Blob service

C:\PS>Set-AzureStorageServiceMetricsProperty -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.

Required Parameters

-MetricsType

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

Type:Microsoft.WindowsAzure.Commands.Storage.Common.ServiceMetricsType
Parameter Sets:Hour, Minute
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:Microsoft.WindowsAzure.Commands.Storage.Common.StorageServiceType
Parameter Sets:Blob, Table, Queue, File
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Context

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IStorageContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-MetricsLevel

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

  • None
  • Service
  • ServiceAndApi
Type:System.Nullable`1[Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsLevel]
Parameter Sets:None, Service, ServiceAndApi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RetentionDays

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

Type:System.Nullable`1[System.Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Version

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

Type:System.Nullable`1[System.Double]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IStorageContext

Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline

Outputs

Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties