Share via

az storage metrics

Manage storage service metrics.

Commands

Name Description Type Status
az storage metrics show

Show metrics settings for a storage account.

 Core GA
az storage metrics update

Update metrics settings for a storage account.

 Core GA

az storage metrics show

Edit

Show metrics settings for a storage account.

az storage metrics show [--account-key]
                        [--account-name]
                        [--connection-string]
                        [--interval {both, hour, minute}]
                        [--sas-token]
                        [--services]
                        [--timeout]

Examples

Show metrics settings for a storage account. (autogenerated)

az storage metrics show --account-key 00000000 --account-name MyAccount

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

Property Value
Parameter group: Storage Account Arguments
--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

Property Value
Parameter group: Storage Account Arguments
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--interval

Filter the set of metrics to retrieve by time interval.

Property Value
Default value: both
Accepted values: both, hour, minute
--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

Property Value
Parameter group: Storage Account Arguments
--services

The storage services from which to retrieve metrics info: (b)lob (q)ueue (t)able. Can be combined.

Property Value
Default value: bfqt
--timeout

Request timeout in seconds. Applies to each call to the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az storage metrics update

Edit

Update metrics settings for a storage account.

az storage metrics update --retention
                          --services
                          [--account-key]
                          [--account-name]
                          [--api {false, true}]
                          [--connection-string]
                          [--hour {false, true}]
                          [--minute {false, true}]
                          [--sas-token]
                          [--timeout]

Examples

Update metrics settings for a storage account. (autogenerated)

az storage metrics update --account-name MyAccount --api true --hour true --minute true --retention 10 --services bfqt

Update metrics settings for a storage account by connection string. (autogenerated)

az storage metrics update --api true --connection-string $connectionString --hour true --minute true --retention 10 --services bfqt

Required Parameters

--retention

Number of days for which to retain metrics. 0 to disable. Applies to both hour and minute metrics if both are specified.

--services

The storage services from which to retrieve metrics info: (b)lob (q)ueue (t)able. Can be combined.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-key

Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.

Property Value
Parameter group: Storage Account Arguments
--account-name

Storage account name. Related environment variable: AZURE_STORAGE_ACCOUNT. Must be used in conjunction with either storage account key or a SAS token. If neither are present, the command will try to query the storage account key using the authenticated Azure account. If a large number of storage commands are executed the API quota may be hit.

Property Value
Parameter group: Storage Account Arguments
--api

Specify whether to include API in metrics. Applies to both hour and minute metrics if both are specified. Must be specified if hour or minute metrics are enabled and being updated.

Property Value
Accepted values: false, true
--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property Value
Parameter group: Storage Account Arguments
--hour

Update the hourly metrics.

Property Value
Accepted values: false, true
--minute

Update the by-minute metrics.

Property Value
Accepted values: false, true
--sas-token

A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.

Property Value
Parameter group: Storage Account Arguments
--timeout

Request timeout in seconds. Applies to each call to the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False