Переименование каталога
Операция Rename Directory переименовывает каталог и может при необходимости задать системные свойства для каталога. Этот API доступен в версии 2021-04-10 и более поздних.
Доступность протокола
| Включенный протокол общей папки | Доступно |
|---|---|
| SMB |  |
| NFS |  |
Запрос
Запрос можно создать Rename Directory следующим образом. Рекомендуется использовать протокол HTTPS.
| Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename |
HTTP/1.1 |
Замените компоненты пути, показанный в URI запроса, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
mydirectorypath |
Необязательный элемент. Родительский каталог файла. |
mydirectory |
Имя целевого каталога. |
Дополнительные сведения об ограничениях именования путей см. в статье Именование общих папок, каталогов, файлов и метаданных и ссылки на нее.
Параметры универсального кода ресурса (URI)
В URI запроса можно указать следующий дополнительный параметр.
| Параметр | Описание |
|---|---|
timeout |
Необязательный элемент. Параметр timeout указывается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для Файлы Azure операций. |
Заголовки запросов
В следующей таблице перечислены обязательные и необязательные заголовки запросов.
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-file-rename-source:name |
Обязательный. Полный универсальный код ресурса (URI) каталога, который требуется переименовать. |
x-ms-file-rename-ignore-readonly |
Необязательный элемент. Если целевой каталог существует с атрибутом readonly , перезапишите каталог.Если задано значение true, x-ms-file-rename-replace-if-exists то также должно быть true. |
x-ms-file-permission |
Необязательно, если x-ms-file-permission-key параметр не указан. Это разрешение является дескриптором безопасности для каталога, указанного на языке определения дескриптора безопасности (SDDL). Этот заголовок можно использовать, если размер разрешений составляет 8 кибибайт (КиБ) или меньше. В противном случае можно использовать x-ms-file-permission-key. Если этот параметр указан, это разрешение должно иметь список владельцев, групп и списков управления доступом на уровне пользователей. Если вы хотите сохранить существующее значение без изменений, можно передать значение preserve .Обратите внимание, что можно указать один или x-ms-file-permissionx-ms-file-permission-key, а не оба. |
x-ms-file-permission-key |
Необязательно, если x-ms-file-permission параметр не указан. Ключ разрешения, устанавливаемого для каталога. Его можно создать с помощью Create-Permission API.Обратите внимание, что можно указать один или x-ms-file-permissionx-ms-file-permission-key, а не оба. |
x-ms-file-attributes |
Необязательный элемент. Атрибуты файловой системы, которые необходимо задать в каталоге. См. список доступных атрибутов. Если вы хотите сохранить существующее значение без изменений, можно передать значение preserve . Если это свойство не указано в запросе, свойство будет сохранено. |
x-ms-file-creation-time |
Необязательный элемент. Свойство времени создания в формате UTC для каталога. Если вы хотите сохранить существующее значение без изменений, можно передать значение preserve . Если это свойство не указано в запросе, свойство будет сохранено. |
x-ms-file-last-write-time |
Необязательный элемент. Свойство последней записи в формате UTC для каталога. Если вы хотите сохранить существующее значение без изменений, можно передать значение preserve . Если это свойство не указано в запросе, свойство будет сохранено. |
x-ms-destination-lease-id:<ID> |
Требуется, если целевой файл имеет активную аренду. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 КиБ символов, которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Хранилище BLOB-объектов Azure. |
x-ms-meta-name:value |
Необязательный элемент. Задает пары "имя-значение" для каталога. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к каталогу. Имена метаданных должны соответствовать правилам именования для идентификаторов C#. Если это свойство не указано в запросе, свойство будет сохранено. |
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-адресе запроса. Дополнительные сведения см. в статье Именование общих папок, каталогов, файлов и метаданных и ссылки на нее. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Необязательный элемент. Версия 02.11.2022 и более поздняя. Логическое значение указывает, следует ли обрезать завершающую точку в исходном URL-адресе. Этот заголовок следует указывать только в том случае, если источник копирования является общей папкой Azure. Этот заголовок не поддерживается для любого другого типа источника копирования. Дополнительные сведения см. в статье Именование общих папок, каталогов, файлов и метаданных и ссылки на нее. |
Текст запроса
Нет.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК). Сведения о кодах состояния см. в разделе Коды состояния и ошибок.
Заголовки ответов
Ответ для этой операции включает следующие заголовки. Ответ также может содержать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
| Заголовок ответа | Описание |
|---|---|
ETag |
Содержит значение, представляющее версию файла в кавычках. |
Last-Modified |
Возвращает дату и время последнего изменения файла. Дополнительные сведения см. в разделе Представление значений даты и времени в заголовках. Любая операция, изменяющая каталог или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения каталога. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос и может использоваться для устранения неполадок с запросом. Дополнительные сведения см. в разделе Устранение неполадок с операциями API. |
x-ms-version |
Указывает версию Файлы Azure, используемую для выполнения запроса. |
Date или x-ms-date |
Значение даты и времени в формате UTC, указывающее время, когда был инициирован ответ. Служба создает это значение. |
x-ms-request-server-encrypted: true/false |
Значение этого заголовка устанавливается в , true если содержимое запроса успешно зашифровано с помощью указанного алгоритма. В противном случае задается значение false. |
x-ms-file-permission-key |
Ключ разрешения для файла. |
x-ms-file-attributes |
Атрибуты файловой системы в файле. См. список доступных атрибутов. |
x-ms-file-creation-time |
Значение даты и времени в формате UTC, представляющее свойство времени создания файла. |
x-ms-file-last-write-time |
Значение даты и времени в формате UTC, представляющее свойство времени последней записи для файла. |
x-ms-file-change-time |
Значение даты и времени в формате UTC, представляющее свойство времени изменения для файла. |
x-ms-file-file-id |
Идентификатор файла. |
x-ms-file-parent-id |
Идентификатор родительского файла. |
x-ms-client-request-id |
Может использоваться для устранения неполадок с запросами и соответствующими ответами. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе. Значение равно не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, он не будет присутствовать в ответе. |
Текст ответа
Нет.
Авторизация
Только владелец учетной записи может вызывать эту операцию.
Атрибуты файловой системы
| attribute | Атрибут файла Win32 | Определение |
|---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Каталог, доступный только для чтения. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Каталог скрыт. Он не включен в обычный список каталогов. |
System |
FILE_ATTRIBUTE_SYSTEM | Каталог, частью в котором операционная система используется или используется исключительно. |
None |
FILE_ATTRIBUTE_NORMAL | Каталог, в который не заданы другие атрибуты. Этот атрибут действителен только при использовании отдельно. |
Directory |
FILE_ATTRIBUTE_DIRECTORY | Дескриптор, идентифицирующий каталог. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Каталог, который является архивным каталогом. Приложения обычно используют этот атрибут для пометки файлов для резервного копирования или удаления. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Данные каталога доступны не сразу. Этот атрибут файловой системы представлен в первую очередь для обеспечения совместимости с Windows. Файлы Azure не поддерживает варианты автономного хранилища. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Каталог не должен индексироваться службой индексирования содержимого. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Поток данных пользователя не должен считываться сканером целостности данных в фоновом режиме. Этот атрибут файловой системы представлен в первую очередь для обеспечения совместимости с Windows. |
Комментарии
Если целевым объектом является каталог, каталог не должен существовать.
Rename Directoryне поддерживается в общей snapshot, которая является копией общего ресурса только для чтения. При попытке выполнить эту операцию в общей snapshot служба возвращает состояние ошибки 400 (недопустимое значение параметра запроса).
Если не указать свойства, будет задано preserve поведение по умолчанию или now .
Если каталог имеет активную аренду, клиент должен указать допустимый идентификатор аренды в запросе, чтобы переименовать каталог. Если клиент не указывает идентификатор аренды или задает недопустимый идентификатор аренды, Файлы Azure возвращает код состояния 412 (сбой предварительного условия). Если клиент указывает идентификатор аренды, но каталог не имеет активной аренды, Файлы Azure также возвращает код состояния 412 (сбой предварительного условия).