< Back
Set-AzureStorageServiceMetricsProperty
Post
NAME Set-AzureStorageServiceMetricsProperty
SYNOPSIS
Modifies metrics properties for the Azure Storage service.
SYNTAX
Set-AzureStorageServiceMetricsProperty [-ServiceType] {Blob | Table | Queue | File} [-MetricsType] {Hour | Minute} [-Context <IStorageContext>]
[-MetricsLevel {None | Service | ServiceAndApi}] [-PassThru] [-RetentionDays <Int32>] [-Version <Double>] [<CommonParameters>]
DESCRIPTION
The Set-AzureStorageServiceMetricsProperty cmdlet modifies metrics properties for the Azure Storage service.
PARAMETERS
-Context <IStorageContext>
Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-MetricsLevel <MetricsLevel>
Specifies the metrics level that Azure Storage uses for the service. The acceptable values for this parameter are:
- None
- Service
- ServiceAndApi
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MetricsType <ServiceMetricsType>
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.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlets returns the updated metrics properties. If you do not specify this parameter, this cmdlet does not return a value.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RetentionDays <Int32>
Specifies the number of days that the Azure Storage service retains metrics information.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceType <StorageServiceType>
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.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Version <Double>
Specifies the version of the Azure Storage metrics. The default value is 1.0.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
OUTPUTS
Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... csproperty
Get-AzureStorageServiceMetricsProperty
New-AzureStorageContext
SYNOPSIS
Modifies metrics properties for the Azure Storage service.
SYNTAX
Set-AzureStorageServiceMetricsProperty [-ServiceType] {Blob | Table | Queue | File} [-MetricsType] {Hour | Minute} [-Context <IStorageContext>]
[-MetricsLevel {None | Service | ServiceAndApi}] [-PassThru] [-RetentionDays <Int32>] [-Version <Double>] [<CommonParameters>]
DESCRIPTION
The Set-AzureStorageServiceMetricsProperty cmdlet modifies metrics properties for the Azure Storage service.
PARAMETERS
-Context <IStorageContext>
Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-MetricsLevel <MetricsLevel>
Specifies the metrics level that Azure Storage uses for the service. The acceptable values for this parameter are:
- None
- Service
- ServiceAndApi
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MetricsType <ServiceMetricsType>
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.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlets returns the updated metrics properties. If you do not specify this parameter, this cmdlet does not return a value.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RetentionDays <Int32>
Specifies the number of days that the Azure Storage service retains metrics information.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceType <StorageServiceType>
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.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Version <Double>
Specifies the version of the Azure Storage metrics. The default value is 1.0.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
OUTPUTS
Microsoft.WindowsAzure.Storage.Shared.Protocol.MetricsProperties
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... csproperty
Get-AzureStorageServiceMetricsProperty
New-AzureStorageContext