DataLakeDirectoryClient class
DataLakeDirectoryClient rappresenta un URL della directory di Archiviazione di Azure.
- Extends
Costruttori
| Data |
Crea un'istanza di DataLakePathClient dall'URL e dalla pipeline. |
| Data |
Crea un'istanza di DataLakePathClient da URL e credenziali. |
Proprietà
| file |
Nome del file system corrente. |
| name | Nome del percorso corrente (directory o file). |
Proprietà ereditate
| account |
|
| credential | Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto |
| url | Valore stringa URL codificato. |
Metodi
Metodi ereditati
| delete(boolean, Path |
Eliminare il percorso corrente (directory o file). Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Eliminare il percorso corrente (directory o file) se esistente. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
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. |
| get |
Restituisce i dati di controllo di accesso per un percorso (directory di file). Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Ottenere un DataLakeLeaseClient che gestisce i lease nel percorso (directory o file). |
| get |
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 Vedere https://learn.microsoft.com/rest/api/storageservices/get-blob-properties |
| move(string, Path |
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, Path |
Spostare la directory o il file in un altro file system. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Rimuove il controllo di accesso in un percorso e in percorsi secondari. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Impostare i dati di controllo di accesso per un percorso (directory di file). Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Imposta il controllo di accesso in un percorso e in percorsi secondari. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
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 |
| set |
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 |
| set |
Imposta le autorizzazioni per il file in un percorso. Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Convertire dataLakePathClient corrente in DataLakeDirectoryClient se il percorso corrente è una directory. |
| to |
Convertire dataLakePathClient corrente in DataLakeFileClient se il percorso corrente è un file. |
| update |
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
DataLakeDirectoryClient(string, Pipeline)
Crea un'istanza di DataLakePathClient dall'URL e dalla pipeline.
new DataLakeDirectoryClient(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.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Crea un'istanza di DataLakePathClient da URL e credenziali.
new DataLakeDirectoryClient(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 fileSystemNameValore della proprietà
string
name
Nome del percorso corrente (directory o file).
string nameValore della proprietà
string
Dettagli 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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialValore della proprietà
Ereditato daDataLakePathClient.credential
url
Valore stringa URL codificato.
url: stringValore della proprietà
string
Ereditato daDataLakePathClient.url
Dettagli metodo
create(DirectoryCreateOptions)
Creare una directory.
Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parametri
- options
- DirectoryCreateOptions
Optional. Opzioni durante la creazione della directory.
Restituisce
Promise<DirectoryCreateResponse>
create(PathResourceType, PathCreateOptions)
Creare una directory.
Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>Parametri
- resourceType
- PathResourceTypeModel
Il tipo di risorsa deve essere "directory" per DataLakeDirectoryClient.
- options
- PathCreateOptions
Optional. Opzioni durante la creazione della directory.
Restituisce
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Creare una directory se non esiste già.
Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Parametri
Restituisce
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
Creare una directory se non esiste già.
Vedere https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parametri
- resourceType
- PathResourceTypeModel
Il tipo di risorsa deve essere "directory" per DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Restituisce
Promise<PathCreateIfNotExistsResponse>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati.
Vedere https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): stringParametri
- options
- DirectoryGenerateSasUrlOptions
Parametri facoltativi.
Restituisce
string
URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.
generateSasUrl(DirectoryGenerateSasUrlOptions)
Disponibile solo per i client costruiti con credenziali di chiave condivisa.
Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.
Vedere https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parametri
- options
- DirectoryGenerateSasUrlOptions
Parametri facoltativi.
Restituisce
Promise<string>
URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Genera una stringa per firmare un URI della firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati nella firma di accesso condiviso con la chiave di delega dell'utente di input.
Vedere https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): stringParametri
- options
- DirectoryGenerateSasUrlOptions
Parametri facoltativi.
- userDelegationKey
- UserDelegationKey
Valore restituito di blobServiceClient.getUserDelegationKey()
Restituisce
string
URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.
Vedere https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>Parametri
- options
- DirectoryGenerateSasUrlOptions
Parametri facoltativi.
- userDelegationKey
- UserDelegationKey
Valore restituito di blobServiceClient.getUserDelegationKey()
Restituisce
Promise<string>
URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.
getFileClient(string)
Crea un oggetto DataLakeFileClient
function getFileClient(fileName: string): DataLakeFileClientParametri
- fileName
-
string
Restituisce
getSubdirectoryClient(string)
Crea un oggetto DataLakeDirectoryClient nella directory corrente.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParametri
- subdirectoryName
-
string
Nome della sottodirectory.
Restituisce
Dettagli dei metodi ereditati
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>
Ereditato daDataLakePathClient.delete
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>
Ereditato daDataLakePathClient.deleteIfExists
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>
Ereditato daDataLakePathClient.exists
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>
Ereditato daDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Ottenere un DataLakeLeaseClient che gestisce i lease nel percorso (directory o file).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParametri
- proposeLeaseId
-
string
Optional. ID lease proposto iniziale.
Restituisce
Ereditato daDataLakePathClient.getDataLakeLeaseClient
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>
Ereditato daDataLakePathClient.getProperties
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>
Ereditato daDataLakePathClient.move
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>
Ereditato daDataLakePathClient.move
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
Elenco di controllo di accesso POSIX per il file o la directory.
Optional. Options
Restituisce
Ereditato daDataLakePathClient.removeAccessControlRecursive
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
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>
Ereditato daDataLakePathClient.setAccessControl
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
Elenco di controllo di accesso POSIX per il file o la directory.
Optional. Options
Restituisce
Ereditato daDataLakePathClient.setAccessControlRecursive
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>
Ereditato daDataLakePathClient.setHttpHeaders
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>
Ereditato daDataLakePathClient.setMetadata
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>
Ereditato daDataLakePathClient.setPermissions
toDirectoryClient()
Convertire dataLakePathClient corrente in DataLakeDirectoryClient se il percorso corrente è una directory.
function toDirectoryClient(): DataLakeDirectoryClientRestituisce
Ereditato daDataLakePathClient.toDirectoryClient
toFileClient()
Convertire dataLakePathClient corrente in DataLakeFileClient se il percorso corrente è un file.
function toFileClient(): DataLakeFileClientRestituisce
Ereditato daDataLakePathClient.toFileClient
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
Elenco di controllo di accesso POSIX per il file o la directory.
Optional. Options
Restituisce
Ereditato daDataLakePathClient.updateAccessControlRecursive