Naam van map wijzigen
De Rename Directory bewerking wijzigt de naam van een map en kan desgewenst systeemeigenschappen voor de map instellen. Deze API is beschikbaar in versie 2021-04-10 en hoger.
Protocol beschikbaarheid
| Bestandsshareprotocol ingeschakeld | Beschikbaar |
|---|---|
| SMB |  |
| NFS |  |
Aanvraag
U kunt de Rename Directory aanvraag als volgt samenstellen. HTTPS wordt aanbevolen.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename |
HTTP/1.1 |
Vervang de padonderdelen die in de aanvraag-URI worden weergegeven, als volgt door uw eigen:
| Padonderdeel | Description |
|---|---|
myaccount |
De naam van uw opslagaccount. |
myshare |
De naam van de bestandsshare. |
mydirectorypath |
Optioneel. Het pad naar de bovenliggende map. |
mydirectory |
De naam van de doelmap. |
Zie Shares, mappen, bestanden en metagegevens een naam geven en hiernaar verwijzen voor meer informatie over beperkingen voor padnamen.
URI-parameters
U kunt de volgende extra parameter opgeven voor de aanvraag-URI.
| Parameter | Beschrijving |
|---|---|
timeout |
Optioneel. De timeout parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files bewerkingen voor meer informatie. |
Aanvraagheaders
In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.
| Aanvraagheader | Beschrijving |
|---|---|
Authorization |
Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie. |
Date of x-ms-date |
Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie. |
x-ms-version |
Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie. |
x-ms-file-rename-source:name |
Vereist. Volledige URI van de map waarvan de naam moet worden gewijzigd. |
x-ms-file-rename-ignore-readonly |
Optioneel. Als de doelmap bestaat met het readonly kenmerk, overschrijft u de map.Indien waar, x-ms-file-rename-replace-if-exists moet ook waar zijn. |
x-ms-file-permission |
Optioneel als x-ms-file-permission-key niet is opgegeven. Deze machtiging is de beveiligingsdescriptor voor de map die is opgegeven in de Security Descriptor Definition Language (SDDL). U kunt deze header gebruiken als de machtigingsgrootte 8 kibibytes (KiB) of minder is. Anders kunt u gebruiken x-ms-file-permission-key. Indien opgegeven, moet deze machtiging een eigenaar, groep en discretionaire toegangsbeheerlijst hebben. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt laten.Houd er rekening mee dat u of x-ms-file-permissionx-ms-file-permission-keykunt opgeven, niet beide. |
x-ms-file-permission-key |
Optioneel als x-ms-file-permission niet is opgegeven. De sleutel van de machtiging die moet worden ingesteld voor de map. U kunt dit maken met behulp van de Create-Permission API.Houd er rekening mee dat u of x-ms-file-permissionx-ms-file-permission-keykunt opgeven, niet beide. |
x-ms-file-attributes |
Optioneel. De bestandssysteemkenmerken die moeten worden ingesteld voor de map. Bekijk de lijst met beschikbare kenmerken. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt laten. Als deze eigenschap niet is opgegeven in de aanvraag, blijft de eigenschap behouden. |
x-ms-file-creation-time |
Optioneel. De eigenschap UTC-aanmaaktijd voor een map. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt laten. Als deze eigenschap niet is opgegeven in de aanvraag, blijft de eigenschap behouden. |
x-ms-file-last-write-time |
Optioneel. De utc-laatste schrijfeigenschap voor een map. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt laten. Als deze eigenschap niet is opgegeven in de aanvraag, blijft de eigenschap behouden. |
x-ms-destination-lease-id:<ID> |
Vereist als het doelbestand een actieve lease heeft. |
x-ms-client-request-id |
Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 KiB die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Blob Storage bewaken voor meer informatie. |
x-ms-meta-name:value |
Optioneel. Hiermee stelt u een naam-waardepaar in voor de map. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan de map zijn gekoppeld. Namen van metagegevens moeten voldoen aan de naamgevingsregels voor C#-id's. Als deze eigenschap niet is opgegeven in de aanvraag, blijft de eigenschap behouden. |
x-ms-file-request-intent |
Vereist als Authorization de header een OAuth-token opgeeft. Acceptabele waarde is backup. Deze header geeft aan dat de Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action of Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action moet worden verleend als deze zijn opgenomen in het RBAC-beleid dat is toegewezen aan de identiteit die is geautoriseerd met behulp van de Authorization header. Beschikbaar voor versie 2022-11-02 en hoger. |
x-ms-allow-trailing-dot: { <Boolean> } |
Optioneel. Versie 2022-11-02 en hoger. De Booleaanse waarde geeft aan of een volgpunt in de aanvraag-URL moet worden ingekort of niet. Zie Shares, mappen, bestanden en metagegevens een naam geven en hiernaar verwijzen voor meer informatie. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Optioneel. Versie 2022-11-02 en hoger. De Booleaanse waarde geeft aan of een afsluitende punt die aanwezig is in de bron-URL moet worden bijgesneden of niet. Deze header moet alleen worden opgegeven als de kopieerbron een Azure-bestandsshare is. Deze header wordt niet ondersteund voor een ander type kopieerbron. Zie Naamgeving en verwijzingen naar shares, mappen, bestanden en metagegevens voor meer informatie. |
Aanvraagbody
Geen.
Antwoord
Het antwoord bevat een HTTP-statuscode en een set antwoordheaders.
Statuscode
Een geslaagde bewerking retourneert statuscode 200 (OK). Zie Status- en foutcodes voor meer informatie over statuscodes.
Antwoordheaders
Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook extra, standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.
| Antwoordheader | Description |
|---|---|
ETag |
Bevat een waarde die de versie van het bestand vertegenwoordigt, tussen aanhalingstekens. |
Last-Modified |
Retourneert de datum en tijd waarop het bestand voor het laatst is gewijzigd. Zie Weergave van datum-tijdwaarden in kopteksten voor meer informatie. Elke bewerking die de map of de eigenschappen ervan wijzigt, wordt de laatste wijzigingstijd bijgewerkt. Bewerkingen op bestanden hebben geen invloed op het tijdstip van de laatste wijziging van de map. |
x-ms-request-id |
Identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossen voor meer informatie. |
x-ms-version |
Geeft de versie aan van Azure Files gebruikt om de aanvraag uit te voeren. |
Date of x-ms-date |
Een UTC-datum/tijd-waarde die de tijd aangeeft waarop het antwoord is gestart. De service genereert deze waarde. |
x-ms-request-server-encrypted: true/false |
De waarde van deze header wordt ingesteld op true als de inhoud van de aanvraag is versleuteld met behulp van het opgegeven algoritme. Anders wordt de waarde ingesteld op false. |
x-ms-file-permission-key |
De sleutel van de machtiging van het bestand. |
x-ms-file-attributes |
De kenmerken van het bestandssysteem in het bestand. Bekijk de lijst met beschikbare kenmerken. |
x-ms-file-creation-time |
De UTC-datum/tijd-waarde die de eigenschap aanmaaktijd voor het bestand vertegenwoordigt. |
x-ms-file-last-write-time |
De UTC-datum/tijd-waarde die de eigenschap laatste schrijftijd voor het bestand vertegenwoordigt. |
x-ms-file-change-time |
De UTC-datum/-tijdwaarde die de eigenschap wijzigingstijd voor het bestand vertegenwoordigt. |
x-ms-file-file-id |
De bestands-id van het bestand. |
x-ms-file-parent-id |
De bovenliggende bestands-id van het bestand. |
x-ms-client-request-id |
Kan worden gebruikt om problemen met aanvragen en bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de x-ms-client-request-id header, als deze aanwezig is in de aanvraag. De waarde is maximaal 1024 zichtbare ASCII-tekens. Als de x-ms-client-request-id header niet aanwezig is in de aanvraag, is deze niet aanwezig in het antwoord. |
Hoofdtekst van de reactie
Geen.
Autorisatie
Alleen de accounteigenaar kan deze bewerking aanroepen.
Bestandssysteemkenmerken
| Kenmerk | Win32-bestandskenmerk | Definitie |
|---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Een map met het kenmerk Alleen-lezen. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | De map is verborgen. Het is niet opgenomen in een gewone directory-vermelding. |
System |
FILE_ATTRIBUTE_SYSTEM | Een map waarvan het besturingssysteem een deel of uitsluitend gebruikt. |
None |
FILE_ATTRIBUTE_NORMAL | Een map waarvoor geen andere kenmerken zijn ingesteld. Dit kenmerk is alleen geldig wanneer deze alleen wordt gebruikt. |
Directory |
FILE_ATTRIBUTE_DIRECTORY | De ingang waarmee een map wordt geïdentificeerd. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Een map die een archiefmap is. Toepassingen gebruiken dit kenmerk doorgaans om bestanden te markeren voor back-up of verwijdering. |
Offline |
FILE_ATTRIBUTE_OFFLINE | De gegevens van een map zijn niet onmiddellijk beschikbaar. Dit bestandssysteemkenmerk wordt voornamelijk gepresenteerd om compatibiliteit met Windows te bieden. Azure Files biedt geen ondersteuning voor offlineopslagopties. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | De map mag niet worden geïndexeerd door de service voor inhoudsindexering. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | De gebruikersgegevensstroom mag niet worden gelezen door de scanner voor gegevensintegriteit op de achtergrond. Dit bestandssysteemkenmerk wordt voornamelijk gepresenteerd om compatibiliteit met Windows te bieden. |
Opmerkingen
Als het doel een map is, mag de map niet bestaan.
Rename Directory wordt niet ondersteund op een momentopname van een share, die een alleen-lezen kopie van een share is. Als u deze bewerking probeert uit te voeren op een momentopname van een share, retourneert de service foutstatus 400 (ongeldige queryparameterwaarde).
Als u geen eigenschappen opgeeft, wordt het standaardgedrag van preserve of now ingesteld.
Als de map een actieve lease heeft, moet de client een geldige lease-id voor de aanvraag opgeven om de naam van de map te wijzigen. Als de client geen lease-id opgeeft of een ongeldige lease-id opgeeft, retourneert Azure Files statuscode 412 (Voorwaarde mislukt). Als de client een lease-id opgeeft, maar de map geen actieve lease heeft, retourneert Azure Files ook statuscode 412 (Voorwaarde mislukt).