Přejmenovat soubor

Operace Rename File přejmenuje soubor a volitelně může nastavit systémové vlastnosti souboru. Toto rozhraní API je k dispozici ve verzi 2021-04-10 a novější.

Dostupnost protokolu

Povolený protokol sdílené složky	K dispozici
SMB
NFS

Prosba

Požadavek Rename File můžete vytvořit následujícím způsobem. Doporučuje se HTTPS.

Metoda	Identifikátor URI požadavku	Verze HTTP
DÁT	https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename	HTTP/1.1

Součásti cesty zobrazené v identifikátoru URI požadavku nahraďte vlastními, a to následujícím způsobem:

Komponenta Path	Popis
myaccount	Název vašeho účtu úložiště.
myshare	Název sdílené složky.
mydirectorypath	Volitelný. Cesta k nadřazeného cílovému adresáři.
myfile	Název cílového souboru.

Podrobnosti o omezeních pojmenování cest najdete v tématu Pojmenování a odkazování na sdílené složky, adresáře, soubory a metadata.

Parametry identifikátoru URI

Pro identifikátor URI požadavku můžete zadat následující další parametr.

Parametr	Popis
timeout	Volitelný. Parametr timeout se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace azure Files.

Hlavičky požadavku

Následující tabulka popisuje povinné a volitelné hlavičky požadavků.

