Path - Get Properties

Référence

Service:: Storage Services

Version d'API:: 2023-08-03

Obtenir des propriétés | Obtenir l’état | Obtenir Access Control liste | Vérifier l’accès
Get Properties retourne toutes les propriétés définies par le système et l’utilisateur pour un chemin d’accès. Obtenir l’état retourne toutes les propriétés définies par le système pour un chemin d’accès. Obtenir Access Control List retourne la liste de contrôle d’accès pour un chemin d’accès. Cette opération prend en charge les requêtes HTTP conditionnelles. Pour plus d’informations, consultez Spécification des en-têtes conditionnels pour les opérations du service Blob.

HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}

Avec des paramètres facultatifs:

HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&upn={upn}&fsAction={fsAction}&timeout={timeout}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte stockage Azure.
dnsSuffix	path	True	string	Suffixe DNS du point de terminaison Azure Data Lake Storage.
filesystem	path	True	string	Identificateur du système de fichiers. Modèle d’expression régulière: `^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$`
path	path	True	string	Chemin du fichier ou du répertoire.
action	query		PathGetPropertiesAction	facultatif. Si la valeur est « getStatus », seules les propriétés définies par le système pour le chemin d’accès sont retournées. Si la valeur est « getAccessControl », la liste de contrôle d’accès est retournée dans les en-têtes de réponse (l’espace de noms hiérarchique doit être activé pour le compte), sinon les propriétés sont retournées.
fsAction	query		string	Obligatoire uniquement pour case activée action d’accès. Valide uniquement lorsque l’espace de noms hiérarchique est activé pour le compte. Opération de système de fichiers en lecture/écriture/exécution sous forme de chaîne, modèle regex correspondant « [rwx-]{3} »
timeout	query		integer int32	Valeur de délai d’expiration de l’opération facultative en secondes. La période commence lorsque la demande est reçue par le service. Si la valeur du délai d’expiration s’écoule avant la fin de l’opération, l’opération échoue.
upn	query		boolean	facultatif. Valide uniquement lorsque l’espace de noms hiérarchique est activé pour le compte. Si « true », les valeurs d’identité utilisateur retournées dans les en-têtes de réponse x-ms-owner, x-ms-group et x-ms-acl seront transformées des ID d’objet Azure Active Directory en noms d’utilisateur principal. Si « false », les valeurs sont retournées en tant qu’ID d’objet Azure Active Directory. La valeur par défaut est false. Notez que les ID d’objet de groupe et d’application ne sont pas traduits, car ils n’ont pas de noms conviviaux uniques.

En-tête de la demande

Nom	Type	Description
x-ms-lease-id	string	facultatif. Si cet en-tête est spécifié, l’opération n’est effectuée que si les deux conditions suivantes sont remplies : i) le bail du chemin d’accès est actuellement actif et ii) l’ID de bail spécifié dans la demande correspond à celui du chemin d’accès. Modèle d’expression régulière: `^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$`
If-Match	string	facultatif. Spécifiez une valeur ETag. Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource correspond à la valeur spécifiée. L’ETag doit être spécifié entre guillemets.
If-None-Match	string	facultatif. Valeur ETag ou valeur générique spéciale (« * »). Spécifiez cet en-tête pour exécuter l'opération uniquement si l'ETag de la ressource ne correspond pas à la valeur spécifiée. L’ETag doit être spécifié entre guillemets.
If-Modified-Since	string	facultatif. Valeur de date et heure. Spécifiez cet en-tête pour effectuer l’opération uniquement si la ressource a été modifiée depuis la date et l’heure spécifiées.
If-Unmodified-Since	string	facultatif. Valeur de date et heure. Spécifiez cet en-tête pour effectuer l’opération uniquement si la ressource n’a pas été modifiée depuis la date et l’heure spécifiées.
x-ms-encryption-key	string	facultatif. Clé de chiffrement AES-256 encodée en Base64.
x-ms-encryption-key-sha256	string	facultatif. Hachage SHA256 encodé en Base64 de la clé de chiffrement.
x-ms-encryption-algorithm: AES256	string	facultatif. Spécifie l’algorithme à utiliser pour le chiffrement. La valeur de cet en-tête doit être AES256.
x-ms-client-request-id	string	Un UUID enregistré dans les journaux d’analyse pour la résolution des problèmes et la corrélation. Modèle d’expression régulière: `^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$`
x-ms-date	string	Spécifie la date/heure en temps universel coordonné (UTC) pour la requête. Cela est obligatoire lors de l’utilisation de l’autorisation de clé partagée.
x-ms-version	string	Spécifie la version du protocole REST utilisé pour le traitement de la demande. Cela est obligatoire lors de l’utilisation de l’autorisation de clé partagée.

