Установка метаданных файла
Операция Set File Metadata задает пользовательские метаданные для указанного файла.
Доступность протокола
| Включенный протокол общей папки | Доступно |
|---|---|
| SMB |  |
| NFS |  |
Запрос
Запрос можно создать Set File Metadata следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
|---|---|---|
PUT |
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 |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-meta-name:value |
Необязательный элемент. Задает пары "имя-значение" для файла. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к файлу. Чтобы удалить все метаданные из файла, вызовите эту операцию без заголовков метаданных. Имена метаданных должны соответствовать правилам именования для идентификаторов C#. |
x-ms-lease-id:<ID> |
Требуется, если файл имеет активную аренду. Доступно для версии 2019-02-02 и более поздних версий. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Файлы Azure. |
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> } |
Необязательный элемент. Версия 02.11.2022 и более поздняя. Логическое значение указывает, следует ли обрезать завершающую точку в URL-адресе запроса. Дополнительные сведения см. в статье Именование общих папок, каталогов, файлов и метаданных и ссылки на нее. |
Текст запроса
Нет.
Ответ
Ответ включает код состояния 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 |
Версия 17.04.2017 и более поздняя. Если содержимое запроса успешно зашифровано с помощью указанного алгоритма, задается значение этого true заголовка. В противном случае задается значение false. |
x-ms-client-request-id |
Может использоваться для устранения неполадок запросов и соответствующих ответов. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, он не будет присутствовать в ответе. |
Текст ответа
Нет.
Авторизация
Вызов этой операции доступен только владельцу учетной записи.
Комментарии
Set File Metadataне поддерживается в общей snapshot, которая является копией общего ресурса только для чтения. Попытка выполнить эту операцию в общей snapshot завершается ошибкой 400 (InvalidQueryParameterValue)
Если файл имеет активную аренду, клиент должен указать действительный идентификатор аренды в запросе, чтобы записать метаданные в файл. Если клиент не указывает идентификатор аренды или задает недопустимый идентификатор аренды, служба файлов возвращает код состояния 412 (сбой условия). Если клиент указывает идентификатор аренды, но файл не имеет активной аренды, служба файлов также возвращает код состояния 412 (сбой предварительного условия).