Настройка метаданных файла
Операция Set File Metadata задает пользовательские метаданные для указанного файла. Эта операция поддерживается в версии 2025-05-05 и более поздних версий для общих папок с включенным протоколом NFS.
Доступность протокола
| Протокол общей папки с включенным доступом | Доступный |
|---|---|
| SMB |
|
| NFS |
|
Просьба
Запрос Set File Metadata создается следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | URI запроса | ВЕРСИЯ HTTP |
|---|---|---|
| КЛАСТЬ | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
HTTP/1.1 |
Замените компоненты пути, отображаемые в URI запроса собственным, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя общей папки. |
mydirectorypath |
Необязательный. Путь к родительскому каталогу. |
myfile |
Имя файла. |
Сведения об ограничениях именования путей см. в разделе Имя и справочные ресурсы, каталоги, файлы и метаданные.
Параметры URI
В URI запроса можно указать следующие дополнительные параметры:
| Параметр | Описание |
|---|---|
timeout |
Необязательный. Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания операций службы файлов. |
Заголовки запросов
Обязательные и необязательные заголовки запросов описаны в следующих таблицах:
Общие заголовки запросов
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательно. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к службе хранилища Azure. |
Date или x-ms-date |
Обязательно. Указывает универсальное время (UTC) для запроса. Дополнительные сведения см. в статье Авторизация запросов к службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Указывает версию операции, используемой для этого запроса. Эта операция поддерживается в версии 2025-05-05 и более поздних версий для общих папок с включенным протоколом NFS. Дополнительные сведения см. в разделе Управление версиями служб хранилища Azure. |
x-ms-meta-name:value |
Необязательный. Задает пару "имя-значение" для файла. Каждый вызов этой операции заменяет все существующие метаданные, подключенные к файлу. Чтобы удалить все метаданные из файла, вызовите эту операцию без заголовков метаданных. Имена метаданных должны соответствовать правилам именования для идентификаторов C#. |
x-ms-lease-id:<ID> |
Требуется, если файл имеет активную аренду. Доступно для версии 2019-02-02 и более поздних версий. Этот заголовок игнорируется, если файл находится в общей папке с включенным протоколом NFS, который не поддерживает аренду файлов. |
x-ms-client-request-id |
Необязательный. Предоставляет созданное клиентом непрозрачное значение с ограничением символов 1-kibibyte (KiB), записанным в журналах при настройке ведения журнала. Настоятельно рекомендуется использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в статье Monitor Azure Files. |
x-ms-file-request-intent |
Требуется, если заголовок Authorization указывает токен OAuth. Допустимое значение равно backup. Этот заголовок указывает, что Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action или Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action следует предоставить, если они включены в политику RBAC, назначенную удостоверению, авторизованному с помощью заголовка Authorization. Доступно для версии 2022-11-02 и более поздних версий. |
x-ms-allow-trailing-dot: { <Boolean> } |
Необязательный. Версия 2022-11-02 и более поздних версий. Логическое значение указывает, следует ли обрезать конечную точку в URL-адресе запроса. Этот заголовок игнорируется, если целевой объект находится в общей папке с включенным протоколом NFS, который поддерживает конечную точку по умолчанию. Дополнительные сведения см. в разделе Именование и ссылки на общие папки, каталоги, файлы и метаданные. |
Только заголовки запросов SMB
Никакой.
Только заголовки запросов NFS
Никакой.
Текст запроса
Никакой.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК). Сведения о кодах состояния см. в коды состояния и коды ошибок.
Заголовки ответа
Ответ для этой операции содержит заголовки в следующих таблицах. Ответ также может включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
Общие заголовки ответов
| Заголовок ответа | Описание |
|---|---|
ETag |
Содержит значение, представляющее версию файла. Значение заключено в кавычки. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос и может использоваться для устранения неполадок запроса. Дополнительные сведения см. в статье Устранение неполадок с операциями API. |
x-ms-version |
Указывает версию службы файлов, которая использовалась для выполнения запроса. |
Date или x-ms-date |
Значение даты и времени в формате UTC, созданное службой, указывающее время, когда был инициирован ответ. |
x-ms-request-server-encrypted: true/false |
Версия 2017-04-17 и более поздних версий. Для этого заголовка задано значение true, если содержимое запроса успешно зашифровано с помощью указанного алгоритма. В противном случае значение равно false. |
x-ms-client-request-id |
Можно использовать для устранения неполадок запросов и соответствующих ответов. Значение этого заголовка равно значению заголовка x-ms-client-request-id, если оно присутствует в запросе, а значение содержит не более 1024 видимых символов ASCII. Если в запросе отсутствует заголовок x-ms-client-request-id, он не будет присутствовать в ответе. |
Заголовки ответов SMB только
Никакой.
Заголовки ответов NFS только
Никакой.
Текст ответа
Никакой.
Авторизация
Только владелец учетной записи может вызвать эту операцию.
Замечания
Set File Metadata не поддерживается в моментальном снимке общего ресурса, который является копией общего ресурса только для чтения. Попытка выполнить эту операцию на моментальном снимке общего ресурса завершается ошибкой 400 (InvalidQueryParameterValue)
Если файл имеет активную аренду, клиент должен указать действительный идентификатор аренды для запроса, чтобы записать метаданные в файл. Если клиент не указывает идентификатор аренды или указывает недопустимый идентификатор аренды, служба файлов возвращает код состояния 412 (сбой предварительных условий). Если клиент задает идентификатор аренды, но файл не имеет активной аренды, служба файлов также возвращает код состояния 412 (сбой предварительных условий).