Réponses

Nom	Type	Description
200 OK		Retourne toutes les propriétés du fichier ou du répertoire. En-têtes Accept-Ranges: string Cache-Control: string Content-Disposition: string Content-Encoding: string Content-Language: string Content-Length: integer Content-Range: string Content-Type: string Content-MD5: string Date: string ETag: string Last-Modified: string x-ms-request-id: string x-ms-version: string x-ms-resource-type: string x-ms-properties: string x-ms-owner: string x-ms-group: string x-ms-permissions: string x-ms-acl: string x-ms-lease-duration: string x-ms-lease-state: string x-ms-lease-status: string x-ms-server-encrypted: true/false: boolean x-ms-encryption-key-sha256: string x-ms-encryption-context: string x-ms-encryption-scope: string x-ms-creation-time: string x-ms-expiry-time: string
Other Status Codes	DataLakeStorageError	Une erreur est survenue. Les status HTTP possibles, le code et les chaînes de message sont répertoriés ci-dessous : 400 Requête incorrecte, ContentLengthMustBeZero, « L’en-tête de requête Content-Length doit être égal à zéro ». 400 Demande incorrecte, InvalidAuthenticationInfo, « Les informations d’authentification ne sont pas fournies dans le format correct. Vérifiez la valeur de l’en-tête d’autorisation. » 400 Requête incorrecte, InvalidFlushPosition, « Les données chargées ne sont pas contiguës ou la valeur du paramètre de requête de position n’est pas égale à la longueur du fichier après l’ajout des données chargées . » 400 Requête incorrecte, InvalidHeaderValue, « La valeur de l’un des en-têtes HTTP n’est pas au format correct ». 400 Requête incorrecte, InvalidHttpVerb, « Le verbe HTTP spécifié n’est pas valide , il n’est pas reconnu par le serveur ». 400 Requête incorrecte, InvalidInput, « Une des entrées de demande n’est pas valide ». 400 Requête incorrecte, InvalidPropertyName, « Un nom de propriété ne peut pas être vide ». 400 Requête incorrecte, InvalidPropertyName, « Le nom de la propriété contient des caractères non valides ». 400 Requête incorrecte, InvalidQueryParameterValue, « La valeur de l’un des paramètres de requête spécifiés dans l’URI de requête n’est pas valide . » 400 Requête incorrecte, InvalidResourceName, « Le nom de ressource spécifié contient des caractères non valides ». 400 Requête incorrecte, InvalidSourceUri, « L’URI source n’est pas valide ». 400 Requête incorrecte, InvalidUri, « L’URI de demande n’est pas valide ». 400 Requête incorrecte, MissingRequiredHeader, « Un en-tête HTTP obligatoire pour cette requête n’est pas spécifié ». 400 Requête incorrecte, MissingRequiredQueryParameter, « Un paramètre de requête obligatoire pour cette requête n’est pas spécifié . » 400 Requête incorrecte, MultipleConditionHeadersNotSupported, « Les en-têtes de condition multiples ne sont pas pris en charge ». 400 Requête incorrecte, OutOfRangeInput, « L’une des entrées de requête est hors de portée ». 400 Requête incorrecte, OutOfRangeQueryParameterValue, « L’un des paramètres de requête spécifiés dans l’URI de requête se trouve en dehors de la plage autorisée ». 400 Requête incorrecte, UnsupportedHeader, « L’un des en-têtes spécifiés dans la demande n’est pas pris en charge ». 400 Requête incorrecte, UnsupportedQueryParameter, « L’un des paramètres de requête spécifiés dans l’URI de requête n’est pas pris en charge ». 400 Requête incorrecte, UnsupportedRestVersion, « La version rest spécifiée n’est pas prise en charge ». 403 Forbidden, AccountIsDisabled, « Le compte spécifié est désactivé ». 403 Interdit, AuthorizationFailure, « Cette demande n’est pas autorisée à effectuer cette opération ». 403 Forbidden, InsufficientAccountPermissions, « Le compte auquel vous accédez ne dispose pas des autorisations suffisantes pour exécuter cette opération ». 404 Introuvable, FilesystemNotFound, « Le système de fichiers spécifié n’existe pas ». 404 Introuvable, PathNotFound, « Le chemin spécifié n’existe pas ». 404 Introuvable, RenameDestinationParentPathNotFound, « Le répertoire parent du chemin de destination n’existe pas ». 404 Introuvable, ResourceNotFound, « La ressource spécifiée n’existe pas ». 404 Introuvable, SourcePathNotFound, « Le chemin source d’une opération de renommage n’existe pas ». 405 Method Not Allowed, UnsupportedHttpVerb, « La ressource ne prend pas en charge le verbe HTTP spécifié ». 409 Conflict, DestinationPathIsBeingDeleted, « Le chemin de destination spécifié est marqué à supprimer ». 409 Conflict, DirectoryNotEmpty, « La valeur du paramètre de requête récursive doit être true pour supprimer un répertoire non vide ». 409 Conflict, FilesystemAlreadyExists, « Le système de fichiers spécifié existe déjà ». 409 Conflit, FilesystemBeingDeleted, « Le système de fichiers spécifié est en cours de suppression ». 409 Conflict, InvalidDestinationPath, « Le chemin spécifié, ou un élément du chemin d’accès, existe et son type de ressource n’est pas valide pour cette opération . » * 409 Conflict, InvalidFlushOperation, « La ressource a été créée ou modifiée par l’API de service Blob et ne peut pas être écrite par l’API service Data Lake Storage . » 409 Conflict, InvalidRenameSourcePath, « Le répertoire source ne peut pas être identique au répertoire de destination, ni la destination ne peut être un sous-répertoire du répertoire source . » 409 Conflict, InvalidSourceOrDestinationResourceType, « Le type de ressource source et de destination doit être identique ». 409 Conflit, LeaseAlreadyPresent, « Il y a déjà un bail présent. » 409 Conflict, LeaseIdMismatchWithLeaseOperation, « L’ID de bail spécifié ne correspond pas à l’ID de bail de la ressource avec l’opération de bail spécifiée. » 409 Conflit, LeaseIsAlreadyBroken, « Le bail a déjà été rompu et ne peut pas être rompu à nouveau. » 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, « L’ID de bail correspond, mais le bail est actuellement en état de rupture et ne peut pas être acquis tant qu’il n’est pas rompu. » 409 Conflict, LeaseIsBreakingAndCannotBeChanged, « L’ID de bail correspond, mais le bail est actuellement dans un état cassant et ne peut pas être modifié. » 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, « L’ID de bail correspond, mais le bail a été rompu explicitement et ne peut pas être renouvelé. » 409 Conflict, LeaseNameMismatch, « Le nom de bail spécifié ne correspond pas au nom de bail existant. » 409 Conflict, LeaseNotPresentWithLeaseOperation, « L’ID de bail n’est pas présent avec l’opération de bail spécifiée ». 409 Conflict, PathAlreadyExists, « Le chemin spécifié existe déjà ». 409 Conflict, PathConflict, « Le chemin spécifié, ou un élément du chemin d’accès, existe et son type de ressource n’est pas valide pour cette opération . » 409 Conflit, SourcePathIsBeingDeleted, « Le chemin d’accès source spécifié est marqué pour être supprimé ». 409 Conflict, ResourceTypeMismatch, « Le type de ressource spécifié dans la demande ne correspond pas au type de la ressource ». 412 Condition préalable Échec, ConditionNotMet, « La condition spécifiée à l’aide d’en-têtes conditionnels HTTP n’est pas remplie ». 412 La condition préalable a échoué, LeaseIdMismatch, « L’ID de bail spécifié ne correspond pas à l’ID de bail de la ressource ». 412 La condition préalable a échoué, LeaseIdMissing, « Il existe actuellement un bail sur la ressource et aucun ID de bail n’a été spécifié dans la demande ». 412 La condition préalable a échoué, LeaseNotPresent, « Il n’existe actuellement aucun bail sur la ressource ». 412 La condition préalable a échoué, LeaseLost, « Un ID de bail a été spécifié, mais le bail de la ressource a expiré. » 412 La condition préalable a échoué, SourceConditionNotMet, « La condition source spécifiée à l’aide d’en-têtes conditionnels HTTP n’est pas remplie ». 413 Request Entity Too Large, RequestBodyTooLarge, « Le corps de la demande est trop grand et dépasse la limite maximale autorisée . » 416 Plage demandée non satisfiable, InvalidRange, « La plage spécifiée n’est pas valide pour la taille actuelle de la ressource ». 500 Erreur interne du serveur, InternalError, « Le serveur a rencontré une erreur interne. Relancez la demande. » 500 Erreur interne du serveur, OperationTimedOut, « L’opération n’a pas pu être terminée dans le délai autorisé ». 503 Service indisponible, ServerBusy, « La sortie dépasse la limite du compte ». 503 Service indisponible, ServerBusy, « L’entrée dépasse la limite du compte ». 503 Service indisponible, ServerBusy, « Les opérations par seconde dépassent la limite du compte ». 503 Service indisponible, ServerBusy : « Le serveur ne peut pas recevoir de demandes. Veuillez relancez la requête. » En-têtes x-ms-request-id: string x-ms-version: string

