DataLakePathClient class

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

new DataLakePathClient(url: string, pipeline: Pipeline)

Paramètres

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

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é deStorageClient.accountName

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

Hérité deStorageClient.credential

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

url: string

Valeur de propriété

Hérité deStorageClient.url

Créez un répertoire ou un chemin d’accès.

Consultez 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 ou un fichier. Si la ressource existe déjà, elle n’est pas modifiée.

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

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

Paramètres

Retours

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

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

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

Paramètres

Retours

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

Retourne true si le fichier Data Lake représenté par ce client existe ; false dans le cas contraire. REMARQUE : utilisez cette fonction avec précaution, 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

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

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

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

Paramètres

Retours

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

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 si elles contenaient à l’origine des caractères majuscules. Cela diffère des clés de métadonnées retournées par les méthodes de cette liste de chemins à l’aide de DataLakeFileSystemClient l’option includeMetadata , qui conservera 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

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

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

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

Paramètres

Retours

Déplacer 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

Supprime le Access Control sur un chemin d’accès et des sous-chemins.

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

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

Paramètres

Retours

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

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

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

Paramètres

Retours

Définit le Access Control 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

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 blob sans valeur sont effacés.

Consultez https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

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

Paramètres

Retours

Définit les métadonnées définies par l’utilisateur pour le chemin d’accès spécifié (répertoire du fichier) sous la forme d’une ou plusieurs paires nom-valeur. Si aucune option n’est fournie ou si aucune métadonnées n’est définie dans le paramètre, les métadonnées de chemin d’accès sont supprimées.

Consultez https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

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

Paramètres

Retours

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

Paramètres

Retours

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

function toDirectoryClient(): DataLakeDirectoryClient

Retours

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

function toFileClient(): DataLakeFileClient

Retours

Modifie le Access Control sur un chemin et des sous-chemins.

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

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

Paramètres

Retours