DataLakePathClient class

Pacchetto:

@azure/storage-file-datalake

DataLakePathClient rappresenta un URL del percorso di Archiviazione di Azure (directory o file).

Extends

StorageClient

Costruttori

DataLakePathClient(string, Pipeline)	Crea un'istanza di DataLakePathClient dall'URL e dalla pipeline.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Crea un'istanza di DataLakePathClient da URL e credenziali.

Proprietà

fileSystemName	Nome del file system corrente.
name	Nome del percorso corrente (directory o file).

Proprietà ereditate

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

Metodi

create(PathResourceType, PathCreateOptions)	Creare una directory o un percorso. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)	Creare una directory o un file. Se la risorsa esiste già, non viene modificata. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Eliminare il percorso corrente (directory o file). Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Eliminare il percorso corrente (directory o file) se esistente. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Restituisce true se il file Data Lake rappresentato dal 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.
getAccessControl(PathGetAccessControlOptions)	Restituisce i dati di controllo di accesso per un percorso (directory di file). Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Ottenere un DataLakeLeaseClient che gestisce i lease nel percorso (directory o file).
getProperties(PathGetPropertiesOptions)	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 relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dai metodi di DataLakeFileSystemClient che elencano i percorsi usando l'opzione includeMetadata, che manterrà la combinazione di maiuscole e minuscole originali. Vedere https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Spostare la directory o il file all'interno dello stesso file system. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Spostare la directory o il file in un altro file system. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Rimuove il controllo di accesso in un percorso e in percorsi secondari. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Impostare i dati di controllo di accesso per un percorso (directory di file). Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Imposta il controllo di accesso in un percorso e in percorsi secondari. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	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://learn.microsoft.com/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Imposta i metadati definiti dall'utente per il percorso specificato (directory del file) come una o più coppie nome-valore. Se non viene specificata alcuna opzione o nessun metadato definito nel parametro, i metadati del percorso verranno rimossi. Vedere https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Imposta le autorizzazioni per il file in un percorso. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Convertire dataLakePathClient corrente in DataLakeDirectoryClient se il percorso corrente è una directory.
toFileClient()	Convertire dataLakePathClient corrente in DataLakeFileClient se il percorso corrente è un file.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Modifica il controllo di accesso in un percorso e in percorsi secondari. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

Dettagli costruttore

DataLakePathClient(string, Pipeline)

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

new DataLakePathClient(url: string, pipeline: Pipeline)

Parametri

url

string

Stringa client che punta al percorso data lake di Archiviazione di Azure (directory o file), ad esempio "https://myaccount.dfs.core.windows.net/filesystem/directory" o "https://myaccount.dfs.core.windows.net/filesystem/file". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

pipeline

Pipeline

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un'istanza di DataLakePathClient da URL e credenziali.

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

Parametri

url

string

Stringa client che punta al percorso data lake di Archiviazione di Azure (directory o file), ad esempio "https://myaccount.dfs.core.windows.net/filesystem/directory" o "https://myaccount.dfs.core.windows.net/filesystem/file". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options

StoragePipelineOptions

Optional. Opzioni per configurare la pipeline HTTP.

Dettagli proprietà

fileSystemName

Nome del file system corrente.

string fileSystemName

Valore della proprietà

string

name

Nome del percorso corrente (directory o file).

string name

Valore della proprietà

string

Dettagli proprietà ereditate

accountName

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

credential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity 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à

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ereditato da StorageClient.credential

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

create(PathResourceType, PathCreateOptions)

Creare una directory o un percorso.

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

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

Parametri

resourceType

PathResourceTypeModel

Tipo di risorsa, "directory" o "file".

options

PathCreateOptions

Optional. Opzioni durante la creazione del percorso.

Restituisce

Promise<PathCreateResponse>

createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

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

Parametri

resourceType

PathResourceTypeModel

Tipo di risorsa, "directory" o "file".

options

PathCreateIfNotExistsOptions

Restituisce

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

Eliminare il percorso corrente (directory o file).

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

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

Parametri

recursive

boolean

Obbligatorio e valido solo quando la risorsa è una directory. Se "true", tutti i percorsi sotto la directory verranno eliminati.

options

PathDeleteOptions

Optional. Opzioni durante l'eliminazione del percorso.

Restituisce

Promise<PathDeleteResponse>

