DataLakeDirectoryClient class

Crée une instance de DataLakePathClient à partir de l’URL et du pipeline.

new DataLakeDirectoryClient(url: string, pipeline: Pipeline)

Paramètres

Crée une instance de DataLakePathClient à partir de l’URL et des informations d’identification.

new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Paramètres

Nom du système de fichiers actuel.

string fileSystemName

Valeur de propriété

Nom du chemin d’accès actuel (répertoire ou fichier).

string name

Valeur de propriété

accountName: string

Valeur de propriété

héritée deDataLakePathClient.accountName

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 | TokenCredential

Valeur de propriété

héritée deDataLakePathClient.credential

Valeur de chaîne d’URL encodée.

url: string

Valeur de propriété

héritée deDataLakePathClient.url

Créez un répertoire.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

Paramètres

Retours

Créez un répertoire.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

Paramètres

Retours

Créez un répertoire s’il n’existe pas déjà.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>

Paramètres

Retours

Créez un répertoire s’il n’existe pas déjà.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Paramètres

Retours

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Disponible uniquement pour les clients construits avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Génère la chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis dans la SAP est signée par la clé de délégation de l’utilisateur d’entrée.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Crée un objet DataLakeFileClient sous le répertoire actif.

function getFileClient(fileName: string): DataLakeFileClient

Paramètres

Retours

Crée un objet DataLakeDirectoryClient sous le répertoire actif.

function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

Paramètres

Retours

Supprimez le chemin actuel (répertoire ou fichier).

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Paramètres

Retours

héritée deDataLakePathClient.delete

Supprimez le chemin actuel (répertoire ou fichier) s’il existe.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Paramètres

Retours

héritée deDataLakePathClient.deleteIfExists

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

Retours

héritée deDataLakePathClient.exists

Retourne les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier).

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Paramètres

Retours

héritée deDataLakePathClient.getAccessControl

Obtenez un DataLakeLeaseClient qui gère les baux sur le chemin d’accès (répertoire ou fichier).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Paramètres

Retours

héritée deDataLakePathClient.getDataLakeLeaseClient

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://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Paramètres

Retours

héritée deDataLakePathClient.getProperties

Déplacer le répertoire ou le fichier dans le même système de fichiers.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Paramètres

Retours

héritée deDataLakePathClient.move

Déplacez le répertoire ou le fichier vers un autre système de fichiers.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Paramètres

Retours

héritée deDataLakePathClient.move

Supprime le contrôle d’accès sur un chemin d’accès et un sous-chemin d’accès.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Paramètres

Retours

héritée deDataLakePathClient.removeAccessControlRecursive

Définissez les données de contrôle d’accès pour un chemin d’accès (répertoire de fichier).

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Paramètres

Retours

héritée deDataLakePathClient.setAccessControl

Définit le contrôle d’accès sur un chemin d’accès et des sous-chemins.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Paramètres

Retours

héritée deDataLakePathClient.setAccessControlRecursive

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Paramètres

Retours

héritée deDataLakePathClient.setHttpHeaders

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Paramètres

Retours

héritée deDataLakePathClient.setMetadata

Définit les autorisations de fichier sur un chemin d’accès.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Paramètres

Retours

héritée deDataLakePathClient.setPermissions

Convertissez dataLakePathClient actuel en DataLakeDirectoryClient si le chemin actuel est un répertoire.

function toDirectoryClient(): DataLakeDirectoryClient

Retours

héritée deDataLakePathClient.toDirectoryClient

Convertissez dataLakePathClient actuel en DataLakeFileClient si le chemin actuel est un fichier.

function toFileClient(): DataLakeFileClient

Retours

héritée deDataLakePathClient.toFileClient

Modifie le contrôle d’accès sur un chemin d’accès et des sous-chemins.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Paramètres

Retours

héritée deDataLakePathClient.updateAccessControlRecursive