Obtenir les propriétés d'un fichier (Get File Properties)

L'opération Get File Properties renvoie toutes les métadonnées définies par l'utilisateur, les propriétés HTTP standard et les propriétés système pour le fichier. Il ne retourne pas le contenu du fichier.

Disponibilité du protocole

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

Requête

La demande Get File Properties peut être construite comme indiqué ci-dessous. Nous vous recommandons d’utiliser HTTPS.

Méthode URI de demande Version HTTP
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile HTTP/1.1
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?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.
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 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 sur l’URI de demande :

Paramètre Description
sharesnapshot facultatif. Version 2017-04-17 et versions 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 propriétés du fichier.
timeout facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définir des délais d’expiration pour les opérations Azure Files.

En-têtes de requête

Les en-têtes de requête obligatoires et facultatifs sont décrits dans le tableau suivant :

En-tête de requête Description
Autorisation 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-lease-id:<ID> facultatif. Version 2019-02-02 et ultérieures. Si l’en-tête est spécifié, l’opération n’est effectuée que si le bail du fichier est actuellement actif et que l’ID de bail spécifié dans la demande correspond à l’ID de bail du fichier. Si elle ne correspond pas, l’opération échoue avec status code 412 (Échec de la condition préalable).
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), qui est enregistrée dans les journaux d’analyse lorsque la journalisation Azure Storage Analytics est activée. Nous vous recommandons vivement d’utiliser cet en-tête lorsque vous associez des activités côté client aux demandes reçues par le serveur. Pour plus d’informations, consultez Surveiller Stockage Blob Azure.
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 les versions 2022-11-02 et ultérieures.
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 requête doit être rogné ou non. Pour plus d’informations, consultez Nommer et référencer des partages, des répertoires, des fichiers et des 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
Last-Modified Retourne la date et l’heure de la dernière modification du fichier. 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 fichier ou ses propriétés met à jour l’heure de la dernière modification.
x-ms-meta-name:value Ensemble de paires nom-valeur qui sont associées à ce fichier en tant que métadonnées définies par l’utilisateur.
x-ms-type: <File> Renvoie le type File. Réservé pour un usage futur.
Content-Length Taille du fichier en octets. Cet en-tête retourne la valeur de l’en-tête x-ms-content-length stocké avec le fichier.
Content-Type Type de contenu spécifié pour le fichier. Si aucun type de contenu n’est spécifié, le type de contenu par défaut est application/octet-stream.
ETag L'ETag contient une valeur que vous pouvez utiliser pour exécuter des opérations conditionnellement. La valeur est placée entre guillemets.
Content-MD5 Si l'en-tête Content-MD5 a été défini pour le fichier, l'en-tête de réponse Content-MD5 est renvoyé afin que le client puisse vérifier l'intégrité du contenu du message.
Content-Encoding Si l'en-tête de demande Content-Encoding a été préalablement défini pour le fichier, la valeur Content-Encoding est renvoyée dans cet en-tête.
Content-Language Si l'en-tête de demande Content-Language a été préalablement défini pour le fichier, la valeur Content-Language est renvoyée dans cet en-tête.
Cache-Control Si l'en-tête de demande Cache-Control a été préalablement défini pour le fichier, la valeur Cache-Control est renvoyée dans cet en-tête.
Content-Disposition Renvoie la valeur spécifiée pour l'en-tête x-ms-content-disposition et indique la manière de traiter la réponse.

