Переименование файла
Операция Rename File переименовывает файл и может при необходимости задать системные свойства для файла. Этот API доступен в версии 2021-04-10 и более поздних версиях.
Доступность протокола
| Протокол общей папки с включенным доступом | Доступный |
|---|---|
| SMB |
|
| NFS |
|
Просьба
Можно создать запрос Rename File следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | URI запроса | ВЕРСИЯ HTTP |
|---|---|---|
| КЛАСТЬ | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Замените компоненты пути, отображаемые в URI запроса собственным, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя общей папки. |
mydirectorypath |
Необязательный. Путь к родительскому целевому каталогу. |
myfile |
Имя целевого файла. |
Дополнительные сведения об ограничениях именования путей см. в разделе Именование и ссылка на общие папки, каталоги, файлы и метаданные.
Параметры 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-replace-if-exists |
Необязательный. Если целевой файл уже существует, перезапись файла. |
x-ms-file-rename-ignore-readonly |
Необязательный. Если целевой файл существует с атрибутом readonly, перезаписать файл.Если значение true, x-ms-file-rename-replace-if-exists также должно быть true. |
x-ms-content-Type |
Необязательный. Задает тип контента файла. Если это свойство не указано в запросе, то свойство будет сохранено для файла. |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
Необязательный параметр, если x-ms-file-permission-key не указан. Это разрешение является дескриптором безопасности для файла, указанного в x-ms-file-permission-format. Этот заголовок можно использовать, если размер разрешений составляет 8 кибибайт (KiB) или меньше. В противном случае можно использовать x-ms-file-permission-key. Если указано, это разрешение должно иметь владельца, группу и список управления доступом,. Можно передать значение preserve, если вы хотите сохранить существующее значение без изменений.Обратите внимание, что можно указать x-ms-file-permission или x-ms-file-permission-key, а не оба. |
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 |
Необязательный параметр, если x-ms-file-permission не указан. Ключ разрешения, заданного для файла. Это можно создать с помощью API Create-Permission.Обратите внимание, что можно указать x-ms-file-permission или x-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-kibibyte (KiB), записанным в журналах при настройке ведения журнала. Настоятельно рекомендуется использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в статье Monitorхранилища 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> } |
Необязательный. Версия 2022-11-02 и более поздних версий. Логическое значение указывает, следует ли обрезать конечную точку в URL-адресе запроса. Дополнительные сведения см. в разделе Именование и ссылки на общие папки, каталоги, файлы и метаданные. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Необязательный. Версия 2022-11-02 и более поздних версий. Логическое значение указывает, следует ли обрезать конечную точку в исходном 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, он не будет присутствовать в ответе. |
Текст ответа
Никакой.
Авторизация
Только владелец учетной записи может вызвать эту операцию.
Атрибуты файловой системы
| Атрибут | Атрибут файла Win32 | Определение |
|---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Файл, доступный только для чтения. Приложения могут считывать файл, но не могут записывать в него или удалять его. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Файл скрыт. Он не включен в обычный список каталогов. |
System |
FILE_ATTRIBUTE_SYSTEM | Файл, который операционная система использует часть или использует исключительно. |
None |
FILE_ATTRIBUTE_NORMAL | Файл, который не имеет других атрибутов. Этот атрибут действителен только при использовании в одиночку. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Файл, который является архивным файлом. Приложения обычно используют этот атрибут для пометки файлов для резервного копирования или удаления. |
Temporary |
FILE_ATTRIBUTE_TEMPORARY | Файл, используемый для временного хранилища. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Данные файла недоступны немедленно. Этот атрибут файловой системы представлен в основном для обеспечения совместимости с Windows. Файлы Azure не поддерживаются с параметрами автономного хранилища. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Файл не индексируется службой индексирования содержимого. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Поток данных пользователя не считывается с помощью средства проверки целостности фоновых данных. Этот атрибут файловой системы представлен в основном для обеспечения совместимости с Windows. |
Замечания
Целевой объект не может быть существующим каталогом.
Если вы не указываете свойства, будет задано поведение по умолчанию preserve или now.
Заметка
Предыдущие свойства файла дискретны из свойств файловой системы, доступных клиентам SMB. Клиенты SMB не могут считывать, записывать или изменять эти значения свойств.
Rename File не поддерживается в моментальном снимке общего ресурса, который является копией общего ресурса только для чтения. При попытке выполнить эту операцию на моментальном снимке общего ресурса служба возвращает состояние ошибки 400 (недопустимое значение параметра запроса).
Если файл имеет активную аренду, клиент должен указать действительный идентификатор аренды для запроса, чтобы переименовать файл. Если клиент не указывает идентификатор аренды или указывает недопустимый идентификатор аренды, Служба файлов Azure возвращает код состояния 412 (сбой предварительных условий). Если клиент указывает идентификатор аренды, но файл не имеет активной аренды, Служба файлов Azure также возвращает код состояния 412 (сбой предварительных условий).