Nom

Type

Description

200 OK

Retourne toutes les propriétés du fichier ou du répertoire.

En-têtes

Accept-Ranges: string
Cache-Control: string
Content-Disposition: string
Content-Encoding: string
Content-Language: string
Content-Length: integer
Content-Range: string
Content-Type: string
Content-MD5: string
Date: string
ETag: string
Last-Modified: string
x-ms-request-id: string
x-ms-version: string
x-ms-resource-type: string
x-ms-properties: string
x-ms-owner: string
x-ms-group: string
x-ms-permissions: string
x-ms-acl: string
x-ms-lease-duration: string
x-ms-lease-state: string
x-ms-lease-status: string
x-ms-server-encrypted: true/false: boolean
x-ms-encryption-key-sha256: string
x-ms-encryption-context: string
x-ms-encryption-scope: string
x-ms-creation-time: string
x-ms-expiry-time: string

Other Status Codes

DataLakeStorageError

Une erreur est survenue. Les status HTTP possibles, le code et les chaînes de message sont répertoriés ci-dessous :

400 Requête incorrecte, ContentLengthMustBeZero, « L’en-tête de requête Content-Length doit être égal à zéro ».
400 Demande incorrecte, InvalidAuthenticationInfo, « Les informations d’authentification ne sont pas fournies dans le format correct. Vérifiez la valeur de l’en-tête d’autorisation. »
400 Requête incorrecte, InvalidFlushPosition, « Les données chargées ne sont pas contiguës ou la valeur du paramètre de requête de position n’est pas égale à la longueur du fichier après l’ajout des données chargées . »
400 Requête incorrecte, InvalidHeaderValue, « La valeur de l’un des en-têtes HTTP n’est pas au format correct ».
400 Requête incorrecte, InvalidHttpVerb, « Le verbe HTTP spécifié n’est pas valide , il n’est pas reconnu par le serveur ».
400 Requête incorrecte, InvalidInput, « Une des entrées de demande n’est pas valide ».
400 Requête incorrecte, InvalidPropertyName, « Un nom de propriété ne peut pas être vide ».
400 Requête incorrecte, InvalidPropertyName, « Le nom de la propriété contient des caractères non valides ».
400 Requête incorrecte, InvalidQueryParameterValue, « La valeur de l’un des paramètres de requête spécifiés dans l’URI de requête n’est pas valide . »
400 Requête incorrecte, InvalidResourceName, « Le nom de ressource spécifié contient des caractères non valides ».
400 Requête incorrecte, InvalidSourceUri, « L’URI source n’est pas valide ».
400 Requête incorrecte, InvalidUri, « L’URI de demande n’est pas valide ».
400 Requête incorrecte, MissingRequiredHeader, « Un en-tête HTTP obligatoire pour cette requête n’est pas spécifié ».
400 Requête incorrecte, MissingRequiredQueryParameter, « Un paramètre de requête obligatoire pour cette requête n’est pas spécifié . »
400 Requête incorrecte, MultipleConditionHeadersNotSupported, « Les en-têtes de condition multiples ne sont pas pris en charge ».
400 Requête incorrecte, OutOfRangeInput, « L’une des entrées de requête est hors de portée ».
400 Requête incorrecte, OutOfRangeQueryParameterValue, « L’un des paramètres de requête spécifiés dans l’URI de requête se trouve en dehors de la plage autorisée ».
400 Requête incorrecte, UnsupportedHeader, « L’un des en-têtes spécifiés dans la demande n’est pas pris en charge ».
400 Requête incorrecte, UnsupportedQueryParameter, « L’un des paramètres de requête spécifiés dans l’URI de requête n’est pas pris en charge ».
400 Requête incorrecte, UnsupportedRestVersion, « La version rest spécifiée n’est pas prise en charge ».
403 Forbidden, AccountIsDisabled, « Le compte spécifié est désactivé ».
403 Interdit, AuthorizationFailure, « Cette demande n’est pas autorisée à effectuer cette opération ».
403 Forbidden, InsufficientAccountPermissions, « Le compte auquel vous accédez ne dispose pas des autorisations suffisantes pour exécuter cette opération ».
404 Introuvable, FilesystemNotFound, « Le système de fichiers spécifié n’existe pas ».
404 Introuvable, PathNotFound, « Le chemin spécifié n’existe pas ».
404 Introuvable, RenameDestinationParentPathNotFound, « Le répertoire parent du chemin de destination n’existe pas ».
404 Introuvable, ResourceNotFound, « La ressource spécifiée n’existe pas ».
404 Introuvable, SourcePathNotFound, « Le chemin source d’une opération de renommage n’existe pas ».
405 Method Not Allowed, UnsupportedHttpVerb, « La ressource ne prend pas en charge le verbe HTTP spécifié ».
409 Conflict, DestinationPathIsBeingDeleted, « Le chemin de destination spécifié est marqué à supprimer ».
409 Conflict, DirectoryNotEmpty, « La valeur du paramètre de requête récursive doit être true pour supprimer un répertoire non vide ».
409 Conflict, FilesystemAlreadyExists, « Le système de fichiers spécifié existe déjà ».
409 Conflit, FilesystemBeingDeleted, « Le système de fichiers spécifié est en cours de suppression ».
409 Conflict, InvalidDestinationPath, « Le chemin spécifié, ou un élément du chemin d’accès, existe et son type de ressource n’est pas valide pour cette opération . » * 409 Conflict, InvalidFlushOperation, « La ressource a été créée ou modifiée par l’API de service Blob et ne peut pas être écrite par l’API service Data Lake Storage . »
409 Conflict, InvalidRenameSourcePath, « Le répertoire source ne peut pas être identique au répertoire de destination, ni la destination ne peut être un sous-répertoire du répertoire source . »
409 Conflict, InvalidSourceOrDestinationResourceType, « Le type de ressource source et de destination doit être identique ».
409 Conflit, LeaseAlreadyPresent, « Il y a déjà un bail présent. »
409 Conflict, LeaseIdMismatchWithLeaseOperation, « L’ID de bail spécifié ne correspond pas à l’ID de bail de la ressource avec l’opération de bail spécifiée. »
409 Conflit, LeaseIsAlreadyBroken, « Le bail a déjà été rompu et ne peut pas être rompu à nouveau. »
409 Conflict, LeaseIsBreakingAndCannotBeAcquired, « L’ID de bail correspond, mais le bail est actuellement en état de rupture et ne peut pas être acquis tant qu’il n’est pas rompu. »
409 Conflict, LeaseIsBreakingAndCannotBeChanged, « L’ID de bail correspond, mais le bail est actuellement dans un état cassant et ne peut pas être modifié. »
409 Conflict, LeaseIsBrokenAndCannotBeRenewed, « L’ID de bail correspond, mais le bail a été rompu explicitement et ne peut pas être renouvelé. »
409 Conflict, LeaseNameMismatch, « Le nom de bail spécifié ne correspond pas au nom de bail existant. »
409 Conflict, LeaseNotPresentWithLeaseOperation, « L’ID de bail n’est pas présent avec l’opération de bail spécifiée ».
409 Conflict, PathAlreadyExists, « Le chemin spécifié existe déjà ».
409 Conflict, PathConflict, « Le chemin spécifié, ou un élément du chemin d’accès, existe et son type de ressource n’est pas valide pour cette opération . »
409 Conflit, SourcePathIsBeingDeleted, « Le chemin d’accès source spécifié est marqué pour être supprimé ».
409 Conflict, ResourceTypeMismatch, « Le type de ressource spécifié dans la demande ne correspond pas au type de la ressource ».
412 Condition préalable Échec, ConditionNotMet, « La condition spécifiée à l’aide d’en-têtes conditionnels HTTP n’est pas remplie ».
412 La condition préalable a échoué, LeaseIdMismatch, « L’ID de bail spécifié ne correspond pas à l’ID de bail de la ressource ».
412 La condition préalable a échoué, LeaseIdMissing, « Il existe actuellement un bail sur la ressource et aucun ID de bail n’a été spécifié dans la demande ».
412 La condition préalable a échoué, LeaseNotPresent, « Il n’existe actuellement aucun bail sur la ressource ».
412 La condition préalable a échoué, LeaseLost, « Un ID de bail a été spécifié, mais le bail de la ressource a expiré. »
412 La condition préalable a échoué, SourceConditionNotMet, « La condition source spécifiée à l’aide d’en-têtes conditionnels HTTP n’est pas remplie ».
413 Request Entity Too Large, RequestBodyTooLarge, « Le corps de la demande est trop grand et dépasse la limite maximale autorisée . »
416 Plage demandée non satisfiable, InvalidRange, « La plage spécifiée n’est pas valide pour la taille actuelle de la ressource ».
500 Erreur interne du serveur, InternalError, « Le serveur a rencontré une erreur interne. Relancez la demande. »
500 Erreur interne du serveur, OperationTimedOut, « L’opération n’a pas pu être terminée dans le délai autorisé ».
503 Service indisponible, ServerBusy, « La sortie dépasse la limite du compte ».
503 Service indisponible, ServerBusy, « L’entrée dépasse la limite du compte ».
503 Service indisponible, ServerBusy, « Les opérations par seconde dépassent la limite du compte ».
503 Service indisponible, ServerBusy : « Le serveur ne peut pas recevoir de demandes. Veuillez relancez la requête. »

En-têtes

x-ms-request-id: string
x-ms-version: string

Définitions

Nom	Description
DataLakeStorageError
Error	Objet de réponse d’erreur de service.
PathGetPropertiesAction	facultatif. Si la valeur est « getStatus », seules les propriétés définies par le système pour le chemin d’accès sont retournées. Si la valeur est « getAccessControl », la liste de contrôle d’accès est retournée dans les en-têtes de réponse (l’espace de noms hiérarchique doit être activé pour le compte), sinon les propriétés sont retournées.

DataLakeStorageError

Nom	Type	Description
error	Error	Objet de réponse d’erreur de service.

Error

Objet de réponse d’erreur de service.

Nom	Type	Description
code	string	Code d’erreur du service.
message	string	Message d’erreur du service.