DataLakePathClient class
Un DataLakePathClient représente une URL vers le chemin d’accès stockage Azure (répertoire ou fichier).
- Extends
-
StorageClient
Constructeurs
| Data |
Crée une instance de DataLakePathClient à partir de l’URL et du pipeline. |
| Data |
Crée une instance de DataLakePathClient à partir de l’URL et des informations d’identification. |
Propriétés
| file |
Nom du système de fichiers actuel. |
| name | Nom du chemin d’accès actuel (répertoire ou fichier). |
Propriétés héritées
| account |
|
| credential | Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package |
| url | Valeur de chaîne d’URL encodée. |
Méthodes
| create(Path |
Créez un répertoire ou un chemin d’accès. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| create |
Créez un répertoire ou un fichier. Si la ressource existe déjà, elle n’est pas modifiée. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| delete(boolean, Path |
Supprimez le chemin actuel (répertoire ou fichier). Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Supprimez le chemin actuel (répertoire ou fichier) s’il existe. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Retourne true si le fichier Data Lake représenté par ce client existe ; false sinon. REMARQUE : utilisez cette fonction avec soin, car un fichier existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux fichiers peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée. |
| get |
Retourne les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier). Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Obtenez un DataLakeLeaseClient qui gère les baux sur le chemin d’accès (répertoire ou fichier). |
| get |
Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du chemin d’accès (répertoire ou fichier). AVERTISSEMENT : l’objet Voir https://learn.microsoft.com/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Déplacer le répertoire ou le fichier dans le même système de fichiers. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Déplacez le répertoire ou le fichier vers un autre système de fichiers. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Supprime le contrôle d’accès sur un chemin d’accès et un sous-chemin d’accès. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Définissez les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier). Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Définit le contrôle d’accès sur un chemin d’accès et des sous-chemins. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Définit les propriétés système sur le chemin d’accès (répertoire ou fichier). Si aucune valeur n’est fournie ou aucune valeur fournie pour les en-têtes HTTP d’objet blob spécifiés, ces en-têtes HTTP d’objet blob sans valeur seront effacés. Voir https://learn.microsoft.com/rest/api/storageservices/set-blob-properties |
| set |
Définit les métadonnées définies par l’utilisateur pour le chemin d’accès spécifié (répertoire de fichier) sous la forme d’une ou plusieurs paires nom-valeur. Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées de chemin d’accès sont supprimées. Voir https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata |
| set |
Définit les autorisations de fichier sur un chemin d’accès. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Convertissez dataLakePathClient actuel en DataLakeDirectoryClient si le chemin actuel est un répertoire. |
| to |
Convertissez dataLakePathClient actuel en DataLakeFileClient si le chemin actuel est un fichier. |
| update |
Modifie le contrôle d’accès sur un chemin d’accès et des sous-chemins. Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
Détails du constructeur
DataLakePathClient(string, Pipeline)
Crée une instance de DataLakePathClient à partir de l’URL et du pipeline.
new DataLakePathClient(url: string, pipeline: Pipeline)Paramètres
- url
-
string
Chaîne cliente pointant vers le chemin du lac de données Stockage Azure (répertoire ou fichier), par exemple «https://myaccount.dfs.core.windows.net/filesystem/directory" ou "https://myaccount.dfs.core.windows.net/filesystem/file". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Crée une instance de DataLakePathClient à partir de l’URL et des informations d’identification.
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Paramètres
- url
-
string
Chaîne cliente pointant vers le chemin du lac de données Stockage Azure (répertoire ou fichier), par exemple «https://myaccount.dfs.core.windows.net/filesystem/directory" ou "https://myaccount.dfs.core.windows.net/filesystem/file". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.
- options
- StoragePipelineOptions
Optional. Options de configuration du pipeline HTTP.
Détails de la propriété
fileSystemName
Nom du système de fichiers actuel.
string fileSystemNameValeur de propriété
string
name
Nom du chemin d’accès actuel (répertoire ou fichier).
string nameValeur de propriété
string
Détails de la propriété héritée
accountName
accountName: stringValeur de propriété
string
héritée de StorageClient.accountName
credential
Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialValeur de propriété
héritée de StorageClient.credential
url
Valeur de chaîne d’URL encodée.
url: stringValeur de propriété
string
héritée de StorageClient.url
Détails de la méthode
create(PathResourceType, PathCreateOptions)
Créez un répertoire ou un chemin d’accès.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>Paramètres
- resourceType
- PathResourceTypeModel
Type de ressource, « répertoire » ou « fichier ».
- options
- PathCreateOptions
Optional. Options lors de la création d’un chemin d’accès.
Retours
Promise<PathCreateResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
Créez un répertoire ou un fichier. Si la ressource existe déjà, elle n’est pas modifiée.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Paramètres
- resourceType
- PathResourceTypeModel
Type de ressource, « répertoire » ou « fichier ».
- options
- PathCreateIfNotExistsOptions
Retours
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
Supprimez le chemin actuel (répertoire ou fichier).
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Paramètres
- recursive
-
boolean
Obligatoire et valide uniquement lorsque la ressource est un répertoire. Si la valeur est « true », tous les chemins d’accès sous le répertoire sont supprimés.
- options
- PathDeleteOptions
Optional. Options lors de la suppression du chemin d’accès.
Retours
Promise<PathDeleteResponse>
deleteIfExists(boolean, PathDeleteOptions)
Supprimez le chemin actuel (répertoire ou fichier) s’il existe.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Paramètres
- recursive
-
boolean
Obligatoire et valide uniquement lorsque la ressource est un répertoire. Si la valeur est « true », tous les chemins d’accès sous le répertoire sont supprimés.
- options
- PathDeleteOptions
Retours
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
Retourne true si le fichier Data Lake représenté par ce client existe ; false sinon.
REMARQUE : utilisez cette fonction avec soin, car un fichier existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux fichiers peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.
function exists(options?: PathExistsOptions): Promise<boolean>Paramètres
- options
- PathExistsOptions
options pour l’opération Exists.
Retours
Promise<boolean>
getAccessControl(PathGetAccessControlOptions)
Retourne les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier).
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Paramètres
- options
- PathGetAccessControlOptions
Optional. Options lors de l’obtention du contrôle d’accès aux fichiers.
Retours
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
Obtenez un DataLakeLeaseClient qui gère les baux sur le chemin d’accès (répertoire ou fichier).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParamètres
- proposeLeaseId
-
string
Optional. ID de bail initial proposé.
Retours
getProperties(PathGetPropertiesOptions)
Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du chemin d’accès (répertoire ou fichier).
AVERTISSEMENT : l’objet metadata retourné dans la réponse aura ses clés en minuscules, même s’ils contenaient initialement des caractères majuscules. Cela diffère des clés de métadonnées retournées par les méthodes de DataLakeFileSystemClient qui répertorient les chemins d’accès à l’aide de l’option includeMetadata, qui conserve leur casse d’origine.
Voir https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Paramètres
- options
- PathGetPropertiesOptions
Optional. Options lors de l’obtention des propriétés de chemin d’accès.
Retours
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
Déplacer le répertoire ou le fichier dans le même système de fichiers.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Paramètres
- destinationPath
-
string
Chemin d’accès au répertoire de destination, tel que « répertoire » ou chemin d’accès au fichier « répertoire/fichier ». Si destinationPath est authentifié avec SAS, ajoutez la signature d’accès partagé au chemin de destination tel que « directory/file ?sasToken ».
- options
- PathMoveOptions
Optional. Options lors du déplacement d’un répertoire ou d’un fichier.
Retours
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
Déplacez le répertoire ou le fichier vers un autre système de fichiers.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Paramètres
- destinationFileSystem
-
string
Système de fichiers de destination tel que « système de fichiers ».
- destinationPath
-
string
Chemin d’accès au répertoire de destination comme « répertoire » ou chemin d’accès au fichier « répertoire/fichier » Si destinationPath est authentifié avec SAS, ajoutez la SAP au chemin de destination tel que « directory/file ?sasToken ».
- options
- PathMoveOptions
Optional. Options lors du déplacement d’un répertoire ou d’un fichier.
Retours
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Supprime le contrôle d’accès sur un chemin d’accès et un sous-chemin d’accès.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Paramètres
Liste de contrôle d’accès POSIX pour le fichier ou le répertoire.
Optional. Options
Retours
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Définissez les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier).
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Paramètres
- acl
Liste de contrôle d’accès POSIX pour le fichier ou le répertoire.
- options
- PathSetAccessControlOptions
Optional. Options lors de la définition du contrôle d’accès du chemin d’accès.
Retours
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Définit le contrôle d’accès sur un chemin d’accès et des sous-chemins.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Paramètres
- acl
Liste de contrôle d’accès POSIX pour le fichier ou le répertoire.
Optional. Options
Retours
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Définit les propriétés système sur le chemin d’accès (répertoire ou fichier).
Si aucune valeur n’est fournie ou aucune valeur fournie pour les en-têtes HTTP d’objet blob spécifiés, ces en-têtes HTTP d’objet blob sans valeur seront effacés.
Voir https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>Paramètres
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Retours
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
Définit les métadonnées définies par l’utilisateur pour le chemin d’accès spécifié (répertoire de fichier) sous la forme d’une ou plusieurs paires nom-valeur.
Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées de chemin d’accès sont supprimées.
Voir https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Paramètres
- metadata
- Metadata
Optional. Remplacez les métadonnées existantes par cette valeur. Si aucune valeur n’est fournie, les métadonnées existantes seront supprimées.
- options
- PathSetMetadataOptions
Optional. Options lors de la définition des métadonnées de chemin d’accès.
Retours
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
Définit les autorisations de fichier sur un chemin d’accès.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>Paramètres
- permissions
- PathPermissions
Autorisations d’accès POSIX pour le propriétaire du fichier, le groupe propriétaire de fichiers et d’autres utilisateurs.
- options
- PathSetPermissionsOptions
Optional. Options lors de la définition des autorisations de chemin d’accès.
Retours
Promise<PathSetPermissionsResponse>
toDirectoryClient()
Convertissez dataLakePathClient actuel en DataLakeDirectoryClient si le chemin actuel est un répertoire.
function toDirectoryClient(): DataLakeDirectoryClientRetours
toFileClient()
Convertissez dataLakePathClient actuel en DataLakeFileClient si le chemin actuel est un fichier.
function toFileClient(): DataLakeFileClientRetours
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Modifie le contrôle d’accès sur un chemin d’accès et des sous-chemins.
Voir https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Paramètres
- acl
Liste de contrôle d’accès POSIX pour le fichier ou le répertoire.
Optional. Options