Переименование файла
Операция Rename File переименовывает файл и может при необходимости задать системные свойства файла. Этот API доступен начиная с версии 2021-04-10.
Доступность протокола
| Включенный протокол общей папки | Доступно |
|---|---|
| SMB |  |
| NFS |  |
Запрос
Запрос Rename File можно составить следующим образом. Рекомендуется использовать протокол HTTPS.
| Метод | Универсальный код ресурса (URI) запроса | Версия HTTP |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Замените компоненты пути, показанный в URI запроса, следующим образом:
| Компонент пути | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
mydirectorypath |
Необязательный элемент. Путь к родительскому целевому каталогу. |
myfile |
Имя конечного файла. |
Дополнительные сведения об ограничениях именования путей см. в разделе Именование и ссылка на общие папки, каталоги, файлы и метаданные.
Параметры универсального кода ресурса (URI)
В URI запроса могут быть заданы следующие дополнительные параметры.
| Параметр | Описание |
|---|---|
timeout |
Необязательный элемент. Параметр timeout указывается в секундах. Дополнительные сведения см. в разделе "Настройка времени ожидания" для операций службы файлов. |
Заголовки запросов
В следующей таблице перечислены обязательные и необязательные заголовки запросов.
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в разделе "Авторизация запросов к служба хранилища Azure". |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в разделе "Авторизация запросов к служба хранилища Azure". |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе "Управление версиями" для служб служба хранилища Azure. |
x-ms-file-rename-source:name |
Обязательный. Имя файла, который необходимо переименовать. |
x-ms-file-rename-replace-if-exists |
Необязательный элемент. Если целевой файл уже существует, перезапишите файл. |
x-ms-file-ignore-readonly |
Необязательный элемент. Если целевой файл существует с атрибутом readonly, перезапишите файл. Если значение равно true, x-ms-replace-if-exists также должно быть true. |
x-ms-content-Type |
Необязательный элемент. Задает тип содержимого файла. Если это свойство не указано в запросе, свойство будет сохранено для файла. |
x-ms-file-permission |
Необязательный, если x-ms-file-permission-key не указан. Это разрешение является дескриптором безопасности для файла, указанного в языке определения дескриптора безопасности (SDDL). Этот заголовок можно использовать, если размер разрешений превышает 8 КиБ, в противном случае x-ms-file-permission-key его можно использовать. Если он указан, он должен иметь список управления доступом владельца, группы и дискреционного доступа (DACL). Значение 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-source-lease-id:<ID> |
Требуется, если исходный файл имеет активную аренду. |
x-ms-destination-lease-id:<ID> |
Требуется, если целевой файл имеет активную аренду. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением на 1 КиБ, которое записывается в журналы аналитики при включении ведения журнала аналитики хранилища. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления операций на стороне клиента с запросами, которые получает сервер. Дополнительные сведения см. в статье "Мониторинг хранилища BLOB-объектов Azure". |
x-ms-meta-name:value |
Необязательный элемент. Задает пары "имя-значение" для файла. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к файлу. Имена метаданных должны соответствовать правилам именования для C# идентификаторов. |
Текст запроса
Нет.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Дополнительные сведения о кодах состояния см. в разделе "Коды состояния" и "Коды ошибок".
Заголовки ответов
Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
| Заголовок ответа | Описание |
|---|---|
ETag |
ETag содержит значение в кавычках, представляющее версию файла. |
Last-Modified |
Возвращает дату и время последнего изменения файла. Дата в формате согласно RFC 1123. Дополнительные сведения см. в разделе "Представление значений Date-Time" в заголовках. Любая операция, которая изменяет каталог или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения каталога. |
x-ms-request-id |
Этот заголовок однозначно определяет выполненный запрос, его также можно использовать для устранения связанных с запросом неполадок. Дополнительные сведения см. в разделе "Устранение неполадок операций API". |
x-ms-version |
Указывает версию службы файлов, используемую для выполнения запроса. |
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 | Файл, доступный только для чтения. Приложения могут считывать файл, но не могут записывать в него или удалять его. |
| Скрытый | FILE_ATTRIBUTE_HIDDEN | Файл скрыт. Он не включен в обычный список каталогов. |
| Система | FILE_ATTRIBUTE_SYSTEM | Файл, который операционная система использует часть или использует исключительно. |
| Нет | FILE_ATTRIBUTE_NORMAL | Файл, который не имеет других атрибутов. Этот атрибут действителен только при использовании в одиночку. |
| Archive | FILE_ATTRIBUTE_ARCHIVE | Файл, который является архивным файлом. Приложения обычно используют этот атрибут для пометки файлов для резервного копирования или удаления. |
| Временные таблицы | FILE_ATTRIBUTE_TEMPORARY | Файл, используемый для временного хранилища. |
| Автономная миграция | FILE_ATTRIBUTE_OFFLINE | Данные файла недоступны немедленно. Этот атрибут файловой системы представлен в основном для обеспечения совместимости с Windows . Файлы Azure не поддерживает параметры автономного хранилища. |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Файл не индексируется службой индексирования содержимого. |
| NoScrubData | FILE_ATTRIBUTE_NO_SCRUB_DATA | Поток данных пользователя, который не будет считываться сканером целостности фоновых данных. Этот атрибут файловой системы представлен в основном для обеспечения совместимости с Windows. |
Remarks
Целевой объект не может быть существующим каталогом.
Если свойства не указаны, дефualt поведение preserve или now будет задано.
Примечание
Обратите внимание, что вышеперечисленные свойства файла отличаются от свойств файловой системы, доступных для клиентов SMB. Клиенты SMB не могут читать, записывать и изменять значения этих свойств.
Rename File не поддерживается в моментальном снимке общего ресурса, который является копией общей папки только для чтения. Попытка выполнить эту операцию на моментальном снимке общего ресурса завершится ошибкой 400 (InvalidQueryParameterValue).
Если файл имеет активную аренду, клиент должен указать действительный идентификатор аренды для запроса, чтобы переименовать файл. Если клиент не указывает идентификатор аренды или указывает недопустимый идентификатор аренды, служба файлов возвращает код состояния 412 (сбой предварительного условия). Если клиент указывает идентификатор аренды, но файл не имеет активной аренды, служба файлов также возвращает код состояния 412 (сбой предварительного условия).