你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az storage file metadata

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展，使其受益于其扩展功能。 详细了解扩展。

管理文件元数据。

命令

名称	说明	类型	Status
az storage file metadata show	返回文件的所有用户定义的元数据。	核心	GA
az storage file metadata show (storage-preview 扩展)	返回文件的所有用户定义的元数据。	扩展	GA
az storage file metadata update	更新文件元数据。	核心	GA
az storage file metadata update (storage-preview 扩展)	更新文件元数据。	扩展	GA

az storage file metadata show

返回文件的所有用户定义的元数据。

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

示例

显示文件的元数据

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

必需参数

--path -p

文件共享中文件的路径。

--share-name -s

文件共享名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

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

用于文件 OAuth （Azure AD） 身份验证所需的参数。 这将根据允许的数据操作绕过任何文件/目录级别权限检查并允许访问，即使这些文件/目录存在 ACL。

默认值: False

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--disallow-trailing-dot

如果为 true，将从目标 URI 中剪裁尾随点。 默认值为 False。

接受的值: false, true

默认值: False

--file-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_SERVICE_ENDPOINT。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--snapshot

表示快照版本的字符串（如果适用）。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage file metadata show (storage-preview 扩展)

返回文件的所有用户定义的元数据。

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

示例

显示文件的元数据

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

必需参数

--path -p

文件共享中文件的路径。

--share-name -s

文件共享名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

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

用于文件 OAuth （Azure AD） 身份验证所需的参数。 这将根据允许的数据操作绕过任何文件/目录级别权限检查并允许访问，即使这些文件/目录存在 ACL。

默认值: False

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--disallow-trailing-dot

如果为 true，将从目标 URI 中剪裁尾随点。 默认值为 False。

接受的值: false, true

默认值: False

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--snapshot

表示快照版本的字符串（如果适用）。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage file metadata update

更新文件元数据。

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

示例

更新文件的元数据

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

必需参数

--path -p

文件共享中文件的路径。

--share-name -s

文件共享名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

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

用于文件 OAuth （Azure AD） 身份验证所需的参数。 这将根据允许的数据操作绕过任何文件/目录级别权限检查并允许访问，即使这些文件/目录存在 ACL。

默认值: False

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--disallow-trailing-dot

如果为 true，将从目标 URI 中剪裁尾随点。 默认值为 False。

接受的值: false, true

默认值: False

--file-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_SERVICE_ENDPOINT。

--metadata

空格分隔键=值对中的元数据。 这会覆盖任何现有元数据。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage file metadata update (storage-preview 扩展)

更新文件元数据。

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

示例

更新文件的元数据

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

必需参数

--path -p

文件共享中文件的路径。

--share-name -s

文件共享名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

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

用于文件 OAuth （Azure AD） 身份验证所需的参数。 这将根据允许的数据操作绕过任何文件/目录级别权限检查并允许访问，即使这些文件/目录存在 ACL。

默认值: False

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--disallow-trailing-dot

如果为 true，将从目标 URI 中剪裁尾随点。 默认值为 False。

接受的值: false, true

默认值: False

--metadata

空格分隔键=值对中的元数据。 这会覆盖任何现有元数据。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。