deleteIfExists(boolean, PathDeleteOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

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

Parametri

recursive

boolean

Obbligatorio e valido solo quando la risorsa è una directory. Se "true", tutti i percorsi sotto la directory verranno eliminati.

options

PathDeleteOptions

Restituisce

Promise<PathDeleteIfExistsResponse>

exists(PathExistsOptions)

Restituisce true se il file Data Lake rappresentato dal 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

options

PathExistsOptions

opzioni per l'operazione Exists.

Restituisce

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties

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

Parametri

options

PathGetAccessControlOptions

Optional. Opzioni quando si ottiene il controllo di accesso ai file.

Restituisce

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametri

proposeLeaseId

string

Optional. ID lease proposto iniziale.

Restituisce

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

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 relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dai metodi di DataLakeFileSystemClient che elencano i percorsi usando l'opzione includeMetadata, che manterrà la combinazione di maiuscole e minuscole originali.

Vedere https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

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

Parametri

options

PathGetPropertiesOptions

Optional. Opzioni durante il recupero delle proprietà del percorso.

Restituisce

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

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

Parametri

destinationPath

string

Percorso della directory di destinazione, ad esempio "directory" o percorso file "directory/file". Se destinationPath viene autenticato con la firma di accesso condiviso, aggiungere la firma di accesso condiviso al percorso di destinazione, ad esempio "directory/file?sasToken".

options

PathMoveOptions

Optional. Opzioni per lo spostamento di directory o file.

Restituisce

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

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

Parametri

destinationFileSystem

string

File system di destinazione come "file system".

destinationPath

string

Percorso della directory di destinazione come "directory" o percorso file "directory/file" Se destinationPath è autenticato con firma di accesso condiviso, aggiungere la firma di accesso condiviso al percorso di destinazione, ad esempio "directory/file?sasToken".

options

PathMoveOptions

Optional. Opzioni per lo spostamento di directory o file.

Restituisce

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parametri

acl

RemovePathAccessControlItem[]

Elenco di controllo di accesso POSIX per il file o la directory.

options

PathChangeAccessControlRecursiveOptions

Optional. Options

Restituisce

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parametri

acl

PathAccessControlItem[]

Elenco di controllo di accesso POSIX per il file o la directory.

options

PathSetAccessControlOptions

Optional. Opzioni quando si imposta il controllo di accesso del percorso.

Restituisce

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Imposta il controllo di accesso in un percorso e in percorsi secondari.

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parametri

acl

PathAccessControlItem[]

Elenco di controllo di accesso POSIX per il file o la directory.

options

PathChangeAccessControlRecursiveOptions

Optional. Options

Restituisce

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

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

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

Parametri

httpHeaders

PathHttpHeaders

options

PathSetHttpHeadersOptions

Restituisce

Promise<PathSetHttpHeadersResponse>

setMetadata(Metadata, PathSetMetadataOptions)

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

Se non viene specificata alcuna opzione o nessun metadato definito nel parametro, i metadati del percorso verranno rimossi.

Vedere https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

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

Parametri

metadata

Metadata

Optional. Sostituire i metadati esistenti con questo valore. Se non viene specificato alcun valore, i metadati esistenti verranno rimossi.

options

PathSetMetadataOptions

Optional. Opzioni quando si impostano i metadati del percorso.

Restituisce

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

Imposta le autorizzazioni per il file in un percorso.

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parametri

permissions

PathPermissions

Autorizzazioni di accesso POSIX per il proprietario del file, il gruppo proprietario del file e altri.

options

PathSetPermissionsOptions

Optional. Opzioni durante l'impostazione delle autorizzazioni per il percorso.

Restituisce

Promise<PathSetPermissionsResponse>

toDirectoryClient()

Convertire dataLakePathClient corrente in DataLakeDirectoryClient se il percorso corrente è una directory.

function toDirectoryClient(): DataLakeDirectoryClient

Restituisce

DataLakeDirectoryClient

toFileClient()

Convertire dataLakePathClient corrente in DataLakeFileClient se il percorso corrente è un file.

function toFileClient(): DataLakeFileClient

Restituisce

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

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

Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

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

Parametri

acl

PathAccessControlItem[]

Elenco di controllo di accesso POSIX per il file o la directory.

options

PathChangeAccessControlRecursiveOptions

Optional. Options

Restituisce

Promise<PathChangeAccessControlRecursiveResponse>