Share via

az storage blob service-properties

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage storage blob service properties.

Commands

Name Description Type Status
az storage blob service-properties delete-policy

Manage storage blob delete-policy service properties.

 Core GA
az storage blob service-properties delete-policy show

Show the storage blob delete-policy.

 Core GA
az storage blob service-properties delete-policy update

Update the storage blob delete-policy.

 Core GA
az storage blob service-properties show

Gets the properties of a storage account's Blob service, including Azure Storage Analytics.

 Core GA
az storage blob service-properties update

Update storage blob service properties.

 Core GA
az storage blob service-properties update (storage-blob-preview extension)

Update storage blob service properties.

 Extension GA

az storage blob service-properties show

Edit

Gets the properties of a storage account's Blob service, including Azure Storage Analytics.

:keyword int timeout: Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob #other-client--per-operation-configuration>_. :returns: An object containing blob service properties such as analytics logging, hour/minute metrics, cors rules, etc. :rtype: Dict[str, Any] .. admonition:: Example: .. literalinclude:: ../samples/blob_samples_service.py :start-after: [START get_blob_service_properties] :end-before: [END get_blob_service_properties] :language: python :dedent: 8 :caption: Getting service properties for the blob service.

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

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 blob service-properties update

Edit

Update storage blob service properties.

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

Examples

Update storage blob service properties. (autogenerated)

az storage blob service-properties update --404-document error.html --account-name mystorageccount --account-key 00000000 --index-document index.html --static-website true

Optional Parameters

--404-document

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--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

Enables soft-delete.

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

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

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False
--index-document

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

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--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.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []
--static-website

Enables static-website.

Accepted values: false, true
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 blob service-properties update (storage-blob-preview extension)

Update storage blob service properties.

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

Examples

Update storage blob service properties. (autogenerated)

az storage blob service-properties update --404-document error.html --account-name mystorageccount --account-key 00000000 --index-document index.html --static-website true

Optional Parameters

--404-document

The absolute path of the custom 404 page.

--account-key

Storage account key. Must be used in conjunction with storage account name. 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.

--default-index-path
Preview

Absolute path of the default index page.

--delete-retention

Enables soft-delete.

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

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

--index-document

The default name of the index page under each directory.

--sas-token

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

--static-website

Enables static-website.

Accepted values: false, true
--timeout

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

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.