Définition des métadonnées d'un fichier
L’opération Set File Metadata définit les métadonnées définies par l’utilisateur pour le fichier spécifié.
Disponibilité du protocole
| Protocole de partage de fichiers activé | Disponible |
|---|---|
| SMB |
|
| NFS |
|
Requête
Vous pouvez construire la Set File Metadata requête comme suit. Nous vous recommandons d’utiliser HTTPS.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
HTTP/1.1 |
Remplacez les composants de chemin d’accès affichés dans l’URI de requête par le vôtre, comme suit :
| Composant Path | Description |
|---|---|
myaccount |
nom de votre compte de stockage. |
myshare |
Nom du partage de fichiers. |
mydirectorypath |
facultatif. Chemin d'accès au répertoire parent. |
myfile |
Nom du fichier. |
Pour plus d’informations sur les restrictions de nommage de chemin d’accès, consultez Partages de noms et références, répertoires, fichiers et métadonnées.
Paramètres URI
Vous pouvez spécifier les paramètres supplémentaires suivants dans l’URI de requête :
| Paramètre | Description |
|---|---|
timeout |
facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définir des délais d’attente pour les opérations de service de fichiers. |
En-têtes de requête
| 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-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. Pour supprimer toutes les métadonnées du fichier, appelez cette opération sans en-tête de métadonnées. Les noms de métadonnées doivent respecter les règles d’affectation de noms pour les identificateurs C#. |
x-ms-lease-id:<ID> |
Obligatoire si le fichier a un bail actif. Disponible pour la version 2019-02-02 et ultérieure. |
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 que le serveur reçoit. Pour plus d’informations, consultez Surveiller Azure Files. |
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 la version 2022-11-02 et ultérieure. |
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. |
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 aussi 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. La valeur est placée entre guillemets. |
x-ms-request-id |
Identifie de manière unique la demande qui a été effectuée et peut être utilisée pour résoudre la demande. Pour plus d’informations, consultez Résoudre les problèmes liés aux opérations d’API. |
x-ms-version |
Indique la version du service De fichiers qui a été utilisée pour exécuter la demande. |
Date ou x-ms-date |
Valeur de date/heure UTC générée par le service, qui indique l’heure à laquelle la réponse a été lancée. |
x-ms-request-server-encrypted: true/false |
Version 2017-04-17 et ultérieures. La valeur de cet en-tête est définie sur si le contenu de la requête est correctement chiffré à true l’aide de l’algorithme spécifié. Sinon, la valeur est false. |
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 et que la valeur ne contient pas plus 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.
Remarques
Set File Metadatan’est pas pris en charge sur un partage instantané, qui est une copie en lecture seule d’un partage. Une tentative d’exécution de cette opération sur un partage instantané échoue avec 400 (InvalidQueryParameterValue)
Si le fichier a un bail actif, le client doit spécifier un ID de bail valide sur la demande afin d’écrire des métadonnées dans le fichier. Si le client ne spécifie pas d’ID de bail ou qu’il spécifie un ID de bail non valide, le service de fichiers 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, le service De fichiers retourne également status code 412 (échec de la condition préalable).