DataLakePathClient class

Crea un'istanza di DataLakePathClient dall'URL e dalla pipeline.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parametri

Crea un'istanza di DataLakePathClient dall'URL e dalle credenziali.

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

Parametri

Nome del file system corrente.

string fileSystemName

Valore della proprietà

Nome del percorso corrente (directory o file).

string name

Valore della proprietà

accountName: string

Valore della proprietà

Ereditato da StorageClient.accountName

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del @azure/identity pacchetto per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

Ereditato da StorageClient.credential

Valore stringa URL codificato.

url: string

Valore della proprietà

Ereditato da StorageClient.url

Creare una directory o un percorso.

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

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

Parametri

Restituisce

Creare una directory o un file. Se la risorsa esiste già, non viene modificata.

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

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

Parametri

Restituisce

Eliminare il percorso corrente (directory o file).

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

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

Parametri

Restituisce

Eliminare il percorso corrente (directory o file) se esistente.

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

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

Parametri

Restituisce

Restituisce true se il file Data Lake rappresentato da questo client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché un file esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, è possibile aggiungere nuovi file da altri client o applicazioni al termine di questa funzione.

function exists(options?: PathExistsOptions): Promise<boolean>

Parametri

Restituisce

Restituisce i dati di controllo di accesso per un percorso (directory di file).

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

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

Parametri

Restituisce

Ottenere un DataLakeLeaseClient che gestisce i lease nel percorso (directory o file).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametri

Restituisce

Restituisce tutti i metadati definiti dall'utente, le proprietà HTTP standard e le proprietà di sistema per il percorso (directory o file).

AVVISO: l'oggetto metadata restituito nella risposta avrà le chiavi in lettere minuscole, anche se in origine contengono caratteri maiuscoli. Questo comportamento è diverso dalle chiavi di metadati restituite dai metodi di DataLakeFileSystemClient che elencano i percorsi usando l'opzione , che manterrà la includeMetadata combinazione di maiuscole e minuscole originali.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

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

Parametri

Restituisce

Spostare la directory o il file all'interno dello stesso file system.

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

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

Parametri

Restituisce

Spostare la directory o il file in un altro file system.

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

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

Parametri

Restituisce

Rimuove il Controllo di accesso in un percorso e in percorsi secondari.

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

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

Parametri

Restituisce

Impostare i dati di controllo di accesso per un percorso (directory di file).

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

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

Parametri

Restituisce

Imposta la Controllo di accesso su un percorso e su percorsi secondari.

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

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

Parametri

Restituisce

Imposta le proprietà di sistema nel percorso (directory o file).

Se non viene specificato alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

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

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

Parametri

Restituisce

Imposta i metadati definiti dall'utente per il percorso specificato (directory del file) come una o più coppie nome-valore.

Se non sono disponibili opzioni o nessun metadati definito nel parametro, i metadati del percorso verranno rimossi.

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

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

Parametri

Restituisce

Imposta le autorizzazioni per il file in un percorso.

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

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

Parametri

Restituisce

Convertire l'oggetto DataLakePathClient corrente in DataLakeDirectoryClient se il percorso corrente è una directory.

function toDirectoryClient(): DataLakeDirectoryClient

Restituisce

Convertire l'oggetto DataLakePathClient corrente in DataLakeFileClient se il percorso corrente è un file.

function toFileClient(): DataLakeFileClient

Restituisce

Modifica il Controllo di accesso in un percorso e in percorsi secondari.

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

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

Parametri

Restituisce