Le Content-Disposition champ d’en-tête de réponse transmet des informations supplémentaires sur la façon de traiter la charge utile de réponse, et vous pouvez l’utiliser pour joindre des métadonnées supplémentaires. Par exemple, s’il est défini sur attachment, Content-Disposition indique que l’agent utilisateur ne doit pas afficher la réponse, mais qu’il doit afficher une fenêtre Enregistrer sous à la place.
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-copy-completion-time:<datetime> Version 2015-02-21 et ultérieures. Heure de conclusion de la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Cette valeur peut spécifier l'heure d'une tentative de copie qui s'est terminée, qui a été annulée ou qui a échoué. Cet en-tête n’apparaît pas si une copie est en attente, si ce fichier n’a jamais été la destination dans une opération copier un fichier ou si ce fichier a été modifié après une opération de copie de fichier terminée à l’aide de Définir les propriétés du fichier ou De créer un fichier.
x-ms-copy-status-description: <error string> Version 2015-02-21 et ultérieures. Apparaît uniquement en cas x-ms-copy-statusd’échec ou en attente. Il décrit la cause de l’échec de l’opération de copie irrécupérable ou non irrécupérable. Cet en-tête n’apparaît pas si une copie est en attente, si ce fichier n’a jamais été la destination dans une opération copier un fichier ou si ce fichier a été modifié après une opération de copie de fichier terminée à l’aide de Définir les propriétés du fichier ou De créer un fichier.
x-ms-copy-id: <id> Version 2015-02-21 et ultérieures. Identificateur de chaîne de la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Cet en-tête n’apparaît pas si ce fichier n’a jamais été la destination d’une opération Copier un fichier , ou si ce fichier a été modifié après une opération de copie de fichier terminée à l’aide de Définir les propriétés du fichier ou De créer un fichier.
x-ms-copy-progress: <bytes copied/bytes total> Version 2015-02-21 et ultérieures. Contient le nombre d’octets copiés et le nombre total d’octets dans la source dans la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Peut afficher entre 0 et le nombre d’octets Content-Length copiés. Cet en-tête n’apparaît pas si ce fichier n’a jamais été la destination d’une opération Copier un fichier , ou si ce fichier a été modifié après une opération de copie de fichier terminée à l’aide de Définir les propriétés du fichier ou De créer un fichier.
x-ms-copy-source: url Version 2015-02-21 et ultérieures. URL d’un maximum de 2 Ko qui spécifie le fichier source qui a été utilisé dans la dernière tentative d’opération Copier le fichier où ce fichier était le fichier de destination. Cet en-tête n’apparaît pas si ce fichier n’a jamais été la destination d’une opération Copier un fichier , ou si ce fichier a été modifié après une opération de copie de fichier terminée à l’aide de Définir les propriétés du fichier ou De créer un fichier.
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> Version 2015-02-21 et ultérieures. État de l’opération de copie identifiée par x-ms-copy-id, avec les valeurs suivantes :

- Succès: Copie terminée avec succès.
- Attente: La copie est en cours. Vérifiez x-ms-copy-status-description si des erreurs intermittentes et non irrécupérables entravent la progression de la copie, mais ne provoquent pas d’échec.
- Abandonnée: La copie a été terminée par l’abandon du fichier de copie.
- Échoué: Échec de la copie. Pour des informations sur les défaillances, consultez x-ms-copy-status-description.

Cet en-tête n’apparaît pas si ce fichier n’a jamais été la destination d’une opération Copier un fichier , ou si ce fichier a été modifié après une opération de copie de fichier terminée à l’aide de Définir les propriétés du fichier ou De créer un fichier.
x-ms-server-encrypted: true/false Version 2017-04-17 et ultérieures. La valeur de cet en-tête est définie true sur si les données de fichier et les métadonnées d’application sont entièrement chiffrées à l’aide de l’algorithme spécifié. La valeur est définie false sur si le fichier n’est pas chiffré, ou si seules certaines parties des métadonnées du fichier ou de l’application sont chiffrées.
x-ms-file-permission-key Version 2019-02-02 et ultérieures. Clé de l’autorisation du fichier.
x-ms-file-attributes Version 2019-02-02 et ultérieures. Attributs du système de fichiers du fichier. Pour plus d’informations, consultez la liste des attributs disponibles.
x-ms-file-creation-time Version 2019-02-02 et ultérieures. Valeur de date/heure UTC qui représente la propriété d’heure de création d’un fichier.
x-ms-file-last-write-time Version 2019-02-02 et ultérieures. Valeur de date/heure UTC qui représente la propriété d’heure de la dernière écriture pour le fichier.
x-ms-file-change-time Version 2019-02-02 et ultérieures. Valeur de date/heure UTC qui représente la propriété d’heure de modification pour le fichier.
x-ms-file-file-id Version 2019-02-02 et ultérieures. ID de fichier du fichier.
x-ms-file-parent-id Version 2019-02-02 et ultérieures. ID de fichier parent du fichier.
x-ms-lease-duration:infinite Version 2019-02-02 et ultérieures. Lorsqu’un fichier est loué, spécifie que le bail est d’une durée infinie.
x-ms-lease-state:<available;leased;broken> Version 2019-02-02 et ultérieures. Lorsqu’un fichier est loué, spécifie l’état du bail du fichier.
x-ms-lease-status:<locked;unlocked> Version 2019-02-02 et ultérieures. Lorsqu’un fichier est loué, spécifie le status de bail du fichier.
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.

Response body

Aucun.

Exemple de réponse

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
x-ms-type: File  
x-ms-meta-m1: v1  
x-ms-meta-m2: v2  
Content-Length: 11  
Content-Type: text/plain; charset=UTF-8  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-version: 2019-02-02  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6  
x-ms-copy-source: <url>  
x-ms-copy-status: success  
x-ms-copy-progress: 11/11  
x-ms-copy-completion-time: <date>  
x-ms-lease-duration: infinite   
x-ms-lease-state: leased 
x-ms-lease-status: locked   
  

Autorisation

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

Voir aussi

Opérations sur Azure Files