Naam van bestand wijzigen
De Rename File bewerking wijzigt de naam van een bestand en kan desgewenst systeemeigenschappen voor het bestand instellen. Deze API is beschikbaar in versie 2021-04-10 en hoger.
Beschikbaarheid van protocol
| Protocol voor bestandsshare ingeschakeld | Beschikbaar |
|---|---|
| SMB |
|
| NFS |
|
Verzoek
U kunt de Rename File aanvraag als volgt samenstellen. HTTPS wordt aanbevolen.
| Methode | Aanvraag-URI | HTTP-versie |
|---|---|---|
| ZETTEN | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Vervang de padonderdelen in de aanvraag-URI als volgt door uw eigen padonderdelen:
| Padonderdeel | Beschrijving |
|---|---|
myaccount |
De naam van uw opslagaccount. |
myshare |
De naam van uw bestandsshare. |
mydirectorypath |
Facultatief. Het pad naar de bovenliggende doelmap. |
myfile |
De naam van het doelbestand. |
Zie Naamgeving en verwijzingen naar shares, mappen, bestanden en metagegevensvoor meer informatie over padnaamgevingsbeperkingen.
URI-parameters
U kunt de volgende extra parameter opgeven voor de aanvraag-URI.
| Parameter | Beschrijving |
|---|---|
timeout |
Facultatief. De parameter timeout wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files-bewerkingenvoor meer informatie. |
Aanvraagheaders
In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.
| Aanvraagheader | Beschrijving |
|---|---|
Authorization |
Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening op. Zie Aanvragen autoriseren voor Azure Storagevoor meer informatie. |
Date of x-ms-date |
Vereist. Hiermee geeft u de Coordinated Universal Time (UTC) voor de aanvraag. Zie Aanvragen autoriseren voor Azure Storagevoor meer informatie. |
x-ms-version |
Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking die moet worden gebruikt voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-servicesvoor meer informatie. |
x-ms-file-rename-source:name |
Vereist. Volledige URI van het bestand waarvan de naam moet worden gewijzigd. |
x-ms-file-rename-replace-if-exists |
Facultatief. Als het doelbestand al bestaat, overschrijft u het bestand. |
x-ms-file-rename-ignore-readonly |
Facultatief. Als het doelbestand bestaat met het kenmerk readonly, overschrijft u het bestand.Indien waar, moet x-ms-file-rename-replace-if-exists ook waar zijn. |
x-ms-content-Type |
Facultatief. Hiermee stelt u het inhoudstype van het bestand in. Als deze eigenschap niet is opgegeven in de aanvraag, blijft de eigenschap behouden voor het bestand. |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
Optioneel als x-ms-file-permission-key niet is opgegeven. Deze machtiging is de beveiligingsdescriptor voor het bestand dat is opgegeven in de Security Descriptor Definition Language (SDDL) of (versie 2024-11-04 of hoger) in base64-gecodeerde binaire beveiligingsdescriptorindeling. U kunt opgeven welke indeling moet worden gebruikt met de x-ms-file-permission-format-header. U kunt deze header gebruiken als de grootte van de machtigingen 8 kibibytes (KiB) of kleiner is. Anders kunt u x-ms-file-permission-keygebruiken. 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 houden.Houd er rekening mee dat u x-ms-file-permission of x-ms-file-permission-keykunt opgeven, niet beide. |
x-ms-file-permission-format: { sddl ¦ binary } |
Facultatief. Versie 2024-11-04 of hoger. Hiermee geeft u op of de waarde die is doorgegeven in x-ms-file-permission zich in SDDL of in binaire indeling bevindt. Als x-ms-file-permission-key is ingesteld op preserve, mag deze header niet worden ingesteld. Als x-ms-file-permission-key is ingesteld op een andere waarde dan preserveen als deze header niet is ingesteld, wordt de standaardwaarde van sddl gebruikt. |
x-ms-file-permission-key |
Optioneel als x-ms-file-permission niet is opgegeven. De sleutel van de machtiging die moet worden ingesteld voor het bestand. U kunt dit maken met behulp van de Create-Permission-API.Houd er rekening mee dat u x-ms-file-permission of x-ms-file-permission-keykunt opgeven, niet beide. |
x-ms-file-attributes |
Facultatief. De kenmerken van het bestandssysteem die op het bestand moeten worden ingesteld. Zie de lijst met beschikbare kenmerken. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt houden. Als u deze eigenschap niet opgeeft in de aanvraag, blijft de eigenschap behouden voor het bestand. |
x-ms-file-creation-time |
Facultatief. De eigenschap UTC-aanmaaktijd voor een bestand. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt houden. Als u deze eigenschap niet opgeeft in de aanvraag, blijft de eigenschap behouden voor het bestand. |
x-ms-file-last-write-time |
Facultatief. De laatste schrijfeigenschap UTC voor een bestand. U kunt een waarde van preserve doorgeven als u een bestaande waarde ongewijzigd wilt houden. Als u deze eigenschap niet opgeeft in de aanvraag, blijft de eigenschap behouden voor het bestand. |
x-ms-source-lease-id:<ID> |
Vereist als het bronbestand een actieve lease heeft. |
x-ms-destination-lease-id:<ID> |
Vereist als het doelbestand een actieve lease heeft. |
x-ms-client-request-id |
Facultatief. Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet van 1 kibibyte (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 |
Facultatief. Hiermee stelt u een naam-waardepaar in voor het bestand. Elke aanroep van deze bewerking vervangt alle bestaande metagegevens die aan het bestand zijn gekoppeld. Namen van metagegevens moeten voldoen aan de naamgevingsregels voor C#-id's. |
x-ms-file-request-intent |
Vereist als Authorization 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 moeten worden verleend als ze 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> } |
Facultatief. Versie 2022-11-02 en hoger. De Booleaanse waarde geeft aan of een volgpunt aanwezig in de aanvraag-URL moet worden ingekort of niet. Zie Shares, mappen, bestanden en metagegevensvoor meer informatie. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Facultatief. Versie 2022-11-02 en hoger. De Booleaanse waarde geeft aan of een volgpunt in de bron-URL moet worden ingekort of niet. Deze header moet alleen worden opgegeven als de kopieerbron een Azure-bestand is. Deze header wordt niet ondersteund voor een ander kopieerbrontype. Zie Shares, mappen, bestanden en metagegevensvoor 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 foutcodesvoor meer informatie over statuscodes.
Antwoordheaders
Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook aanvullende, standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.
| Antwoordheader | Beschrijving |
|---|---|
ETag |
Bevat een waarde die de versie van het bestand vertegenwoordigt, tussen aanhalingstekens. |
Last-Modified |
Retourneert de datum en tijd waarop het bestand het laatst is gewijzigd. Zie Weergave van datum/tijd-waarden in koptekstenvoor meer informatie. Elke bewerking die de map of de eigenschappen ervan wijzigt, werkt de laatste wijzigingstijd bij. Bewerkingen op bestanden hebben geen invloed op de laatste wijzigingstijd van de map. |
x-ms-request-id |
Identificeer de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossenvoor meer informatie. |
x-ms-version |
Geeft de versie van Azure Files aan die wordt 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 is ingesteld op true als de inhoud van de aanvraag is versleuteld met behulp van het opgegeven algoritme. Anders is 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. Zie 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 datum/tijd-waarde van UTC die de eigenschap voor de laatste schrijftijd voor het bestand vertegenwoordigt. |
x-ms-file-change-time |
De UTC-datum/tijd die de waarde vertegenwoordigt 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 antwoord
Geen.
Machtiging
Alleen de accounteigenaar kan deze bewerking aanroepen.
Bestandssysteemkenmerken
| Attribuut | Win32-bestandskenmerk | Definitie |
|---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Een bestand dat het kenmerk Alleen-lezen heeft. Toepassingen kunnen het bestand lezen, maar kunnen er niet naar schrijven of verwijderen. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Het bestand is verborgen. Het is niet opgenomen in een gewone lijst met mappen. |
System |
FILE_ATTRIBUTE_SYSTEM | Een bestand waarvan het besturingssysteem een deel van of uitsluitend gebruikt. |
None |
FILE_ATTRIBUTE_NORMAL | Een bestand waarvoor geen andere kenmerken zijn ingesteld. Dit kenmerk is alleen geldig wanneer dit alleen wordt gebruikt. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Een bestand dat een archiefbestand is. Toepassingen gebruiken dit kenmerk doorgaans om bestanden te markeren voor back-up of verwijdering. |
Temporary |
FILE_ATTRIBUTE_TEMPORARY | Een bestand dat wordt gebruikt voor tijdelijke opslag. |
Offline |
FILE_ATTRIBUTE_OFFLINE | De gegevens van een bestand 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 | Het bestand moet niet worden geïndexeerd door de inhoudsindexeringsservice. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | De gegevensstroom van de gebruiker hoeft niet te worden gelezen door de scanner voor gegevensintegriteit op de achtergrond. Dit bestandssysteemkenmerk wordt voornamelijk gepresenteerd om compatibiliteit met Windows te bieden. |
Opmerkingen
Het doel kan geen bestaande map zijn.
Als u geen eigenschappen opgeeft, wordt het standaardgedrag van preserve of now ingesteld.
Notitie
De voorgaande bestandseigenschappen zijn gescheiden van de eigenschappen van het bestandssysteem die beschikbaar zijn voor SMB-clients. SMB-clients kunnen deze eigenschapswaarden niet lezen, schrijven of wijzigen.
Rename File wordt niet ondersteund op een momentopname van een share. Dit is een alleen-lezen kopie van een share. Als u deze bewerking probeert uit te voeren op een momentopname van een share, retourneert de service de foutstatus 400 (ongeldige queryparameterwaarde).
Als het bestand een actieve lease heeft, moet de client een geldige lease-id voor de aanvraag opgeven om de naam van het bestand 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 het bestand geen actieve lease heeft, retourneert Azure Files ook statuscode 412 (Voorwaarde mislukt).