Byt namn på fil
Åtgärden Rename File byter namn på en fil och kan också ange systemegenskaper för filen. Det här API:et är tillgängligt i version 2021-04-10 och senare.
Protokolltillgänglighet
| Aktiverat filresursprotokoll | Tillgängligt |
|---|---|
| SMB |  |
| NFS |  |
Förfrågan
Du kan skapa begäran på Rename File följande sätt. HTTPS rekommenderas.
| Metod | URI för förfrågan | HTTP-version |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Ersätt sökvägskomponenterna som visas i begärande-URI:n med dina egna, enligt följande:
| Sökvägskomponent | Description |
|---|---|
myaccount |
Namnet på ditt lagringskonto. |
myshare |
Namnet på filresursen. |
mydirectorypath |
Valfritt. Sökvägen till den överordnade målkatalogen. |
myfile |
Namnet på målfilen. |
Mer information om namngivningsbegränsningar för sökvägar finns i Namnge och referera till resurser, kataloger, filer och metadata.
URI-parametrar
Du kan ange följande ytterligare parameter i begärande-URI:n.
| Parameter | Beskrivning |
|---|---|
timeout |
Valfritt. Parametern timeout uttrycks i sekunder. Mer information finns i Ange tidsgränser för Azure Files åtgärder. |
Begärandehuvuden
I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.
| Begärandehuvud | Beskrivning |
|---|---|
Authorization |
Krävs. Anger auktoriseringsschema, kontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage. |
Date eller x-ms-date |
Krävs. Anger Coordinated Universal Time (UTC) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage. |
x-ms-version |
Krävs för alla auktoriserade begäranden. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna. |
x-ms-file-rename-source:name |
Krävs. Fullständig URI för filen som ska byta namn. |
x-ms-file-rename-replace-if-exists |
Valfritt. Om målfilen redan finns skriver du över filen. |
x-ms-file-rename-ignore-readonly |
Valfritt. Om målfilen finns med readonly attributet skriver du över filen.Om sant, x-ms-file-rename-replace-if-exists måste också vara sant. |
x-ms-content-Type |
Valfritt. Anger filens innehållstyp. Om den här egenskapen inte anges i begäran bevaras egenskapen för filen. |
x-ms-file-permission |
Valfritt om x-ms-file-permission-key inte har angetts. Den här behörigheten är säkerhetsbeskrivning för filen som anges i SDDL (Security Descriptor Definition Language). Du kan använda det här huvudet om behörighetsstorleken är 8 kibibyte (KiB) eller mindre. Annars kan du använda x-ms-file-permission-key. Om den här behörigheten anges måste den ha en lista över ägare, grupper och diskretionär åtkomstkontroll. Du kan skicka ett värde för preserve om du vill behålla ett befintligt värde oförändrat.Observera att du kan ange antingen x-ms-file-permission eller x-ms-file-permission-key, inte båda. |
x-ms-file-permission-key |
Valfritt om x-ms-file-permission inte har angetts. Nyckeln för behörigheten som ska anges för filen. Du kan skapa detta med hjälp av API:et Create-Permission .Observera att du kan ange antingen x-ms-file-permission eller x-ms-file-permission-key, inte båda. |
x-ms-file-attributes |
Valfritt. De filsystemattribut som ska anges för filen. Se listan över tillgängliga attribut. Du kan skicka ett värde för preserve om du vill behålla ett befintligt värde oförändrat. Om du inte anger den här egenskapen i begäran bevaras egenskapen för filen. |
x-ms-file-creation-time |
Valfritt. Tidsegenskapen FÖR UTC-skapande för en fil. Du kan skicka ett värde för preserve om du vill behålla ett befintligt värde oförändrat. Om du inte anger den här egenskapen i begäran bevaras egenskapen för filen. |
x-ms-file-last-write-time |
Valfritt. UTC:s senaste skrivegenskap för en fil. Du kan skicka ett värde för preserve om du vill behålla ett befintligt värde oförändrat. Om du inte anger den här egenskapen i begäran bevaras egenskapen för filen. |
x-ms-source-lease-id:<ID> |
Krävs om källfilen har ett aktivt lån. |
x-ms-destination-lease-id:<ID> |
Krävs om målfilen har ett aktivt lån. |
x-ms-client-request-id |
Valfritt. Tillhandahåller ett klientgenererat, täckande värde med en teckengräns på 1 kibibyte (KiB) som registreras i loggarna när loggningen har konfigurerats. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Blob Storage. |
x-ms-meta-name:value |
Valfritt. Anger ett namn/värde-par för filen. Varje anrop till den här åtgärden ersätter alla befintliga metadata som är kopplade till filen. Metadatanamn måste följa namngivningsreglerna för C#-identifierare. |
x-ms-file-request-intent |
Krävs om Authorization huvudet anger en OAuth-token. Acceptabelt värde är backup. Det här huvudet anger att Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action eller Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action ska beviljas om de ingår i RBAC-principen som tilldelats den identitet som har behörighet med huvudet Authorization . Tillgänglig för version 2022-11-02 och senare. |
x-ms-allow-trailing-dot: { <Boolean> } |
Valfritt. Version 2022-11-02 och senare. Det booleska värdet anger om en avslutande punkt som finns i begärande-URL:en ska trimmas eller inte. Mer information finns i Namnge och referera till resurser, kataloger, filer och metadata. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Valfritt. Version 2022-11-02 och senare. Det booleska värdet anger om en avslutande punkt som finns i käll-URL:en ska trimmas eller inte. Den här rubriken ska endast anges om kopieringskällan är en Azure-fil. Det här huvudet stöds inte för någon annan typ av kopieringskälla. Mer information finns i Namnge och referera till resurser, kataloger, filer och metadata. |
Begärandetext
Inga.
Svarsåtgärder
Svaret innehåller en HTTP-statuskod och en uppsättning svarshuvuden.
Statuskod
En lyckad åtgärd returnerar statuskod 200 (OK). Information om statuskoder finns i Status och felkoder.
Svarshuvuden
Svaret för den här åtgärden innehåller följande rubriker. Svaret kan även innehålla ytterligare STANDARD HTTP-huvuden. Alla standardhuvuden överensstämmer med http/1.1-protokollspecifikationen.
| Svarsrubrik | Description |
|---|---|
ETag |
Innehåller ett värde som representerar filens version med citattecken. |
Last-Modified |
Returnerar datum och tid då filen senast ändrades. Mer information finns i Representation of date-time values in headers (Representation av datum/tid-värden i rubriker). Alla åtgärder som ändrar katalogen, eller dess egenskaper, uppdaterar den senaste ändringstiden. Åtgärder på filer påverkar inte den senaste ändringstiden för katalogen. |
x-ms-request-id |
Identifierar den begäran som gjordes unikt och kan användas för att felsöka begäran. Mer information finns i Felsöka API-åtgärder. |
x-ms-version |
Anger vilken version av Azure Files som används för att köra begäran. |
Date eller x-ms-date |
Ett datum-/tidsvärde för UTC som anger den tid då svaret initierades. Tjänsten genererar det här värdet. |
x-ms-request-server-encrypted: true/false |
Värdet för det här huvudet anges till true om innehållet i begäran har krypterats med hjälp av den angivna algoritmen. Annars är värdet inställt på false. |
x-ms-file-permission-key |
Nyckeln för filens behörighet. |
x-ms-file-attributes |
Filsystemattributen för filen. Se listan över tillgängliga attribut. |
x-ms-file-creation-time |
Datum-/tidsvärdet UTC som representerar egenskapen för att skapa tid för filen. |
x-ms-file-last-write-time |
Datum-/tidsvärdet UTC som representerar den senaste skrivtidsegenskapen för filen. |
x-ms-file-change-time |
UTC-datum/tid som representerar filens ändringstidsegenskap. |
x-ms-file-file-id |
Filens fil-ID. |
x-ms-file-parent-id |
Det överordnade fil-ID:t för filen. |
x-ms-client-request-id |
Kan användas för att felsöka begäranden och motsvarande svar. Värdet för det här huvudet är lika med värdet för x-ms-client-request-id huvudet, om det finns i begäran. Värdet är högst 1 024 synliga ASCII-tecken. Om rubriken x-ms-client-request-id inte finns i begäran finns den inte i svaret. |
Själva svaret
Inga.
Auktorisering
Endast kontoinnehavaren kan anropa den här åtgärden.
Filsystemattribut
| Attribut | Win32-filattribut | Definition |
|---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | En fil som är skrivskyddad. Program kan läsa filen, men kan inte skriva till den eller ta bort den. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Filen är dold. Den ingår inte i en vanlig kataloglista. |
System |
FILE_ATTRIBUTE_SYSTEM | En fil som operativsystemet använder en del av eller använder exklusivt. |
None |
FILE_ATTRIBUTE_NORMAL | En fil som inte har andra attribut angivna. Det här attributet är endast giltigt när det används ensamt. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | En fil som är en arkivfil. Program använder vanligtvis det här attributet för att markera filer för säkerhetskopiering eller borttagning. |
Temporary |
FILE_ATTRIBUTE_TEMPORARY | En fil som används för tillfällig lagring. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Data i en fil är inte tillgängliga omedelbart. Det här filsystemattributet presenteras främst för att ge kompatibilitet med Windows. Azure Files stöder inte offlinelagringsalternativ. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Filen ska inte indexeras av innehållsindexeringstjänsten. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Användardataströmmen ska inte läsas av bakgrundsdataintegritetsskannern. Det här filsystemattributet presenteras främst för att ge kompatibilitet med Windows. |
Kommentarer
Målet kan inte vara en befintlig katalog.
Om du inte anger egenskaper anges standardbeteendet preserve för eller now .
Anteckning
Föregående filegenskaper är diskreta från de filsystemegenskaper som är tillgängliga för SMB-klienter. SMB-klienter kan inte läsa, skriva eller ändra dessa egenskapsvärden.
Rename File stöds inte på en resursögonblicksbild, vilket är en skrivskyddad kopia av en resurs. Om du försöker utföra den här åtgärden på en resursögonblicksbild returnerar tjänsten felstatus 400 (ogiltigt frågeparametervärde).
Om filen har ett aktivt lån måste klienten ange ett giltigt låne-ID för begäran för att kunna byta namn på filen. Om klienten inte anger något låne-ID eller anger ett ogiltigt låne-ID returnerar Azure Files statuskod 412 (förhandsvillkoret misslyckades). Om klienten anger ett låne-ID, men filen inte har ett aktivt lån, returnerar Azure Files även statuskod 412 (förhandsvillkoret misslyckades).