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änglig
SMB
NFS

Begäran

Du kan skapa Rename File begäran enligt följande. HTTPS rekommenderas.

Metod	Begärande-URI	HTTP-version
STÄLLA	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	Beskrivning
myaccount	Namnet på ditt lagringskonto.
myshare	Namnet på filresursen.
mydirectorypath	Valfri. 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 Namngivnings- och referensresurser, kataloger, filer och metadata.

URI-parametrar

Du kan ange följande ytterligare parameter på begärande-URI:n.

Parameter	Beskrivning
timeout	Valfri. 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 UTC (Coordinated Universal Time) 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	Valfri. Om målfilen redan finns skriver du över filen.
x-ms-file-rename-ignore-readonly	Valfri. Om målfilen finns med attributet readonly skriver du över filen. Om det är sant måste x-ms-file-rename-replace-if-exists också vara sant.
x-ms-content-Type	Valfri. Anger filens innehållstyp. Om den här egenskapen inte anges i begäran bevaras egenskapen för filen.
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> }	Valfritt om x-ms-file-permission-key inte har angetts. Den här behörigheten är säkerhetsbeskrivningen för filen som anges i Security Descriptor Definition Language (SDDL) eller (version 2024-11-04 eller senare) i base64-kodad binär säkerhetsbeskrivningsformat. Du kan ange vilket format som ska användas med x-ms-file-permission-format-huvudet. 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 ägare, grupp och diskretionär åtkomstkontrollista. Du kan skicka ett värde på 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-format: { sddl ¦ binary }	Valfri. Version 2024-11-04 eller senare. Anger om värdet som skickas i x-ms-file-permission är i SDDL eller i binärt format. Om x-ms-file-permission-key har angetts till preserveska det här huvudet inte anges. Om x-ms-file-permission-key är inställt på något annat värde än preserveoch om det här huvudet inte har angetts används standardvärdet för sddl.
x-ms-file-permission-key	Valfritt om x-ms-file-permission inte har angetts. Nyckeln för den behörighet 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	Valfri. De filsystemattribut som ska anges i filen. Se listan över tillgängliga attribut. Du kan skicka ett värde på 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	Valfri. Tidsegenskapen UTC-skapande för en fil. Du kan skicka ett värde på 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	Valfri. UTC:s senaste skrivegenskap för en fil. Du kan skicka ett värde på 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	Valfri. Tillhandahåller ett klientgenererat, täckande värde med en kibibytesteckengräns (KiB) som registreras i loggarna när loggningen konfigureras. 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	Valfri. 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 rubrik 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 är auktoriserad med hjälp av Authorization-huvudet. Tillgänglig för version 2022-11-02 och senare.
x-ms-allow-trailing-dot: { <Boolean> }	Valfri. 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 Namngivning och referens av resurser, kataloger, filer och metadata.
x-ms-source-allow-trailing-dot: { <Boolean> }	Valfri. 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. Det här huvudet bör 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 Namngivning och referens av resurser, kataloger, filer och metadata.

Begärandetext

Ingen.

Svar

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 också innehålla ytterligare standard-HTTP-huvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.

Svarsrubrik	Beskrivning
ETag	Innehåller ett värde som representerar versionen av filen, inom citattecken.
Last-Modified	Returnerar datum och tid då filen senast ändrades. Mer information finns i Representation av datum-tidsvärden i rubriker. Alla åtgärder som ändrar katalogen, eller dess egenskaper, uppdaterar den senaste ändrade tiden. Åtgärder på filer påverkar inte den senaste ändrade tiden för katalogen.
x-ms-request-id	Identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran. Mer information finns i Felsökning av 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 UTC-datum/tid-värde 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 är inställt på 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	Filsystemets attribut för filen. Se listan över tillgängliga attribut.
x-ms-file-creation-time	UTC-datum/tid-värdet som representerar egenskapen för att skapa tid för filen.
x-ms-file-last-write-time	UTC-datum/tid-värdet som representerar den senaste skrivtidsegenskapen för filen.
x-ms-file-change-time	UTC-datum/tid som representerar egenskapen för ändringstid för filen.
x-ms-file-file-id	Fil-ID:t för filen.
x-ms-file-parent-id	Filens överordnade fil-ID.
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 den x-ms-client-request-id rubriken inte finns i begäran visas den inte i svaret.

Svarstext

Ingen.

Tillstånd

Endast kontoägaren 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 endast använder.
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 för en fil är inte tillgängliga omedelbart. Det här filsystemattributet visas 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 visas främst för att ge kompatibilitet med Windows.

Anmärkningar

Målet kan inte vara en befintlig katalog.

Om du inte anger egenskaper anges standardbeteendet för preserve eller now.

Not

De föregående filegenskaperna ä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 i 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 statuskoden 412 (förhandsvillkoret misslyckades).

Se även

åtgärder för filer