Установка свойств файла
Операция Set File Properties задает системные свойства для файла.
Доступность протокола
| Включенный протокол общей папки | Доступно |
|---|---|
| SMB |  |
| NFS |  |
Запрос
Запрос Set File Properties можно составить следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties |
HTTP/1.1 |
Замените компоненты пути, показанный в URI запроса, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
mydirectorypath |
Необязательный элемент. Родительский каталог файла. |
myfile |
Имя файла. |
Сведения об ограничениях именования путей см. в статье Имя и ссылочные общие папки, каталоги, файлы и метаданные.
Параметры универсального кода ресурса (URI)
В URI запроса можно указать следующие дополнительные параметры:
| Параметр | Описание |
|---|---|
timeout |
Необязательный элемент. Параметр timeout указывается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы файлов. |
Заголовки запросов
Обязательные и необязательные заголовки запросов описаны в следующей таблице:
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-cache-control |
Необязательный элемент. Изменяет строку управления кэшем для файла. Если это свойство не указано в запросе, свойство очищается для файла. Последующие вызовы Get File Properties не возвращают это свойство, если оно не будет явно задано для файла снова. |
x-ms-content-type |
Необязательный элемент. Задает тип содержимого файла. Если это свойство не указано в запросе, свойство очищается для файла. Последующие вызовы Get File Properties не возвращают это свойство, если оно не будет явно задано для файла снова. |
x-ms-content-md5 |
Необязательный элемент. Задает хэш MD5 файла. Если это свойство не указано в запросе, свойство очищается для файла. Последующие вызовы Get File Properties не возвращают это свойство, если оно не будет явно задано для файла снова. |
x-ms-content-encoding |
Необязательный элемент. Задает кодировку содержимого файла. Если это свойство не указано в запросе, свойство очищается для файла. Последующие вызовы Get File Properties не возвращают это свойство, если оно не будет явно задано для файла снова. |
x-ms-content-language |
Необязательный элемент. Задает язык содержимого файла. Если это свойство не указано в запросе, свойство очищается для файла. Последующие вызовы Get File Properties не возвращают это свойство, если оно не будет явно задано для файла снова. |
x-ms-content-disposition |
Необязательный элемент. Задает заголовок файла Content-Disposition .Если это свойство не указано в запросе, свойство очищается для файла. Последующие вызовы Get File Properties не возвращают это свойство, если оно не будет явно задано для файла снова. |
x-ms-content-length: bytes |
Необязательный элемент. Изменяет размер файла на указанный. Если указанное байтовое значение меньше текущего размера файла, все диапазоны выше указанного байтового значения удаляются. |
x-ms-file-permission: { preserve ¦ <SDDL> } |
В версиях с 2019-02-02 по 2021-04-10 этот заголовок является обязательным, если x-ms-file-permission-key не указан. Начиная с версии 2021-06-08 оба заголовка являются необязательными. Это разрешение является дескриптором безопасности для файла, указанного на языке определения дескриптора безопасности (SDDL). Этот заголовок можно использовать, если размер разрешений составляет 8 кибибайт (КиБ) или меньше. В противном случае можно использовать x-ms-file-permission-key. Если он указан, он должен иметь владельца, группу и дискреционный список управления доступом (DACL). Чтобы сохранить существующее значение без изменений, можно передать значение preserve .Примечание. Можно указать или x-ms-file-permissionx-ms-file-permission-key. Если ни заголовок не указан, используется значение preserve по умолчанию . |
x-ms-file-permission-key: <PermissionKey> |
В версиях с 2019-02-02 по 2021-04-10 этот заголовок является обязательным, если x-ms-file-permission не указан. Начиная с версии 2021-06-08 оба заголовка являются необязательными. Ключ разрешения, устанавливаемого для файла. Его можно создать с помощью Create-Permission API.Примечание. Можно указать или x-ms-file-permissionx-ms-file-permission-key. Если ни заголовок не указан, для заголовка preserve используется x-ms-file-permission значение по умолчанию . |
x-ms-file-attributes: { preserve ¦ <FileAttributeList> } |
Обязательный, с версии 2019-02-02 по 2021-04-10. Необязательно, версия 2021-06-08 и более поздние. Атрибуты файловой системы, которые необходимо задать в файле. См. список доступных атрибутов. Чтобы сохранить существующее значение без изменений, можно передать значение preserve . Значение по умолчанию — preserve. |
x-ms-file-creation-time: { preserve ¦ <DateTime> } |
Обязательный, с версии 2019-02-02 по 2021-04-10. Необязательно, версия 2021-06-08 и более поздние. Свойство времени создания в формате UTC для файла. Чтобы сохранить существующее значение без изменений, можно передать значение preserve . Значение по умолчанию — preserve. |
x-ms-file-last-write-time: { preserve ¦ <DateTime> } |
Обязательный, с версии 2019-02-02 по 2021-04-10. Необязательно, версия 2021-06-08 и более поздние. Свойство последней записи в формате UTC для файла. Чтобы сохранить существующее значение без изменений, можно передать значение preserve . Если preserve указан параметр и размер файла изменяется, время последней записи обновляется до текущего времени. Если размер файла изменяется, но указана явная метка времени, используется явная метка времени. Значение по умолчанию — preserve. |
x-ms-lease-id: <ID> |
Требуется, если файл имеет активную аренду. Доступно для версии 2019-02-02 и более поздних версий. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Файлы Azure. |
x-ms-file-change-time: { now ¦ <DateTime> } |
Необязательный элемент. Версия 08.06.2021 и более поздняя. Свойство времени изменения в формате UTC для файла в формате ISO 8601. Для указания времени запроса можно использовать значение now . Значение по умолчанию — now. |
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 |
Содержит значение, представляющее версию файла. Значение заключено в кавычки. |
Last-Modified |
Возвращает дату и время последнего изменения файла. Дата в формате согласно RFC 1123. Дополнительные сведения см. в разделе Представление значений даты и времени в заголовках. Любая операция, изменяющая каталог или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения каталога. |
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-file-permission-key |
Версия 2019-02-02 и более поздние версии. Ключ разрешения файла. |
x-ms-file-attributes |
Версия 2019-02-02 и более поздние версии. Атрибуты файловой системы в файле. Дополнительные сведения см. в списке доступных атрибутов. |
x-ms-file-creation-time |
Версия 2019-02-02 и более поздние версии. Значение даты и времени в формате UTC, представляющее свойство времени создания для файла. |
x-ms-file-last-write-time |
Версия 2019-02-02 и более поздние версии. Значение даты и времени в формате UTC, представляющее свойство времени последней записи для файла. |
x-ms-file-change-time |
Версия 2019-02-02 и более поздние версии. Значение даты и времени в формате UTC, представляющее свойство времени изменения для файла. |
x-ms-client-request-id |
Может использоваться для устранения неполадок запросов и соответствующих ответов. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, он не будет присутствовать в ответе. |
Текст ответа
Нет.
Авторизация
Вызов этой операции доступен только владельцу учетной записи.
Атрибуты файловой системы
| attribute | Атрибут файла Win32 | Определение |
|---|---|---|
| Только для чтения | FILE_ATTRIBUTE_READONLY | Файл, доступный только для чтения. Приложения могут считывать файл, но не могут записывать в него или удалять его. |
| Скрытый | FILE_ATTRIBUTE_HIDDEN | Файл скрыт. Он не включен в обычный список каталогов. |
| Система | FILE_ATTRIBUTE_SYSTEM | Файл, часть или который используется исключительно операционной системой. |
| Нет | FILE_ATTRIBUTE_NORMAL | Файл, для которых не заданы другие атрибуты. Этот атрибут действителен только в том случае, если он используется отдельно. |
| Архив | FILE_ATTRIBUTE_ARCHIVE | Файл, который является архивным файлом. Приложения обычно используют этот атрибут для пометки файлов для резервного копирования или удаления. |
| Временный диск | FILE_ATTRIBUTE_TEMPORARY | Файл, используемый для временного хранения. |
| Автономная миграция | FILE_ATTRIBUTE_OFFLINE | Данные файла доступны не сразу. Этот атрибут файловой системы представлен в первую очередь для обеспечения совместимости с Windows. Файлы Azure не поддерживает варианты автономного хранилища. |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Файл не должен индексироваться службой индексирования содержимого. |
| NoScrubData | FILE_ATTRIBUTE_NO_SCRUB_DATA | Поток данных пользователя не должен считываться сканером целостности фоновых данных. Этот атрибут файловой системы представлен в первую очередь для обеспечения совместимости с Windows. |
Комментарии
Семантика обновления свойств файла следующая.
Размер файла изменяется, только если в запросе задано значение заголовка
x-ms-content-length.Если запрос задает только
x-ms-content-lengthи другие свойства, другие свойства файла не изменяются.Если в запросе задано одно или несколько следующих свойств, все эти свойства задаются вместе. Если для указанного свойства не указано значение, если задано хотя бы одно из следующих свойств, это свойство очищается для файла.
x-ms-cache-controlx-ms-content-typex-ms-content-md5x-ms-content-encodingx-ms-content-language
Примечание
Предыдущие свойства файла отделены от свойств файловой системы, доступных клиентам SMB. Клиенты SMB не могут читать, записывать или изменять эти значения свойств.
Set File propertiesне поддерживается в общей snapshot, которая является копией общего ресурса только для чтения. Попытка выполнить эту операцию с общей snapshot завершается ошибкой 400 (InvalidQueryParameterValue).
Если файл имеет активную аренду, клиент должен указать действительный идентификатор аренды в запросе на запись свойств в файл. Если клиент не указывает идентификатор аренды или указывает недопустимый идентификатор аренды, служба файлов возвращает код состояния 412 (сбой предварительного условия). Если клиент указывает идентификатор аренды, но файл не имеет активной аренды, служба файлов также возвращает код состояния 412 (сбой предварительного условия).