Задание свойств каталога
Операция Set Directory Properties задает системные свойства для указанного каталога. Этот API доступен в версии 2019-02-02.
Доступность протокола
| Протокол общей папки с включенным доступом | Доступный |
|---|---|
| SMB |
|
| NFS |
|
Просьба
Запрос Set Directory Properties может быть создан следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | URI запроса | ВЕРСИЯ HTTP |
|---|---|---|
| КЛАСТЬ | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=properties |
HTTP/1.1 |
Замените компоненты пути, отображаемые в URI запроса собственным, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя общей папки. |
mydirectorypath |
Необязательный. Путь к родительскому каталогу. |
mydirectory |
Имя файла. |
Сведения об ограничениях именования путей см. в разделе Имя и справочные ресурсы, каталоги, файлы и метаданные.
Параметры URI
В URI запроса можно указать следующие дополнительные параметры:
| Параметр | Описание |
|---|---|
timeout |
Необязательный. Параметр timeout выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания операций службы файлов. |
Заголовки запросов
Обязательные и необязательные заголовки запросов описаны в следующей таблице:
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательно. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к службе хранилища Azure. |
Date или x-ms-date |
Обязательно. Указывает универсальное время (UTC) для запроса. Дополнительные сведения см. в статье Авторизация запросов к службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Указывает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями служб хранилища Azure. |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
В версиях 2019-02-02–2021-04-10 этот заголовок требуется, если x-ms-file-permission-key не указан. По состоянию на версию 2021-06-08 оба заголовка являются необязательными. Это разрешение является дескриптором безопасности для каталога, указанного в x-ms-file-permission-format. Этот заголовок можно использовать, если размер разрешений составляет 8 кибибайт (KiB) или меньше. В противном случае можно использовать x-ms-file-permission-key. Если он указан, он должен иметь владельца, группу и список управления доступом (DACL). Чтобы сохранить существующее значение без изменений, можно передать значение preserve.примечание. Можно указать x-ms-file-permission или x-ms-file-permission-key. Если ни заголовок не указан, значение по умолчанию preserve используется для заголовка x-ms-file-permission. |
x-ms-file-permission-format: { sddl ¦ binary } |
Необязательный. Версия 2024-11-04 или более поздняя. Указывает, является ли значение, переданное в x-ms-file-permission, в SDDL или в двоичном формате. Если x-ms-file-permission-key задано значение preserve, этот заголовок не должен быть задан. Если x-ms-file-permission-key задано любое другое значение, отличное от preserve, и если этот заголовок не задан, используется значение по умолчанию sddl. |
x-ms-file-permission-key: <PermissionKey> |
В версиях 2019-02-02–2021-04-10 этот заголовок требуется, если x-ms-file-permission не указан. По состоянию на версию 2021-06-08 оба заголовка являются необязательными. Ключ разрешения, заданного для файла. Это можно создать с помощью API Create-Permission.примечание. Можно указать x-ms-file-permission или x-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. |
x-ms-client-request-id |
Необязательный. Предоставляет созданное клиентом непрозрачное значение с ограничением символов 1-kibibyte (KiB), записанным в журналах при настройке ведения журнала. Настоятельно рекомендуется использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в статье Monitor Azure Files. |
x-ms-file-change-time: { now ¦ <DateTime> } |
Необязательный. Версия 2021-06-08 и более поздних версий. Свойство времени изменения координированного универсального времени (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> } |
Необязательный. Версия 2022-11-02 и более поздних версий. Логическое значение указывает, следует ли обрезать конечную точку в 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 |
Версия 2017-04-17 и более поздних версий. Для этого заголовка задано значение 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, он не будет присутствовать в ответе. |
Текст ответа
Никакой.
Авторизация
Только владелец учетной записи может вызвать эту операцию.
Атрибуты файловой системы
| Атрибут | Атрибут файла Win32 | Определение |
|---|---|---|
| ReadOnly | FILE_ATTRIBUTE_READONLY | Каталог, доступный только для чтения. |
| Скрытый | FILE_ATTRIBUTE_HIDDEN | Каталог скрыт. Он не включен в обычный список каталогов. |
| Система | FILE_ATTRIBUTE_SYSTEM | Каталог, который операционная система использует часть или использует исключительно. |
| Никакой | FILE_ATTRIBUTE_NORMAL | Каталог, который не имеет других атрибутов. Этот атрибут действителен только в том случае, если он используется отдельно. |
| Каталог | FILE_ATTRIBUTE_DIRECTORY | Дескриптор, определяющий каталог. |
| Архив | FILE_ATTRIBUTE_ARCHIVE | Каталог, который является архивным каталогом. Приложения обычно используют этот атрибут для пометки файлов для резервного копирования или удаления. |
| Автономный | FILE_ATTRIBUTE_OFFLINE | Данные каталога недоступны сразу. Этот атрибут файловой системы представлен в основном для обеспечения совместимости с Windows. Файлы Azure не поддерживают параметры автономного хранилища. |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Каталог не индексируется службой индексирования содержимого. |
| NoScrubData | FILE_ATTRIBUTE_NO_SCRUB_DATA | Поток данных пользователя не считывается с помощью средства проверки целостности фоновых данных. Этот атрибут файловой системы представлен в основном для обеспечения совместимости с Windows. |
Замечания
Set Directory Properties не поддерживается в моментальном снимке общего ресурса, который является копией общего ресурса только для чтения. Попытка выполнить эту операцию на моментальном снимке общего ресурса завершается ошибкой 400 (InvalidQueryParameterValue).
Свойства, заданные в каталоге с Set Directory Properties не распространяются в подкаталогах под этим каталогом. Необходимо вызвать Set Directory Properties для каждого каталога, для которого требуется обновить свойства.