Hlavička požadavku	Popis
Authorization	Požadovaný. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage.
Date nebo x-ms-date	Požadovaný. Určuje standard UTC (Coordinated Universal Time) pro požadavek. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage.
x-ms-version	Vyžaduje se pro všechny autorizované žádosti. Určuje verzi operace, která se má pro tento požadavek použít. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
x-ms-file-rename-source:name	Požadovaný. Úplný identifikátor URI souboru, který se má přejmenovat.
x-ms-file-rename-replace-if-exists	Volitelný. Pokud cílový soubor již existuje, přepište ho.
x-ms-file-rename-ignore-readonly	Volitelný. Pokud cílový soubor existuje s atributem readonly, přepište soubor. Pokud je pravda, musí být x-ms-file-rename-replace-if-exists také true.
x-ms-content-Type	Volitelný. Nastaví typ obsahu souboru. Pokud tato vlastnost není v požadavku zadána, vlastnost se pro soubor zachovají.
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> }	Volitelné, pokud není zadán x-ms-file-permission-key. Toto oprávnění je popisovač zabezpečení pro soubor zadaný v SDDL (Security Descriptor Definition Language) nebo (verze 2024-11-04 nebo novější) ve formátu binární popisovač zabezpečení. Můžete určit, který formát se má použít se záhlavím x-ms-file-permission-format. Tuto hlavičku můžete použít, pokud je velikost oprávnění 8 kibibajtů (KiB) nebo menší. V opačném případě můžete použít x-ms-file-permission-key. Pokud je zadáno, musí toto oprávnění mít vlastníka, skupinu a volitelný seznam řízení přístupu. Pokud chcete zachovat existující hodnotu beze změny, můžete předat hodnotu preserve. Všimněte si, že můžete zadat x-ms-file-permission nebo x-ms-file-permission-key, nikoli obojí.
x-ms-file-permission-format: { sddl ¦ binary }	Volitelný. Verze 2024-11-04 nebo novější Určuje, zda hodnota předaná v x-ms-file-permission je v SDDL nebo v binárním formátu. Pokud je x-ms-file-permission-key nastavená na preserve, nemělo by být toto záhlaví nastaveno. Pokud je x-ms-file-permission-key nastavena na jinou hodnotu než preserve, a pokud toto záhlaví není nastaveno, použije se výchozí hodnota sddl.
x-ms-file-permission-key	Volitelné, pokud není zadán x-ms-file-permission. Klíč oprávnění, které se má pro soubor nastavit. Můžete to vytvořit pomocí rozhraní Create-Permission API. Všimněte si, že můžete zadat x-ms-file-permission nebo x-ms-file-permission-key, nikoli obojí.
x-ms-file-attributes	Volitelný. Atributy systému souborů, které mají být nastaveny v souboru. Prohlédněte si seznam dostupných atributů. Pokud chcete zachovat existující hodnotu beze změny, můžete předat hodnotu preserve. Pokud tuto vlastnost v požadavku nezadáte, vlastnost se pro soubor zachovají.
x-ms-file-creation-time	Volitelný. Vlastnost času vytvoření UTC pro soubor. Pokud chcete zachovat existující hodnotu beze změny, můžete předat hodnotu preserve. Pokud tuto vlastnost v požadavku nezadáte, vlastnost se pro soubor zachovají.
x-ms-file-last-write-time	Volitelný. Poslední vlastnost zápisu souboru ve standardu UTC. Pokud chcete zachovat existující hodnotu beze změny, můžete předat hodnotu preserve. Pokud tuto vlastnost v požadavku nezadáte, vlastnost se pro soubor zachovají.
x-ms-source-lease-id:<ID>	Vyžaduje se, pokud má zdrojový soubor aktivní zapůjčení.
x-ms-destination-lease-id:<ID>	Vyžaduje se, pokud má cílový soubor aktivní zapůjčení.
x-ms-client-request-id	Volitelný. Poskytuje hodnotu vygenerovanou klientem, neprůshlenou hodnotou s limitem znaků 1 kibibajtů (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování služby Azure Blob Storage.
x-ms-meta-name:value	Volitelný. Nastaví dvojici název-hodnota pro soubor. Každé volání této operace nahrazuje všechna existující metadata připojená k souboru. Názvy metadat musí dodržovat pravidla pojmenování pro identifikátory jazyka C# .
x-ms-file-request-intent	Vyžaduje se, pokud hlavička Authorization určuje token OAuth. Přijatelná hodnota je backup. Tato hlavička určuje, že Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action nebo Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action by měly být uděleny, pokud jsou zahrnuty do zásad RBAC přiřazené k identitě, která je autorizovaná pomocí hlavičky Authorization. K dispozici pro verzi 2022-11-02 a novější.
x-ms-allow-trailing-dot: { <Boolean> }	Volitelný. Verze 2022-11-02 a novější. Logická hodnota určuje, jestli by se měla oříznout koncová tečka v adrese URL požadavku, nebo ne. Další informace najdete v tématu Pojmenování a odkazování na sdílené složky, adresáře, soubory a metadata.
x-ms-source-allow-trailing-dot: { <Boolean> }	Volitelný. Verze 2022-11-02 a novější. Logická hodnota určuje, jestli má být koncové tečky ve zdrojové adrese URL oříznuté nebo ne. Tato hlavička by se měla zadat jenom v případě, že zdrojem kopírování je soubor Azure. Tato hlavička není podporována pro žádný jiný typ zdroje kopírování. Další informace najdete v tématu Pojmenování a odkazování na sdílené složky, adresáře, soubory a metadata.

Text požadavku

Žádný.

Odpověď

Odpověď obsahuje stavový kód HTTP a sadu hlaviček odpovědi.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK). Informace o stavových kódech naleznete v tématu Stav a kódy chyb.

Hlavičky odpovědi

