Renommer le répertoire

Article
08/07/2024

L’opération Rename Directory renomme un répertoire et peut éventuellement définir les propriétés système du répertoire. Cette API est disponible dans la version 2021-04-10 et versions ultérieures.

Disponibilité du protocole

Protocole de partage de fichiers activé	Disponible
SMB
NFS

Demander

Vous pouvez construire la requête Rename Directory comme suit. HTTPS est recommandé.

Méthode	URI de requête	Version HTTP
METTRE	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename`	HTTP/1.1

Remplacez les composants de chemin d’accès indiqués dans l’URI de requête par vos propres composants, comme suit :

Composant Path	Description
`myaccount`	Nom de votre compte de stockage.
`myshare`	Nom de votre partage de fichiers.
`mydirectorypath`	Optionnel. Chemin d’accès au répertoire parent.
`mydirectory`	Nom du répertoire cible.

Pour plus d’informations sur les restrictions de nommage de chemin d’accès, consultez nommage et référencement de partages, répertoires, fichiers et métadonnées.

Paramètres d’URI

Vous pouvez spécifier le paramètre supplémentaire suivant sur l’URI de requête.

Paramètre	Description
`timeout`	Optionnel. Le paramètre `timeout` est exprimé en secondes. Pour plus d’informations, consultez Définition des 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 requête obligatoires et 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 demandes vers le stockage Azure.
`Date` ou `x-ms-date`	Obligatoire. Spécifie le temps universel coordonné (UTC) de la requête. Pour plus d’informations, consultez Autoriser les demandes vers le stockage Azure.
`x-ms-version`	Obligatoire pour toutes les demandes autorisées. Spécifie la version de l’opération à utiliser pour cette requête. Pour plus d’informations, consultez Contrôle de version pour les services stockage Azure.
`x-ms-file-rename-source:name`	Obligatoire. URI complet du répertoire à renommer.
`x-ms-file-rename-ignore-readonly`	Optionnel. Si le répertoire de destination existe avec l’attribut `readonly`, remplacez le répertoire. Si la valeur est true, `x-ms-file-rename-replace-if-exists` doit également être vraie.
`x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> }`	Facultatif si `x-ms-file-permission-key` n’est pas spécifié. Cette autorisation est le descripteur de sécurité du répertoire spécifié dans le Security Descriptor Definition Language (SDDL) ou (version 2024-11-04 ou ultérieure) au format de descripteur de sécurité binaire en base64 format de descripteur de sécurité binaire. Vous pouvez spécifier le format à utiliser avec l’en-tête `x-ms-file-permission-format`. Vous pouvez utiliser cet en-tête si la taille des autorisations est de 8 kibioctets (KiB) 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 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 `x-ms-file-permission` ou `x-ms-file-permission-key`, pas les deux.
`x-ms-file-permission-format: { sddl ¦ binary }`	Optionnel. Version 2024-11-04 ou ultérieure. Spécifie si la valeur passée dans `x-ms-file-permission` est au format SDDL ou au format binaire. Si `x-ms-file-permission-key` est défini sur `preserve`, cet en-tête ne doit pas être défini. Si `x-ms-file-permission-key` est défini sur une autre valeur que `preserve`et si cet en-tête n’est pas défini, la valeur par défaut de `sddl` est utilisée.
`x-ms-file-permission-key`	Facultatif si `x-ms-file-permission` n’est pas spécifié. Clé de l’autorisation à définir pour le répertoire. Vous pouvez le créer à l’aide de l’API `Create-Permission`. Notez que vous pouvez spécifier `x-ms-file-permission` ou `x-ms-file-permission-key`, pas les deux.
`x-ms-file-attributes`	Optionnel. Attributs du système de fichiers à définir dans le répertoire. Consultez la liste des attributs disponibles . Vous pouvez passer une valeur de `preserve` si vous souhaitez conserver une valeur existante inchangée. Si cette propriété n’est pas spécifiée sur la demande, la propriété est conservée.
`x-ms-file-creation-time`	Optionnel. Propriété heure de création UTC d’un répertoire. Vous pouvez passer une valeur de `preserve` si vous souhaitez conserver une valeur existante inchangée. Si cette propriété n’est pas spécifiée sur la demande, la propriété est conservée.
`x-ms-file-last-write-time`	Optionnel. La dernière propriété d’écriture UTC pour un répertoire. Vous pouvez passer une valeur de `preserve` si vous souhaitez conserver une valeur existante inchangée. Si cette propriété n’est pas spécifiée sur la demande, la propriété est conservée.
`x-ms-destination-lease-id:<ID>`	Obligatoire si le fichier de destination a un bail actif.
`x-ms-client-request-id`	Optionnel. Fournit une valeur opaque générée par le client avec une limite de caractères de 1 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 Monitor Stockage Blob Azure.
`x-ms-meta-name:value`	Optionnel. Définit une paire nom-valeur pour le répertoire. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au répertoire. Les noms de métadonnées doivent respecter les règles d’affectation de noms pour les identificateurs C# . Si cette propriété n’est pas spécifiée sur la demande, la propriété est conservée.
`x-ms-file-request-intent`	Obligatoire si `Authorization` en-tête spécifie un jeton OAuth. La valeur acceptable est `backup`. Cet en-tête spécifie que les `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action` ou `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` doivent être accordés s’ils sont inclus dans la stratégie RBAC affectée à l’identité autorisée à l’aide de l’en-tête `Authorization`. Disponible pour la version 2022-11-02 et ultérieure.
`x-ms-allow-trailing-dot: { <Boolean> }`	Optionnel. Version 2022-11-02 et ultérieure. La valeur booléenne spécifie si un point de fin présent dans l’URL de requête doit être supprimé ou non. Pour plus d’informations, consultez nommage et référencement de partages, répertoires, fichiers et métadonnées.
`x-ms-source-allow-trailing-dot: { <Boolean> }`	Optionnel. Version 2022-11-02 et ultérieure. 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 partage de fichiers Azure. Cet en-tête n’est pris en charge pour aucun autre type de source de copie. Pour plus d’informations, consultez nommage et référencement de partages, répertoires, fichiers et métadonnées.

Corps de la demande

Aucun.

Réponse

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 retourne le code d’état 200 (OK). Pour plus d’informations sur les codes d’état, consultez Les codes d’état et d’erreur.

En-têtes de réponse

La réponse de cette opération inclut les en-têtes suivants. La réponse peut également inclure des en-têtes HTTP supplémentaires et standard. Tous les en-têtes standard sont conformes à la spécification de 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`	Retourne la date et l’heure de la 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 dernière modification. Les opérations sur les fichiers n’affectent pas l’heure de dernière modification du répertoire.
`x-ms-request-id`	Identifie de manière unique la demande qui a été effectuée et peut être utilisée pour résoudre les problèmes de la demande. Pour plus d’informations, consultez Résolution des problèmes des opérations d’API.
`x-ms-version`	Indique la version d’Azure Files utilisée pour exécuter la requête.
`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 sur `true` si le contenu de la requête est correctement chiffré à l’aide de l’algorithme spécifié. Sinon, la valeur est définie sur `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 dernière propriété d’heure d’écriture du fichier.
`x-ms-file-change-time`	Date/heure UTC qui représente la propriété d’heure de modification du 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 demandes et les réponses correspondantes. La valeur de cet en-tête est égale à la valeur de l’en-tête `x-ms-client-request-id`, si elle est présente 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 requête, il ne sera pas présent dans la réponse.

