Share via

az storage logging

Manage storage service logging information.

Commands

Name Description Type Status
az storage logging off

Turn off logging for a storage account.

 Core Preview
az storage logging show

Show logging settings for a storage account.

 Core GA
az storage logging update

Update logging settings for a storage account.

 Core GA

az storage logging off

Edit
Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Turn off logging for a storage account.

az storage logging off [--account-key]
                       [--account-name]
                       [--connection-string]
                       [--sas-token]
                       [--service-endpoint]
                       [--services]
                       [--timeout]

Examples

Turn off logging for a storage account.

az storage logging off --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 or service endpoint. 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
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--service-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--services

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

Property Value
Default value: bqt
--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 logging show

Edit

Show logging settings for a storage account.

az storage logging show [--account-key]
                        [--account-name]
                        [--connection-string]
                        [--sas-token]
                        [--service-endpoint]
                        [--services]
                        [--timeout]

Examples

Show logging settings for a storage account. (autogenerated)

az storage logging show --account-name MyAccount --services qt

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 or service endpoint. 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
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--service-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--services

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

Property Value
Default value: bqt
--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 logging update

Edit

Update logging settings for a storage account.

az storage logging update --log
                          --retention
                          --services
                          [--account-key]
                          [--account-name]
                          [--connection-string]
                          [--sas-token]
                          [--service-endpoint]
                          [--timeout]
                          [--version]

Required Parameters

--log

The operations for which to enable logging: (r)ead (w)rite (d)elete. Can be combined.

--retention

Number of days for which to retain logs. 0 to disable.

--services

The storage service(s) for which to update logging 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 or service endpoint. 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
--sas-token

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

Property Value
Parameter group: Storage Account Arguments
--service-endpoint

Storage data service endpoint. Must be used in conjunction with either storage account key or a SAS token. You can find each service primary endpoint with az storage account show. Environment variable: AZURE_STORAGE_SERVICE_ENDPOINT.

Property Value
Parameter group: Storage Account Arguments
--timeout

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

--version

Version of the logging schema.

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