Obtenir les métadonnées d’annuaire

Article
03/29/2023

L’opération Get Directory Metadata retourne toutes les métadonnées définies par l’utilisateur pour le répertoire spécifié. Cette opération est prise en charge dans la version 2015-02-21 et ultérieure.

Disponibilité du protocole

Protocole de partage de fichiers activé	Disponible
SMB
NFS

Requête

Méthode	URI de demande	Version HTTP
GET/HEAD	`https://myaccount.file.core.windows.net/myshare/ myparentdirectorypath/mydirectory?restype=directory&comp=metadata`	HTTP/1.1
GET/HEAD	`https://myaccount.file.core.windows.net/myshare/ myparentdirectorypath/mydirectory?restype=directory&comp=metadata&sharesnapshot=<DateTime>`	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.
`myparentdirectorypath`	facultatif. Chemin d'accès au répertoire parent.
`mydirectory`	Nom du répertoire.

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

Les paramètres supplémentaires suivants peuvent être spécifiés sur l’URI de la demande :

Paramètre	Description
`sharesnapshot`	facultatif. Version 2017-04-17 et ultérieures. Le `sharesnapshot` paramètre est une valeur DateTime opaque qui, lorsqu’elle est présente, spécifie le partage instantané pour interroger les métadonnées du répertoire.
`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 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. Cette opération est disponible uniquement dans la version 2015-02-21 et ultérieure. Pour plus d'informations, consultez la page Contrôle de version pour les services de Stockage Microsoft Azure.
`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 n’est pas présent dans la réponse.
`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 renvoie le code d'état 202 (Accepté).

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`	L'ETag contient une valeur que vous pouvez utiliser pour exécuter des opérations conditionnellement. La valeur est placée entre guillemets.
`Last-Modified`	Renvoie la date et l'heure de la dernière modification du répertoire. Le format de date est conforme à la RFC 1123. Pour plus d’informations, consultez Représenter des valeurs de date/heure dans les en-têtes. N'importe quelle opération qui modifie le répertoire 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 répertoire.
`x-ms-meta-name:value`	Ensemble de paires nom-valeur qui contiennent des métadonnées pour le 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 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 qui a été utilisée pour exécuter la demande.
`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 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, cet en-tête n’est pas présent dans la réponse.

Response body