Obtention de métadonnées de partage
L’opération Get Share Metadata retourne toutes les métadonnées définies par l’utilisateur pour le partage de fichiers Azure ou le partage instantané.
Bien que cette API soit entièrement prise en charge, il s’agit d’une API de gestion héritée. Pour cette raison, nous vous recommandons d’utiliser partages de fichiers - Get, qui est fourni 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 partages de fichiers Azure.
Disponibilité du protocole
| Protocole de partage de fichiers activé | Disponible |
|---|---|
| SMB |
|
| NFS |
|
Requête
La demande Get Share Metadata est construite comme suit. Nous vous recommandons d’utiliser HTTPS.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime> |
HTTP/1.1 |
Remplacez les composants de chemin d’accès qui sont affichés dans l’URI de requête par le vôtre, comme suit :
| Composant Chemin d’accès | 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 Partages de noms et de référence, répertoires, fichiers et métadonnées.
Paramètres URI
Les paramètres supplémentaires suivants peuvent être spécifiés dans l’URI de demande :
| Paramètre | Description |
|---|---|
sharesnapshot |
facultatif. Version 2017-04-17 et versions ultérieures. Le sharesnapshot paramètre est une valeur de date/heure opaque qui, lorsqu’elle est présente, spécifie le partage instantané à interroger pour récupérer les métadonnées |
timeout |
Optionnel. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définir des délais d’attente pour les opérations Azure Files. |
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-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 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 Azure Files. |
x-ms-lease-id:<ID> |
Optionnel. Version 2020-02-10 et ultérieures. Si l’en-tête est spécifié, l’opération n’est effectuée que si le bail du partage de fichiers est actuellement actif et que l’ID de bail spécifié dans la demande correspond à l’ID de bail du partage de fichiers. S’il n’y a aucune correspondance, l’opération échoue avec status code 412 (Échec de la condition préalable). |
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 |
|---|---|
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ésenter les 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 dernière modification du partage. |
x-ms-meta-name:value |
Ensemble de paires nom-valeur qui contiennent des métadonnées définies par l’utilisateur pour le partage. |
ETag |
Contient une valeur que vous pouvez utiliser pour effectuer des opérations conditionnelles. 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 Azure Files 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-client-request-id |
Peut être utilisé pour résoudre les demandes et leurs 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.
Exemple de réponse
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: somemetadata
Date: Mon, 27 Jan 2014 22:49:18 GMT
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT
x-ms-version: 2014-02-14
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Autorisation
Seul le propriétaire du compte peut appeler cette opération.
Notes
Cette opération renvoie uniquement les métadonnées définies par l'utilisateur pour le partage. Pour retourner également des propriétés système, appelez Obtenir les propriétés du partage.