Zmienianie nazwy katalogu
Operacja Rename Directory
zmienia nazwę katalogu i opcjonalnie może ustawić właściwości systemowe dla katalogu. Ten interfejs API jest dostępny w wersji 2021-04-10 lub nowszej.
Dostępność protokołu
Włączony protokół udziału plików | Dostępny |
---|---|
SMB | |
NFS |
Prosić
Żądanie Rename Directory
można skonstruować w następujący sposób. Zalecany jest protokół HTTPS.
Metoda | Identyfikator URI żądania | Wersja PROTOKOŁU HTTP |
---|---|---|
KŁAŚĆ | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename |
HTTP/1.1 |
Zastąp składniki ścieżki wyświetlane we własnym identyfikatorze URI żądania, w następujący sposób:
Składnik ścieżki | Opis |
---|---|
myaccount |
Nazwa konta magazynu. |
myshare |
Nazwa udziału plików. |
mydirectorypath |
Fakultatywny. Ścieżka do katalogu nadrzędnego. |
mydirectory |
Nazwa katalogu docelowego. |
Aby uzyskać szczegółowe informacje na temat ograniczeń nazewnictwa ścieżek, zobacz Nazewnictwo i odwoływanie się do udziałów, katalogów, plików i metadanych.
Parametry identyfikatora URI
Dla identyfikatora URI żądania można określić następujący dodatkowy parametr.
Parametr | Opis |
---|---|
timeout |
Fakultatywny. Parametr timeout jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi Azure Files. |
Nagłówki żądań
W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.
Nagłówek żądania | Opis |
---|---|
Authorization |
Wymagane. Określa schemat autoryzacji, nazwę konta i podpis. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage. |
Date lub x-ms-date |
Wymagane. Określa uniwersalny czas koordynowany (UTC) dla żądania. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage. |
x-ms-version |
Wymagane dla wszystkich autoryzowanych żądań. Określa wersję operacji do użycia dla tego żądania. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji dla usług Azure Storage. |
x-ms-file-rename-source:name |
Wymagane. Pełny identyfikator URI katalogu, który ma zostać zmieniony. |
x-ms-file-rename-ignore-readonly |
Fakultatywny. Jeśli katalog docelowy istnieje z atrybutem readonly , zastąp katalog.Jeśli wartość true, x-ms-file-rename-replace-if-exists również musi mieć wartość true. |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
Opcjonalnie, jeśli nie określono x-ms-file-permission-key . To uprawnienie jest deskryptorem zabezpieczeń katalogu określonego w Security Descriptor Definition Language (SDDL) lub (wersja 2024-11-04 lub nowsza) w formacie base64 zakodowanym binarnym deskryptorze zabezpieczeń. Można określić format używany z nagłówkiem x-ms-file-permission-format . Możesz użyć tego nagłówka, jeśli rozmiar uprawnień to 8 kibibajtów (KiB) lub mniej. W przeciwnym razie możesz użyć x-ms-file-permission-key . Jeśli to uprawnienie zostanie określone, musi mieć właściciela, grupę i uznaniową listę kontroli dostępu. Możesz przekazać wartość preserve , jeśli chcesz zachować istniejącą wartość bez zmian.Należy pamiętać, że można określić x-ms-file-permission lub x-ms-file-permission-key , a nie oba. |
x-ms-file-permission-format: { sddl ¦ binary } |
Fakultatywny. Wersja 2024-11-04 lub nowsza. Określa, czy wartość przekazywana w x-ms-file-permission jest w formacie SDDL, czy w formacie binarnym. Jeśli x-ms-file-permission-key jest ustawiona na preserve , nie należy ustawiać tego nagłówka. Jeśli x-ms-file-permission-key jest ustawiona na dowolną inną wartość niż preserve , a jeśli ten nagłówek nie jest ustawiony, zostanie użyta wartość domyślna sddl . |
x-ms-file-permission-key |
Opcjonalnie, jeśli nie określono x-ms-file-permission . Klucz uprawnienia do ustawienia dla katalogu. Można to utworzyć przy użyciu interfejsu API Create-Permission .Należy pamiętać, że można określić x-ms-file-permission lub x-ms-file-permission-key , a nie oba. |
x-ms-file-attributes |
Fakultatywny. Atrybuty systemu plików, które mają być ustawione w katalogu. Zobacz listę dostępnych atrybutów. Możesz przekazać wartość preserve , jeśli chcesz zachować istniejącą wartość bez zmian. Jeśli ta właściwość nie zostanie określona w żądaniu, właściwość zostanie zachowana. |
x-ms-file-creation-time |
Fakultatywny. Właściwość godzina utworzenia UTC dla katalogu. Możesz przekazać wartość preserve , jeśli chcesz zachować istniejącą wartość bez zmian. Jeśli ta właściwość nie zostanie określona w żądaniu, właściwość zostanie zachowana. |
x-ms-file-last-write-time |
Fakultatywny. Ostatnia właściwość zapisu UTC dla katalogu. Możesz przekazać wartość preserve , jeśli chcesz zachować istniejącą wartość bez zmian. Jeśli ta właściwość nie zostanie określona w żądaniu, właściwość zostanie zachowana. |
x-ms-destination-lease-id:<ID> |
Wymagane, jeśli plik docelowy ma aktywną dzierżawę. |
x-ms-client-request-id |
Fakultatywny. Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z 1 limitem znaków KiB rejestrowanym w dziennikach podczas konfigurowania rejestrowania. Zdecydowanie zalecamy używanie tego nagłówka do korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer. Aby uzyskać więcej informacji, zobacz Monitor Azure Blob Storage. |
x-ms-meta-name:value |
Fakultatywny. Ustawia parę name-value dla katalogu. Każde wywołanie tej operacji zastępuje wszystkie istniejące metadane dołączone do katalogu. Nazwy metadanych muszą być zgodne z regułami nazewnictwa dla identyfikatorów języka C# . Jeśli ta właściwość nie zostanie określona w żądaniu, właściwość zostanie zachowana. |
x-ms-file-request-intent |
Wymagane, jeśli nagłówek Authorization określa token OAuth. Akceptowalna wartość to backup . Ten nagłówek określa, że Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action lub Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action należy przyznać, jeśli są one uwzględnione w zasadach RBAC przypisanych do tożsamości autoryzowanej przy użyciu nagłówka Authorization . Dostępne dla wersji 2022-11-02 lub nowszej. |
x-ms-allow-trailing-dot: { <Boolean> } |
Fakultatywny. Wersja 2022-11-02 lub nowsza. Wartość logiczna określa, czy końcowa kropka obecna w adresie URL żądania powinna zostać przycięta, czy nie. Aby uzyskać więcej informacji, zobacz Nazewnictwo i odwoływanie się do udziałów, katalogów, plików i metadanych. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Fakultatywny. Wersja 2022-11-02 lub nowsza. Wartość logiczna określa, czy końcowa kropka obecna w źródłowym adresie URL powinna być przycinana, czy nie. Ten nagłówek powinien być określony tylko wtedy, gdy źródło kopiowania jest udziałem plików platformy Azure. Ten nagłówek nie jest obsługiwany dla żadnego innego typu źródła kopii. Aby uzyskać więcej informacji, zobacz Nazewnictwo i odwoływanie się do udziałów, katalogów, plików i metadanych. |
Treść żądania
Żaden.
Odpowiedź
Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.
Kod stanu
Pomyślna operacja zwraca kod stanu 200 (OK). Aby uzyskać informacje o kodach stanu, zobacz Stan i kody błędów.
Nagłówki odpowiedzi
Odpowiedź dla tej operacji zawiera następujące nagłówki. Odpowiedź może również zawierać dodatkowe, standardowe nagłówki HTTP. Wszystkie standardowe nagłówki są zgodne ze specyfikacją protokołu HTTP/1.1 .
Nagłówek odpowiedzi | Opis |
---|---|
ETag |
Zawiera wartość reprezentującą wersję pliku w cudzysłowie. |
Last-Modified |
Zwraca datę i godzinę ostatniej modyfikacji pliku. Aby uzyskać więcej informacji, zobacz Reprezentacja wartości daty i godziny w nagłówkach. Każda operacja, która modyfikuje katalog lub jego właściwości, aktualizuje czas ostatniej modyfikacji. Operacje na plikach nie mają wpływu na czas ostatniej modyfikacji katalogu. |
x-ms-request-id |
Jednoznacznie identyfikuje żądanie, które zostało wykonane i może służyć do rozwiązywania problemów z żądaniem. Aby uzyskać więcej informacji, zobacz Rozwiązywanie problemów z operacjami interfejsu API. |
x-ms-version |
Wskazuje wersję usługi Azure Files używaną do uruchomienia żądania. |
Date lub x-ms-date |
Wartość daty/godziny UTC wskazująca godzinę, o której zainicjowano odpowiedź. Usługa generuje tę wartość. |
x-ms-request-server-encrypted: true/false |
Wartość tego nagłówka jest ustawiona na true , jeśli zawartość żądania zostanie pomyślnie zaszyfrowana przy użyciu określonego algorytmu. W przeciwnym razie wartość jest ustawiona na wartość false . |
x-ms-file-permission-key |
Klucz uprawnienia do pliku. |
x-ms-file-attributes |
Atrybuty systemu plików w pliku. Zobacz listę dostępnych atrybutów. |
x-ms-file-creation-time |
Wartość daty/godziny UTC reprezentująca właściwość godzina utworzenia pliku. |
x-ms-file-last-write-time |
Wartość daty/godziny UTC reprezentująca właściwość czas ostatniego zapisu dla pliku. |
x-ms-file-change-time |
Data/godzina UTC reprezentująca właściwość godziny zmiany pliku. |
x-ms-file-file-id |
Identyfikator pliku. |
x-ms-file-parent-id |
Identyfikator pliku nadrzędnego. |
x-ms-client-request-id |
Może służyć do rozwiązywania problemów z żądaniami i odpowiadającymi odpowiedziami. Wartość tego nagłówka jest równa wartości nagłówka x-ms-client-request-id , jeśli jest obecna w żądaniu. Wartość jest najwyżej 1024 widocznymi znakami ASCII. Jeśli nagłówek x-ms-client-request-id nie znajduje się w żądaniu, nie będzie on obecny w odpowiedzi. |
Treść odpowiedzi
Żaden.
Autoryzacja
Tylko właściciel konta może wywołać tę operację.
Atrybuty systemu plików
Atrybut | Atrybut pliku Win32 | Definicja |
---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Katalog, który jest tylko do odczytu. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Katalog jest ukryty. Nie jest on uwzględniony w zwykłej liście katalogów. |
System |
FILE_ATTRIBUTE_SYSTEM | Katalog używany przez system operacyjny lub używany wyłącznie. |
None |
FILE_ATTRIBUTE_NORMAL | Katalog, który nie ma innych atrybutów ustawionych. Ten atrybut jest prawidłowy tylko wtedy, gdy jest używany sam. |
Directory |
FILE_ATTRIBUTE_DIRECTORY | Dojście identyfikujące katalog. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Katalog, który jest katalogiem archiwum. Aplikacje zazwyczaj używają tego atrybutu do oznaczania plików do tworzenia kopii zapasowej lub usuwania. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Dane katalogu nie są natychmiast dostępne. Ten atrybut systemu plików jest przedstawiany głównie w celu zapewnienia zgodności z systemem Windows. Usługa Azure Files nie obsługuje opcji magazynu w trybie offline. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Katalog nie jest indeksowany przez usługę indeksowania zawartości. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Strumień danych użytkownika nie jest odczytywany przez skaner integralności danych w tle. Ten atrybut systemu plików jest przedstawiany głównie w celu zapewnienia zgodności z systemem Windows. |
Uwagi
Jeśli element docelowy jest katalogiem, katalog nie może istnieć.
Rename Directory
nie jest obsługiwana w migawce udziału, która jest kopią udziału tylko do odczytu. Jeśli spróbujesz wykonać tę operację na migawki udziału, usługa zwróci stan błędu 400 (nieprawidłowa wartość parametru zapytania).
Jeśli nie określisz właściwości, zostanie ustawione domyślne zachowanie preserve
lub now
.
Jeśli katalog ma aktywną dzierżawę, klient musi określić prawidłowy identyfikator dzierżawy w żądaniu, aby zmienić nazwę katalogu. Jeśli klient nie określi identyfikatora dzierżawy lub określi nieprawidłowy identyfikator dzierżawy, usługa Azure Files zwraca kod stanu 412 (Niepowodzenie warunku wstępnego). Jeśli klient określa identyfikator dzierżawy, ale katalog nie ma aktywnej dzierżawy, usługa Azure Files zwraca również kod stanu 412 (Niepowodzenie warunku wstępnego).
Zobacz też
operacje w katalogach