Přejmenovat soubor
Operace Rename File
přejmenuje soubor a volitelně může pro soubor nastavit systémové vlastnosti. 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 |
Žádost
Požadavek můžete sestavit Rename File
následujícím způsobem. Doporučuje se https.
Metoda | Identifikátor URI žádosti | Verze PROTOKOLU HTTP |
---|---|---|
PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Následujícím způsobem nahraďte komponenty cesty uvedené v identifikátoru URI požadavku vlastními:
Komponenta cesty | Description |
---|---|
myaccount |
Název vašeho účtu úložiště. |
myshare |
Název sdílené složky. |
mydirectorypath |
Nepovinný parametr. 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í sdílených složek, adresářů, souborů a metadat a odkazování na nich.
Parametry identifikátoru URI
V identifikátoru URI požadavku můžete zadat následující další parametr.
Parametr | Popis |
---|---|
timeout |
Nepovinný parametr. Parametr se timeout 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 požadované a volitelné hlavičky požadavků.
Hlavička požadavku | Popis |
---|---|
Authorization |
Povinná hodnota. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků do služby Azure Storage. |
Date nebo x-ms-date |
Povinná hodnota. Určuje formát UTC (Coordinated Universal Time). Další informace najdete v tématu Autorizace požadavků do služby 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 |
Povinná hodnota. Úplný identifikátor URI souboru, který se má přejmenovat. |
x-ms-file-rename-replace-if-exists |
Nepovinný parametr. Pokud cílový soubor již existuje, přepište ho. |
x-ms-file-rename-ignore-readonly |
Nepovinný parametr. Pokud cílový soubor existuje s atributem readonly , přepište ho.Pokud je true, x-ms-file-rename-replace-if-exists musí být také true. |
x-ms-content-Type |
Nepovinný parametr. Nastaví typ obsahu souboru. Pokud tato vlastnost není v požadavku zadaná, zachová se pro soubor. |
x-ms-file-permission |
Volitelné, pokud x-ms-file-permission-key není zadané. Toto oprávnění je popisovač zabezpečení pro soubor zadaný v jazyce SDDL (Security Descriptor Definition Language). 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 toto oprávnění zadané, musí 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 buď, x-ms-file-permission nebo x-ms-file-permission-key , nikoli obě. |
x-ms-file-permission-key |
Volitelné, pokud x-ms-file-permission není zadané. Klíč oprávnění, které se má pro soubor nastavit. Můžete ho Create-Permission vytvořit pomocí rozhraní API.Všimněte si, že můžete zadat buď, x-ms-file-permission nebo x-ms-file-permission-key , nikoli obě. |
x-ms-file-attributes |
Nepovinný parametr. Atributy systému souborů, které mají být nastaveny pro soubor. Podívejte se na 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, zachová se vlastnost pro soubor. |
x-ms-file-creation-time |
Nepovinný parametr. Vlastnost času vytvoření souboru v utc. Pokud chcete zachovat existující hodnotu beze změny, můžete předat hodnotu preserve . Pokud tuto vlastnost v požadavku nezadáte, zachová se vlastnost pro soubor. |
x-ms-file-last-write-time |
Nepovinný parametr. Vlastnost posledního 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, zachová se vlastnost pro soubor. |
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 |
Nepovinný parametr. Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem počtu 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í Azure Blob Storage. |
x-ms-meta-name:value |
Nepovinný parametr. Nastaví dvojici název-hodnota pro soubor. Každé volání této operace nahradí všechna existující metadata připojená k souboru. Názvy metadat musí splňovat pravidla pojmenování pro identifikátory jazyka C#. |
x-ms-file-request-intent |
Vyžaduje se, pokud Authorization hlavička určuje token OAuth. Přijatelná hodnota je backup . Tato hlavička určuje, že Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action by se měly udělit nebo Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action , pokud jsou zahrnuté v zásadách RBAC přiřazené identitě, která je autorizována pomocí hlavičky Authorization . K dispozici pro verzi 2022-11-02 a novější. |
x-ms-allow-trailing-dot: { <Boolean> } |
Nepovinný parametr. Verze 2022-11-02 a novější. Logická hodnota určuje, jestli se má v adrese URL požadavku oříznout koncová tečka, nebo ne. Další informace najdete v tématu Pojmenování sdílených složek, adresářů, souborů a metadat a odkazování na nich. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Nepovinný parametr. Verze 2022-11-02 a novější. Logická hodnota určuje, jestli se má oříznout koncová tečka obsažená ve zdrojové adrese URL. Tato hlavička by měla být zadána pouze 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í sdílených složek, adresářů, souborů a metadat a odkazování na nich. |
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 najdete v tématu Stavové kódy a kódy chyb.
Hlavičky odpovědi
Odpověď na tuto operaci obsahuje následující hlavičky. Odpověď může také obsahovat další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.
Hlavička odpovědi | Description |
---|---|
ETag |
Obsahuje hodnotu, která představuje verzi souboru v uvozovkách. |
Last-Modified |
Vrátí datum a čas poslední změny souboru. Další informace najdete v tématu Reprezentace hodnot data a času v záhlavích. Každá operace, která upraví 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 Azure Files použité 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. Tato 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 hodnotu . |
x-ms-file-permission-key |
Klíč oprávnění k souboru. |
x-ms-file-attributes |
Atributy systému souborů v souboru. Podívejte se na seznam dostupných atributů. |
x-ms-file-creation-time |
Hodnota data a času UTC, která představuje vlastnost času vytvoření souboru. |
x-ms-file-last-write-time |
Hodnota data a času UTC, která představuje vlastnost čas posledního zápisu souboru. |
x-ms-file-change-time |
Datum a čas UTC, která představuje vlastnost čas změny 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ě x-ms-client-request-id hlavičky, pokud je v požadavku. Hodnota je maximálně 1 024 viditelných znaků ASCII. Pokud hlavička x-ms-client-request-id v požadavku není, nebude v odpovědi. |
Text odpovědi
Žádné
Autorizace
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 ho odstranit. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Soubor je skrytý. Není součástí běžného výpisu adresáře. |
System |
FILE_ATTRIBUTE_SYSTEM | Soubor, který operační systém používá 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 souborem archivu. Aplikace obvykle používají tento atribut 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 se systémem Windows. Azure Files nepodporuje možnosti offline úložiště. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Soubor nemá indexovat služba indexování obsahu. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Datový proud uživatele nemá číst skener integrity dat na pozadí. Tento atribut systému souborů je prezentován především kvůli zajištění kompatibility se systémem Windows. |
Poznámky
Cílem nemůže být existující adresář.
Pokud nezadáte vlastnosti, nastaví se výchozí chování nebo preserve
now
.
Poznámka
Předchozí vlastnosti souboru jsou oddělené od vlastností systému souborů, které jsou k dispozici klientům SMB. Klienti SMB nemůžou tyto hodnoty vlastností číst, zapisovat ani upravovat.
Rename File
se nepodporuje u snímku sdílené složky, 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í, klient musí v požadavku zadat platné ID zapůjčení, aby mohl soubor přejmenovat. Pokud klient nezadá ID zapůjčení nebo zadá neplatné ID zapůjčení, vrátí Azure Files stavový kód 412 (Předběžná podmínka se nezdařila). Pokud klient zadá ID zapůjčení, ale soubor nemá aktivní zapůjčení, vrátí Azure Files také stavový kód 412 (Předběžná podmínka se nezdařila).