Renommer le fichier
L’opération Rename File
renomme un fichier et peut éventuellement définir les propriétés système du fichier. Cette API est disponible dans la version 2021-04-10 et ultérieure.
Disponibilité du protocole
Protocole de partage de fichiers activé | Disponible |
---|---|
SMB | |
NFS |
Requête
Vous pouvez construire la Rename File
requête comme suit. HTTPS est recommandé.
Méthode | URI de demande | Version HTTP |
---|---|---|
PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Remplacez les composants du chemin indiqués dans l'URI de la demande par les vôtres, comme suit :
Composant Chemin d’accès | Description |
---|---|
myaccount |
nom de votre compte de stockage. |
myshare |
Nom du partage de fichiers. |
mydirectorypath |
facultatif. Chemin d’accès au répertoire cible parent. |
myfile |
Nom du fichier cible. |
Pour plus d’informations sur les restrictions de nommage de chemin d’accès, consultez Nommer et référencer des partages, des répertoires, des fichiers et des métadonnées.
Paramètres URI
Vous pouvez spécifier le paramètre supplémentaire suivant sur l’URI de demande.
Paramètre | Description |
---|---|
timeout |
facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définition de délais d’expiration pour les opérations Azure Files. |
En-têtes de requête
Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.
En-tête de requête | Description |
---|---|
Authorization |
Obligatoire. Spécifie le schéma d’autorisation, le nom du compte et la signature. Pour plus d’informations, consultez Autoriser les requêtes auprès du Stockage Azure. |
Date ou x-ms-date |
Obligatoire. Spécifie la date/heure en temps universel coordonné (UTC) pour la requête. Pour plus d’informations, consultez Autoriser les requêtes auprès du Stockage Azure. |
x-ms-version |
Obligatoire pour toutes les demandes autorisées. Spécifie la version de l'opération à utiliser pour cette demande. Pour plus d'informations, consultez la page Contrôle de version pour les services de Stockage Microsoft Azure. |
x-ms-file-rename-source:name |
Obligatoire. URI complet du fichier à renommer. |
x-ms-file-rename-replace-if-exists |
facultatif. Si le fichier de destination existe déjà, remplacez le fichier. |
x-ms-file-rename-ignore-readonly |
facultatif. Si le fichier de destination existe avec l’attribut readonly , remplacez le fichier.Si la valeur est true, x-ms-file-rename-replace-if-exists doit également être true. |
x-ms-content-Type |
facultatif. Définit le type de contenu du fichier. Si cette propriété n’est pas spécifiée dans la demande, la propriété est conservée pour le fichier. |
x-ms-file-permission |
Facultatif si x-ms-file-permission-key n’est pas spécifié. Cette autorisation est le descripteur de sécurité pour le fichier spécifié dans le langage SDDL (Security Descriptor Definition Language). Vous pouvez utiliser cet en-tête si la taille des autorisations est de 8 kibioctets (Kio) ou moins. Sinon, vous pouvez utiliser x-ms-file-permission-key . Si elle est spécifiée, cette autorisation doit avoir un propriétaire, un groupe et une liste de contrôle d’accès discrétionnaire. Vous pouvez passer une valeur de preserve si vous souhaitez conserver une valeur existante inchangée.Notez que vous pouvez spécifier ou x-ms-file-permission x-ms-file-permission-key , et non les deux. |
x-ms-file-permission-key |
Facultatif si x-ms-file-permission n’est pas spécifié. Clé de l’autorisation à définir pour le fichier. Vous pouvez le créer à l’aide de l’API Create-Permission .Notez que vous pouvez spécifier ou x-ms-file-permission x-ms-file-permission-key , et non les deux. |
x-ms-file-attributes |
facultatif. Attributs du système de fichiers à définir sur le fichier. Consultez la liste des attributs disponibles. Vous pouvez passer une valeur de preserve si vous souhaitez conserver une valeur existante inchangée. Si vous ne spécifiez pas cette propriété sur la demande, la propriété sera conservée pour le fichier. |
x-ms-file-creation-time |
facultatif. Propriété d’heure de création UTC d’un fichier. Vous pouvez passer une valeur de preserve si vous souhaitez conserver une valeur existante inchangée. Si vous ne spécifiez pas cette propriété sur la demande, la propriété sera conservée pour le fichier. |
x-ms-file-last-write-time |
facultatif. Propriété UTC de la dernière écriture d’un fichier. Vous pouvez passer une valeur de preserve si vous souhaitez conserver une valeur existante inchangée. Si vous ne spécifiez pas cette propriété sur la demande, la propriété sera conservée pour le fichier. |
x-ms-source-lease-id:<ID> |
Obligatoire si le fichier source a un bail actif. |
x-ms-destination-lease-id:<ID> |
Obligatoire si le fichier de destination a un bail actif. |
x-ms-client-request-id |
facultatif. Fournit une valeur opaque générée par le client avec une limite de caractères de 1 kibioctet (Kio) enregistrée dans les journaux lors de la configuration de la journalisation. Nous vous recommandons vivement d’utiliser cet en-tête pour mettre en corrélation les activités côté client avec les demandes reçues par le serveur. Pour plus d’informations, consultez Surveiller Stockage Blob Azure. |
x-ms-meta-name:value |
facultatif. Définit une paire nom-valeur pour le fichier. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au fichier. Les noms de métadonnées doivent respecter les règles de nommage des identificateurs C#. |
x-ms-file-request-intent |
Obligatoire si Authorization l’en-tête spécifie un jeton OAuth. La valeur acceptable est backup . Cet en-tête spécifie que le Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ou Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action doit être accordé s’il est inclus dans la stratégie RBAC affectée à l’identité autorisée à l’aide de l’en-tête Authorization . Disponible pour les versions 2022-11-02 et ultérieures. |
x-ms-allow-trailing-dot: { <Boolean> } |
facultatif. Version 2022-11-02 et ultérieures. La valeur booléenne spécifie si un point de fin présent dans l’URL de la demande doit être supprimé ou non. Pour plus d’informations, consultez Affectation de noms et référencement de partages, de répertoires, de fichiers et de métadonnées. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
facultatif. Version 2022-11-02 et ultérieures. La valeur booléenne spécifie si un point de fin présent dans l’URL source doit être supprimé ou non. Cet en-tête doit être spécifié uniquement si la source de copie est un fichier Azure. Cet en-tête n’est pas pris en charge pour tout autre type de source de copie. Pour plus d’informations, consultez Affectation de noms et référencement de partages, de répertoires, de fichiers et de métadonnées. |
Corps de la demande
Aucun.
response
La réponse inclut un code d'état HTTP et un ensemble d'en-têtes de réponse.
Code d’état
Une opération réussie envoie le code d'état 200 (OK). Pour plus d’informations sur les codes status, consultez Codes d’état et d’erreur.
En-têtes de réponse
La réponse de l'opération inclut les en-têtes suivants. La réponse peut également inclure des en-têtes HTTP standard supplémentaires. Tous les en-têtes standard sont conformes à la spécification du protocole HTTP/1.1.
En-tête de réponse | Description |
---|---|
ETag |
Contient une valeur qui représente la version du fichier, entre guillemets. |
Last-Modified |
Renvoie la date et l'heure de dernière modification du fichier. Pour plus d’informations, consultez Représentation des valeurs date-heure dans les en-têtes. Toute opération qui modifie le répertoire, ou ses propriétés, met à jour l’heure de la dernière modification. Les opérations sur les fichiers n’affectent pas l’heure de la dernière modification du répertoire. |
x-ms-request-id |
Identifie de manière unique la requête qui a été effectuée et peut être utilisée pour la résolution des problèmes de la demande. Pour plus d’informations, consultez Résolution des problèmes liés aux opérations d’API. |
x-ms-version |
Indique la version de Azure Files utilisée pour exécuter la demande. |
Date ou x-ms-date |
Valeur de date/heure UTC qui indique l’heure à laquelle la réponse a été lancée. Le service génère cette valeur. |
x-ms-request-server-encrypted: true/false |
La valeur de cet en-tête est définie true sur si le contenu de la requête est correctement chiffré à l’aide de l’algorithme spécifié. Sinon, la valeur est false . |
x-ms-file-permission-key |
Clé de l’autorisation du fichier. |
x-ms-file-attributes |
Attributs du système de fichiers sur le fichier. Consultez la liste des attributs disponibles. |
x-ms-file-creation-time |
Valeur de date/heure UTC qui représente la propriété d’heure de création du fichier. |
x-ms-file-last-write-time |
Valeur de date/heure UTC qui représente la propriété d’heure de la dernière écriture pour le fichier. |
x-ms-file-change-time |
Date/heure UTC qui représente la propriété d’heure de modification pour le fichier. |
x-ms-file-file-id |
ID de fichier du fichier. |
x-ms-file-parent-id |
ID de fichier parent du fichier. |
x-ms-client-request-id |
Peut être utilisé pour résoudre les problèmes liés aux demandes et aux réponses correspondantes. La valeur de cet en-tête est égale à la valeur de l’en-tête x-ms-client-request-id , s’il est présent dans la requête. La valeur est au maximum de 1 024 caractères ASCII visibles. Si l’en-tête x-ms-client-request-id n’est pas présent dans la demande, il ne sera pas présent dans la réponse. |
Response body
Aucun.
Autorisation
Seul le propriétaire du compte peut appeler cette opération.
Attributs du système de fichiers
Attribut | Attribut de fichier Win32 | Définition |
---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Fichier en lecture seule. Les applications peuvent lire le fichier, mais ne peuvent pas y écrire ou le supprimer. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | Le fichier est masqué. Il n’est pas inclus dans une liste d’annuaires ordinaire. |
System |
FILE_ATTRIBUTE_SYSTEM | Fichier dont le système d’exploitation utilise une partie ou utilise exclusivement. |
None |
FILE_ATTRIBUTE_NORMAL | Fichier qui n’a pas d’autres attributs définis. Cet attribut est uniquement valide quand il est utilisé seul. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Fichier qui est un fichier d’archive. Les applications utilisent généralement cet attribut pour marquer les fichiers à des fins de sauvegarde ou de suppression. |
Temporary |
FILE_ATTRIBUTE_TEMPORARY | Fichier utilisé pour le stockage temporaire. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Les données d’un fichier ne sont pas disponibles immédiatement. Cet attribut de système de fichiers est présenté principalement pour assurer la compatibilité avec Windows. Azure Files ne prend pas en charge les options de stockage hors connexion. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | Le fichier ne doit pas être indexé par le service d’indexation de contenu. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | Le flux de données utilisateur ne doit pas être lu par le scanneur d’intégrité des données d’arrière-plan. Cet attribut de système de fichiers est présenté principalement pour assurer la compatibilité avec Windows. |
Remarques
La cible ne peut pas être un répertoire existant.
Si vous ne spécifiez pas de propriétés, le comportement par défaut de preserve
ou now
est défini.
Notes
Les propriétés de fichier précédentes sont distinctes des propriétés du système de fichiers disponibles pour les clients SMB. Les clients SMB ne peuvent pas lire, écrire ou modifier ces valeurs de propriété.
Rename File
n’est pas pris en charge sur un partage instantané, qui est une copie en lecture seule d’un partage. Si vous tentez d’effectuer cette opération sur un partage instantané, le service retourne l’erreur status 400 (valeur de paramètre de requête non valide).
Si le fichier a un bail actif, le client doit spécifier un ID de bail valide sur la demande afin de renommer le fichier. Si le client ne spécifie pas d’ID de bail ou spécifie un ID de bail non valide, Azure Files retourne status code 412 (échec de la condition préalable). Si le client spécifie un ID de bail, mais que le fichier n’a pas de bail actif, Azure Files retourne également status code 412 (échec de la condition préalable).