Définition de métadonnées de partage

L’opération Set Share Metadata définit une ou plusieurs paires nom/valeur définies par l’utilisateur pour le partage spécifié. Bien que cette opération soit entièrement prise en charge, il s’agit d’une opération de gestion héritée. Nous vous recommandons d’utiliser l’opération Partages de fichiers - Mise à jour fournie par le fournisseur de ressources de stockage (Microsoft.Storage) à la place. Pour en savoir plus sur l’interaction programmatique avec FileShare les ressources à l’aide du fournisseur de ressources de stockage, consultez Opérations sur les ressources FileShare.

Disponibilité du protocole

Protocole de partage de fichiers activé Disponible
SMB Oui
NFS Yes

Requête

Vous construisez la Set Share Metadata requête comme suit. Nous recommandons HTTPS. Remplacez myaccount par le nom de votre compte de stockage.

Méthode URI de demande Version HTTP
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1

Remplacez les composants du chemin indiqués dans l'URI de la demande par les vôtres, comme suit :

Composant Path Description
myaccount nom de votre compte de stockage.
myshare Nom du partage de fichiers.

Pour plus d’informations sur les restrictions de nommage de chemin d’accès, consultez Affectation de noms et référencement de partages, 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. Exprimée en secondes. Pour plus d’informations, consultez Définir des délais d’expiration pour les opérations de 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 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 Optionnel. Fournit une paire nom/valeur pour contenir des métadonnées pour le partage.

Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au partage. Pour supprimer toutes les métadonnées du partage, 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-client-request-id Optionnel. 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 Storage Analytics 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 Stockage Blob Azure.
x-ms-lease-id:<ID> Obligatoire si le partage de fichiers de destination a un bail actif. Disponible pour les versions 2020-02-10 et ultérieures. Si la demande n’inclut pas l’ID de bail ou s’il n’est pas valide, l’opération échoue avec status code 412 (échec de la condition préalable).

Si cet en-tête est spécifié et que le partage de fichiers de destination n’a pas de bail actif, l’opération échoue avec status code 412 (échec de la condition préalable).

Corps de la demande

Aucun.

Exemple de requête

PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
x-ms-meta-Category: Images  
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=  

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
Last-Modified Retourne la date et l’heure de la dernière modification du partage. Le format de date est conforme à la RFC 1123. Pour plus d’informations, consultez Représentation des valeurs de date/heure dans les en-têtes. Toute opération qui modifie le partage ou ses propriétés entraîne la mise à jour de l'heure de la dernière modification. Les opérations sur les fichiers n’affectent pas l’heure de la dernière modification du partage.
ETag Contient une valeur qui représente la version du partage, entre guillemets.
x-ms-request-id Identifie de manière unique la demande qui a été effectuée. Vous pouvez l’utiliser pour résoudre les problèmes liés à 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 de Azure Files qui a été utilisée pour exécuter la demande.
Date ou x-ms-date Valeur de date/heure UTC qui indique l’heure à laquelle le service a envoyé la réponse.
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 , si elle est présente dans la requête et que 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, cet en-tête ne sera pas présent dans la réponse.

Response body

Aucun.

Autorisation

Seul le propriétaire du compte peut appeler cette opération.

Notes

L’appel Set Share Metadata remplace toutes les métadonnées existantes associées au partage. Il n’est pas possible de modifier une paire nom/valeur individuelle.

Vous pouvez également définir les métadonnées d’un partage au moment de sa création, dans le cadre de l’opération Créer un partage .

L’appel Set Share Metadata met à jour les ETag propriétés et Last-Modified-Time pour le partage.

Set Share Metadatan’est pas pris en charge pour un partage instantané. Une tentative d’exécution de cette opération sur un partage instantané échouera avec status code 400 (InvalidQueryParameterValue). Vous pouvez définir des métadonnées pour un partage instantané au moment de sa création, dans le cadre de l’opérationSnapshot Share.

Voir aussi

Opérations sur les ressources FileShare (Azure Files)