az storage file metadata

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

Commands

Name	Description	Type	Status
az storage file metadata show	Return all user-defined metadata for the file.	Core	GA
az storage file metadata show (storage-preview extension)	Return all user-defined metadata for the file.	Extension	GA
az storage file metadata update	Update file metadata.	Core	GA
az storage file metadata update (storage-preview extension)	Update file metadata.	Extension	GA

az storage file metadata show

Return all user-defined metadata for the file.

az storage file metadata show --path
                              --share-name
                              [--account-key]
                              [--account-name]
                              [--auth-mode {key, login}]
                              [--backup-intent --enable-file-backup-request-intent]
                              [--connection-string]
                              [--disallow-trailing-dot {false, true}]
                              [--file-endpoint]
                              [--sas-token]
                              [--snapshot]
                              [--timeout]

Examples

Show metadata for the file

az storage file metadata show -s MyShare --path /path/to/file

Required Parameters

--path -p

The path to the file within the file share.

--share-name -s

The file share name.

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

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

Property	Value
Accepted values:	key, login

--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property	Value
Default value:	False

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property	Value
Default value:	False
Accepted values:	false, true

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

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

--snapshot

A string that represents the snapshot version, if applicable.

--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 file metadata show (storage-preview extension)

Return all user-defined metadata for the file.

az storage file metadata show --path
                              --share-name
                              [--account-key]
                              [--account-name]
                              [--auth-mode {key, login}]
                              [--backup-intent --enable-file-backup-request-intent]
                              [--connection-string]
                              [--disallow-trailing-dot {false, true}]
                              [--sas-token]
                              [--snapshot]
                              [--timeout]

Examples

Show metadata for the file

az storage file metadata show -s MyShare --path /path/to/file

Required Parameters

--path -p

The path to the file within the file share.

--share-name -s

The file share name.

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

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

Property	Value
Accepted values:	key, login

--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property	Value
Default value:	False

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property	Value
Default value:	False
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

--snapshot

A string that represents the snapshot version, if applicable.

--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 file metadata update

Update file metadata.

az storage file metadata update --path
                                --share-name
                                [--account-key]
                                [--account-name]
                                [--auth-mode {key, login}]
                                [--backup-intent --enable-file-backup-request-intent]
                                [--connection-string]
                                [--disallow-trailing-dot {false, true}]
                                [--file-endpoint]
                                [--metadata]
                                [--sas-token]
                                [--timeout]

Examples

Update metadata for the file

az storage file metadata update -s MyShare --path /path/to/file --metadata key1=value1

Required Parameters

--path -p

The path to the file within the file share.

--share-name -s

The file share name.

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

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

Property	Value
Accepted values:	key, login

--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property	Value
Default value:	False

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property	Value
Default value:	False
Accepted values:	false, true

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

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

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

--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 file metadata update (storage-preview extension)

Update file metadata.

az storage file metadata update --path
                                --share-name
                                [--account-key]
                                [--account-name]
                                [--auth-mode {key, login}]
                                [--backup-intent --enable-file-backup-request-intent]
                                [--connection-string]
                                [--disallow-trailing-dot {false, true}]
                                [--metadata]
                                [--sas-token]
                                [--timeout]

Examples

Update metadata for the file

az storage file metadata update -s MyShare --path /path/to/file --metadata key1=value1

Required Parameters

--path -p

The path to the file within the file share.

--share-name -s

The file share name.

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

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

Property	Value
Accepted values:	key, login

--backup-intent --enable-file-backup-request-intent

Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.

Property	Value
Default value:	False

--connection-string

Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.

Property	Value
Parameter group:	Storage Account Arguments

--disallow-trailing-dot

If true, the trailing dot will be trimmed from the target URI. Default to False.

Property	Value
Default value:	False
Accepted values:	false, true

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

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