Odpověď pro tuto operaci obsahuje následující hlavičky. Odpověď může obsahovat také další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Hlavička odpovědi	Popis
ETag	Obsahuje hodnotu, která představuje verzi souboru v uvozovkách.
Last-Modified	Vrátí datum a čas poslední změny souboru. Další informace naleznete v tématu Reprezentace hodnot data a času v záhlavích. Jakákoli operace, která upravuje adresář nebo jeho vlastnosti, aktualizuje čas poslední změny. Operace se soubory nemají vliv na čas poslední změny adresáře.
x-ms-request-id	Jednoznačně identifikuje požadavek, který byl proveden, a lze ho použít k řešení potíží s požadavkem. Další informace najdete v tématu řešení potíží s operacemi rozhraní API.
x-ms-version	Označuje verzi služby Azure Files použitou ke spuštění požadavku.
Date nebo x-ms-date	Hodnota data a času UTC, která označuje čas, kdy byla odpověď zahájena. Služba vygeneruje tuto hodnotu.
x-ms-request-server-encrypted: true/false	Hodnota této hlavičky je nastavena na true pokud je obsah požadavku úspěšně zašifrován pomocí zadaného algoritmu. V opačném případě je hodnota nastavena na false.
x-ms-file-permission-key	Klíč oprávnění souboru.
x-ms-file-attributes	Atributy systému souborů v souboru. Prohlédněte si seznam dostupných atributů.
x-ms-file-creation-time	Hodnota data a času UTC, která představuje vlastnost čas vytvoření souboru.
x-ms-file-last-write-time	Hodnota data a času UTC, která představuje vlastnost posledního času zápisu souboru.
x-ms-file-change-time	Hodnota data a času UTC, která představuje vlastnost změnit čas souboru.
x-ms-file-file-id	ID souboru.
x-ms-file-parent-id	ID nadřazeného souboru souboru.
x-ms-client-request-id	Dá se použít k řešení potíží s požadavky a odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě hlavičky x-ms-client-request-id, pokud se nachází v požadavku. Hodnota je maximálně 1 024 viditelných znaků ASCII. Pokud v požadavku není hlavička x-ms-client-request-id, nezobrazí se v odpovědi.

Text odpovědi

Žádný.

Oprávnění

Tuto operaci může volat pouze vlastník účtu.

Atributy systému souborů

Atribut	Atribut souboru Win32	Definice
ReadOnly	FILE_ATTRIBUTE_READONLY	Soubor, který je jen pro čtení. Aplikace můžou soubor číst, ale nemůžou do něj zapisovat ani je odstraňovat.
Hidden	FILE_ATTRIBUTE_HIDDEN	Soubor je skrytý. Není součástí běžného seznamu adresářů.
System	FILE_ATTRIBUTE_SYSTEM	Soubor, ze kterého operační systém používá část nebo používá výhradně.
None	FILE_ATTRIBUTE_NORMAL	Soubor, který nemá nastavené další atributy. Tento atribut je platný pouze při použití samostatně.
Archive	FILE_ATTRIBUTE_ARCHIVE	Soubor, který je archivní soubor. Aplikace obvykle tento atribut používají k označení souborů pro zálohování nebo odebrání.
Temporary	FILE_ATTRIBUTE_TEMPORARY	Soubor, který se používá pro dočasné úložiště.
Offline	FILE_ATTRIBUTE_OFFLINE	Data souboru nejsou k dispozici okamžitě. Tento atribut systému souborů je prezentován především kvůli zajištění kompatibility s Windows. Služba Azure Files nepodporuje možnosti offline úložiště.
NotContentIndexed	FILE_ATTRIBUTE_NOT_CONTENT_INDEXED	Soubor není indexován službou indexování obsahu.
NoScrubData	FILE_ATTRIBUTE_NO_SCRUB_DATA	Datový proud uživatele nemusí být čten skenerem integrity dat na pozadí. Tento atribut systému souborů je prezentován především kvůli zajištění kompatibility s Windows.

Poznámky

Cílem nemůže být existující adresář.

Pokud nezadáte vlastnosti, nastaví se výchozí chování preserve nebo now.

Poznámka

Předchozí vlastnosti souboru jsou oddělené od vlastností systému souborů dostupných pro klienty SMB. Klienti SMB nemohou tyto hodnoty vlastností číst, zapisovat ani upravovat.

Rename File se na snímku sdílené složky nepodporuje, což je kopie sdílené složky jen pro čtení. Pokud se pokusíte provést tuto operaci na snímku sdílené složky, vrátí služba stav chyby 400 (neplatná hodnota parametru dotazu).

Pokud má soubor aktivní zapůjčení, musí klient zadat platné ID zapůjčení v požadavku, aby bylo možné soubor přejmenovat. Pokud klient nezadá ID zapůjčení nebo určuje neplatné ID zapůjčení, vrátí služba Azure Files stavový kód 412 (Předběžná podmínka se nezdařila). Pokud klient určuje ID zapůjčení, ale soubor nemá aktivní zapůjčení, vrátí služba Azure Files také stavový kód 412 (předběžná podmínka se nezdařila).

Viz také

operace se soubory