Corps de la réponse

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	Répertoire en lecture seule.
`Hidden`	FILE_ATTRIBUTE_HIDDEN	Le répertoire est masqué. Il n’est pas inclus dans une liste d’annuaires ordinaire.
`System`	FILE_ATTRIBUTE_SYSTEM	Répertoire dont le système d’exploitation utilise une partie ou utilise exclusivement.
`None`	FILE_ATTRIBUTE_NORMAL	Répertoire qui n’a pas d’autres attributs définis. Cet attribut est valide uniquement lorsqu’il est utilisé seul.
`Directory`	FILE_ATTRIBUTE_DIRECTORY	Handle qui identifie un répertoire.
`Archive`	FILE_ATTRIBUTE_ARCHIVE	Répertoire qui est un répertoire d’archive. Les applications utilisent généralement cet attribut pour marquer les fichiers pour la sauvegarde ou la suppression.
`Offline`	FILE_ATTRIBUTE_OFFLINE	Les données d’un répertoire 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 répertoire 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 en arrière-plan. Cet attribut de système de fichiers est présenté principalement pour assurer la compatibilité avec Windows.

Remarques

Si la cible est un répertoire, le répertoire ne doit pas exister.

Rename Directory n’est pas pris en charge sur un instantané de partage, qui est une copie en lecture seule d’un partage. Si vous tentez d’effectuer cette opération sur un instantané de partage, le service retourne l’état d’erreur 400 (valeur de paramètre de requête non valide).

Si vous ne spécifiez pas de propriétés, le comportement par défaut de preserve ou de now sera défini.

Si l’annuaire possède un bail actif, le client doit spécifier un ID de bail valide sur la demande pour renommer le répertoire. Si le client ne spécifie pas d’ID de bail ou spécifie un ID de bail non valide, Azure Files retourne le code d’état 412 (Échec de la condition préalable). Si le client spécifie un ID de bail, mais que le répertoire n’a pas de bail actif, Azure Files retourne également le code d’état 412 (Échec de la condition préalable).

Voir aussi

Opérations de sur les répertoires

Partager via