Verzeichnis umbenennen
Der Rename Directory
Vorgang benennt ein Verzeichnis um und kann optional Systemeigenschaften für das Verzeichnis festlegen. Diese API ist ab Version 2021-04-10 verfügbar.
Protokollverfügbarkeit
Aktiviertes Dateifreigabeprotokoll | Verfügbar |
---|---|
SMB | |
NFS |
Anforderung
Sie können die Rename Directory
Anforderung wie folgt erstellen. HTTPS wird empfohlen.
Methode | Anforderungs-URI | HTTP-Version |
---|---|---|
PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename |
HTTP/1.1 |
Ersetzen Sie die im Anforderungs-URI angezeigten Pfadkomponenten wie folgt durch Ihre eigenen Angaben:
Pfadkomponente | BESCHREIBUNG |
---|---|
myaccount |
Der Name Ihres Speicherkontos. |
myshare |
Der Name der Dateifreigabe. |
mydirectorypath |
Optional. Der Pfad zum übergeordneten Verzeichnis. |
mydirectory |
Der Name des Zielverzeichnisses. |
Ausführliche Informationen zu Pfadbenennungseinschränkungen finden Sie unter Benennen und Verweisen auf Freigaben, Verzeichnisse, Dateien und Metadaten.
URI-Parameter
Sie können den folgenden zusätzlichen Parameter für den Anforderungs-URI angeben.
Parameter | BESCHREIBUNG |
---|---|
timeout |
Optional. Der timeout -Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Azure Files Vorgänge. |
Anforderungsheader
In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader beschrieben.
Anforderungsheader | BESCHREIBUNG |
---|---|
Authorization |
Erforderlich. Gibt das Autorisierungsschema, den Kontonamen und die Signatur an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage. |
Date oder x-ms-date |
Erforderlich. Gibt die koordinierte Weltzeit (Coordinated Universal Time, UTC) für die Anforderung an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage. |
x-ms-version |
Erforderlich für alle autorisierten Anforderungen. Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste. |
x-ms-file-rename-source:name |
Erforderlich. Vollständiger URI des verzeichnisses, das umbenannt werden soll. |
x-ms-file-rename-ignore-readonly |
Optional. Wenn das Zielverzeichnis mit dem readonly Attribut vorhanden ist, überschreiben Sie das Verzeichnis.Wenn true, x-ms-file-rename-replace-if-exists muss auch true sein. |
x-ms-file-permission |
Optional, wenn x-ms-file-permission-key nicht angegeben ist. Diese Berechtigung ist der Sicherheitsdeskriptor für das Verzeichnis, das in der Security Descriptor Definition Language (SDDL) angegeben ist. Sie können diesen Header verwenden, wenn die Berechtigungsgröße 8 Kibibytes (KiB) oder weniger beträgt. Andernfalls können Sie verwenden x-ms-file-permission-key . Falls angegeben, muss diese Berechtigung über eine Besitzer-, Gruppen- und diskretionäre Zugriffssteuerungsliste verfügen. Sie können einen Wert von preserve übergeben, wenn Sie einen vorhandenen Wert unverändert lassen möchten.Beachten Sie, dass Sie entweder x-ms-file-permission oder x-ms-file-permission-key angeben können, nicht beides. |
x-ms-file-permission-key |
Optional, wenn x-ms-file-permission nicht angegeben ist. Der Schlüssel der Berechtigung, die für das Verzeichnis festgelegt werden soll. Sie können dies mithilfe der Create-Permission API erstellen.Beachten Sie, dass Sie entweder x-ms-file-permission oder x-ms-file-permission-key angeben können, nicht beides. |
x-ms-file-attributes |
Optional. Die Dateisystemattribute, die im Verzeichnis festgelegt werden sollen. Sehen Sie sich die Liste der verfügbaren Attribute an. Sie können einen Wert von preserve übergeben, wenn Sie einen vorhandenen Wert unverändert lassen möchten. Wenn diese Eigenschaft in der Anforderung nicht angegeben wird, wird die Eigenschaft beibehalten. |
x-ms-file-creation-time |
Optional. Die UTC-Erstellungszeiteigenschaft für ein Verzeichnis. Sie können einen Wert von preserve übergeben, wenn Sie einen vorhandenen Wert unverändert lassen möchten. Wenn diese Eigenschaft in der Anforderung nicht angegeben wird, wird die Eigenschaft beibehalten. |
x-ms-file-last-write-time |
Optional. Die UTC-Eigenschaft des letzten Schreibvorgangs für ein Verzeichnis. Sie können einen Wert von preserve übergeben, wenn Sie einen vorhandenen Wert unverändert lassen möchten. Wenn diese Eigenschaft in der Anforderung nicht angegeben wird, wird die Eigenschaft beibehalten. |
x-ms-destination-lease-id:<ID> |
Erforderlich, wenn die Zieldatei über eine aktive Lease verfügt. |
x-ms-client-request-id |
Optional. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem Grenzwert von 1 KiB-Zeichen bereit, der beim Konfigurieren der Protokollierung in den Protokollen aufgezeichnet wird. Es wird dringend empfohlen, diesen Header zu verwenden, um clientseitige Aktivitäten mit Anforderungen zu korrelieren, die der Server empfängt. Weitere Informationen finden Sie unter Überwachen Azure Blob Storage. |
x-ms-meta-name:value |
Optional. Legt ein Name-Wert-Paar für das Verzeichnis fest. Bei jedem Aufruf dieses Vorgangs werden alle vorhandenen Metadaten ersetzt, die dem Verzeichnis zugeordnet sind. Metadatennamen müssen den Benennungsregeln für C#-Bezeichner entsprechen. Wenn diese Eigenschaft in der Anforderung nicht angegeben wird, wird die Eigenschaft beibehalten. |
x-ms-file-request-intent |
Erforderlich, wenn Authorization der Header ein OAuth-Token angibt. Zulässiger Wert ist backup . Dieser Header gibt an, dass oder Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action gewährt werden soll, wenn sie in der RBAC-Richtlinie enthalten sind, die der Identität zugewiesen ist, die mithilfe des Authorization Headers autorisiert ist. Verfügbar für Version 2022-11-02 und höher. |
x-ms-allow-trailing-dot: { <Boolean> } |
Optional. Version 2022-11-02 und höher. Der boolesche Wert gibt an, ob ein in der Anforderungs-URL vorhandener nachgestellter Punkt gekürzt werden soll oder nicht. Weitere Informationen finden Sie unter Benennen und Verweisen auf Freigaben, Verzeichnisse, Dateien und Metadaten. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Optional. Version 2022-11-02 und höher. Der boolesche Wert gibt an, ob ein nachgestellter Punkt in der Quell-URL gekürzt werden soll oder nicht. Dieser Header sollte nur angegeben werden, wenn es sich bei der Kopierquelle um eine Azure-Dateifreigabe handelt. Dieser Header wird für keinen anderen Kopierquelltyp unterstützt. Weitere Informationen finden Sie unter Benennen und Verweisen auf Freigaben, Verzeichnisse, Dateien und Metadaten. |
Anforderungstext
Keine.
Antwort
Die Antwort enthält den HTTP-Statuscode und einen Satz von Antwortheadern.
Statuscode
Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben. Informationen zu status Codes finden Sie unter Status- und Fehlercodes.
Antwortheader
Die Antwort für diesen Vorgang umfasst die folgenden Header. Die Antwort kann auch zusätzliche HTTP-Standardheader enthalten. Alle Standardheader entsprechen der HTTP/1.1-Protokollspezifikation.
Antwortheader | BESCHREIBUNG |
---|---|
ETag |
Enthält einen Wert, der die Version der Datei in Anführungszeichen darstellt. |
Last-Modified |
Gibt das Datum und die Uhrzeit der letzten Änderung der Datei zurück. Weitere Informationen finden Sie unter Darstellung von Datums-Uhrzeit-Werten in Headern. Jeder Vorgang, der das Verzeichnis oder seine Eigenschaften ändert, aktualisiert den Zeitpunkt der letzten Änderung. Vorgänge für Dateien wirken sich nicht auf den Zeitpunkt der letzten Änderung des Verzeichnisses aus. |
x-ms-request-id |
Identifiziert eindeutig die Anforderung, die gestellt wurde, und kann für die Problembehandlung der Anforderung verwendet werden. Weitere Informationen finden Sie unter Problembehandlung für API-Vorgänge. |
x-ms-version |
Gibt die Version von Azure Files an, die zum Ausführen der Anforderung verwendet wird. |
Date oder x-ms-date |
Ein UTC-Datums-/Uhrzeitwert, der die Uhrzeit angibt, zu der die Antwort initiiert wurde. Der Dienst generiert diesen Wert. |
x-ms-request-server-encrypted: true/false |
Der Wert dieses Headers wird auf true festgelegt, wenn der Inhalt der Anforderung mithilfe des angegebenen Algorithmus erfolgreich verschlüsselt wurde. Andernfalls wird der Wert auf false festgelegt. |
x-ms-file-permission-key |
Der Schlüssel der Berechtigung der Datei. |
x-ms-file-attributes |
Die Dateisystemattribute für die Datei. Sehen Sie sich die Liste der verfügbaren Attribute an. |
x-ms-file-creation-time |
Der UTC-Datums-/Uhrzeitwert, der die Erstellungszeiteigenschaft für die Datei darstellt. |
x-ms-file-last-write-time |
Der UTC-Datums-/Uhrzeitwert, der die Eigenschaft der letzten Schreibzeit für die Datei darstellt. |
x-ms-file-change-time |
Datum/Uhrzeit des UTC-Werts, der die Änderungszeiteigenschaft für die Datei darstellt. |
x-ms-file-file-id |
Die Datei-ID der Datei. |
x-ms-file-parent-id |
Die übergeordnete Datei-ID der Datei. |
x-ms-client-request-id |
Kann verwendet werden, um Anforderungen und entsprechende Antworten zu behandeln. Der Wert dieses Headers entspricht dem Wert des x-ms-client-request-id Headers, wenn er in der Anforderung vorhanden ist. Der Wert ist höchstens 1.024 sichtbare ASCII-Zeichen. Wenn der x-ms-client-request-id Header in der Anforderung nicht vorhanden ist, ist er in der Antwort nicht vorhanden. |
Antworttext
Keine.
Authorization
Nur der Kontobesitzer kann diesen Vorgang aufrufen.
Dateisystemattribute
attribute | Win32-Dateiattribute | Definition |
---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Ein verzeichnis, das schreibgeschützt ist. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Das Verzeichnis ist ausgeblendet. Es ist nicht in einer normalen Verzeichnisliste enthalten. |
System |
FILE_ATTRIBUTE_SYSTEM | Ein Verzeichnis, von dem das Betriebssystem einen Teil oder ausschließlich verwendet. |
None |
FILE_ATTRIBUTE_NORMAL | Ein Verzeichnis, in dem keine anderen Attribute festgelegt sind. Dieses Attribut ist nur gültig, wenn es allein verwendet wird. |
Directory |
FILE_ATTRIBUTE_DIRECTORY | Das Handle, das ein Verzeichnis identifiziert. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Ein Verzeichnis, das ein Archivverzeichnis ist. Anwendungen verwenden dieses Attribut in der Regel, um Dateien für die Sicherung oder Entfernung zu markieren. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Die Daten eines Verzeichnisses sind nicht sofort verfügbar. Dieses Dateisystemattribute wird in erster Linie angezeigt, um die Kompatibilität mit Windows zu gewährleisten. Azure Files unterstützt keine Offlinespeicheroptionen. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Das Verzeichnis soll nicht vom Inhaltsindizierungsdienst indiziert werden. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Der Benutzerdatenstrom darf nicht vom Hintergrunddatenintegritätsscanner gelesen werden. Dieses Dateisystemattribute wird in erster Linie angezeigt, um die Kompatibilität mit Windows zu gewährleisten. |
Hinweise
Wenn das Ziel ein Verzeichnis ist, darf das Verzeichnis nicht vorhanden sein.
Rename Directory
wird nicht für eine Freigabe Momentaufnahme unterstützt, bei der es sich um eine schreibgeschützte Kopie einer Freigabe handelt. Wenn Sie versuchen, diesen Vorgang für eine Freigabe Momentaufnahme auszuführen, gibt der Dienst den Fehler status 400 (Ungültiger Abfrageparameterwert) zurück.
Wenn Sie keine Eigenschaften angeben, wird das Standardverhalten von preserve
oder now
festgelegt.
Wenn das Verzeichnis über eine aktive Lease verfügt, muss der Client eine gültige Lease-ID für die Anforderung angeben, um das Verzeichnis umzubenennen. Wenn der Client keine Lease-ID angibt oder eine ungültige Lease-ID angibt, gibt Azure Files status Code 412 (Vorbedingung fehlgeschlagen) zurück. Wenn der Client eine Lease-ID angibt, das Verzeichnis aber keine aktive Lease aufweist, gibt Azure Files auch status Code 412 (Vorbedingung fehlgeschlagen) zurück.