Share via

az storage fs service-properties

  • Reference

Manage storage datalake service properties.

Commands

Name Description Type Status
az storage fs service-properties show

Show the properties of a storage account's datalake service, including Azure Storage Analytics.

 Core GA
az storage fs service-properties update

Update the properties of a storage account's datalake service, including Azure Storage Analytics.

 Core GA

az storage fs service-properties show

Edit

Show the properties of a storage account's datalake service, including Azure Storage Analytics.

az storage fs service-properties show [--account-key]
                                      [--account-name]
                                      [--auth-mode {key, login}]
                                      [--blob-endpoint]
                                      [--connection-string]
                                      [--sas-token]

Examples

Show the properties of a storage account's datalake service

az storage fs service-properties show --account-name mystorageccount --account-key 00000000

Optional Parameters

--account-key

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

--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.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

Accepted values: key, login
--blob-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.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--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.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az storage fs service-properties update

Edit

Update the properties of a storage account's datalake service, including Azure Storage Analytics.

az storage fs service-properties update [--404-document]
                                        [--account-key]
                                        [--account-name]
                                        [--auth-mode {key, login}]
                                        [--blob-endpoint]
                                        [--connection-string]
                                        [--delete-retention {false, true}]
                                        [--delete-retention-period]
                                        [--index-document]
                                        [--sas-token]
                                        [--static-website {false, true}]

Examples

Update the properties of a storage account's datalake service

az storage fs service-properties update --delete-retention --delete-retention-period 7 --account-name mystorageccount --account-key 00000000

Optional Parameters

--404-document

Represent the path to the error document that should be shown when an error 404 is issued, in other words, when a browser requests a page that does not exist.

--account-key

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

--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.

--auth-mode

The mode in which to run the command. "login" mode will directly use your login credentials for the authentication. The legacy "key" mode will attempt to query for an account key if no authentication parameters for the account are provided. Environment variable: AZURE_STORAGE_AUTH_MODE.

Accepted values: key, login
--blob-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.

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

--delete-retention

Enable soft-delete.

Accepted values: false, true
--delete-retention-period --period

Number of days that soft-deleted fs will be retained. Must be in range [1,365].

--index-document

Represent the name of the index document. This is commonly "index.html".

--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.

--static-website

Enable static-website.

Accepted values: false, true
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.