Condividi tramite

DataLakeServiceClient class

  • Riferimento
Pacchetto:
@azure/storage-file-datalake

DataLakeServiceClient consente di modificare le risorse del servizio Azure Data Lake e i file system. L'account di archiviazione fornisce lo spazio dei nomi di primo livello per il servizio Data Lake.

Extends

StorageClient

Costruttori

DataLakeServiceClient(string, Pipeline)

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

Crea un'istanza di DataLakeServiceClient dall'URL.

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

fromConnectionString(string, StoragePipelineOptions)

Crea un'istanza di DataLakeServiceClient dalla stringa di connessione.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per DataLakeServiceClient costruito con credenziali chiave condivise.

Genera un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per DataLakeServiceClient costruito con credenziali chiave condivise.

Genera una stringa per firmare un account firma di accesso condiviso in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getFileSystemClient(string)

Crea un oggetto DataLakeFileSystemClient.
getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà dell'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (Condivisione risorse tra le origini).

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBILE SOLO QUANDO SI USA L'AUTENTICAZIONE TOKEN BEARER (TokenCredential).

Recupera una chiave di delega utente per il servizio Data Lake. Si tratta di un'operazione valida solo quando si usa l'autenticazione del token di connessione.

Esempio

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Required. Date type
    expiresOn, // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
listFileSystems(ServiceListFileSystemsOptions)

Restituisce un iteratore iteratore asincrono per elencare tutti i file system nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i file system nelle pagine.

Esempio di utilizzo della sintassi for await:

let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
  console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}

Esempio di utilizzo di iter.next():

let i = 1;
const iter = serviceClient.listFileSystems();
let fileSystemItem = await iter.next();
while (!fileSystemItem.done) {
  console.log(`FileSystem ${i++}: ${fileSystemItem.value.name}`);
  fileSystemItem = await iter.next();
}

Esempio di utilizzo di byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`FileSystem ${i++}: ${fileSystem.name}`);
    }
  }
}

Esempio di utilizzo del paging con un marcatore:

let i = 1;
let iterator = serviceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = serviceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
     console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Imposta le proprietà per l'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Ripristinare un file system eliminato in precedenza. Questa API è funzionale solo se l'eliminazione temporanea del contenitore è abilitata per l'account di archiviazione.

Dettagli costruttore

DataLakeServiceClient(string, Pipeline)

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

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parametri

url

string

Stringa client che punta al servizio Data Lake di Archiviazione di Azure, ad esempio "https://myaccount.dfs.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

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

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

Crea un'istanza di DataLakeServiceClient dall'URL.

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

Parametri

url

string

Stringa client che punta al servizio Data Lake di Archiviazione di Azure, ad esempio "https://myaccount.dfs.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.dfs.core.windows.net?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

Opzionale. Opzioni per configurare la pipeline HTTP.

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

fromConnectionString(string, StoragePipelineOptions)

Crea un'istanza di DataLakeServiceClient dalla stringa di connessione.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione sas di un account di archiviazione di Azure. [ Nota: la stringa di connessione dell'account può essere usata solo in NODE.JS runtime. ] Esempio di stringa di connessione dell'account - Esempio di stringa di connessione sas DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

options
StoragePipelineOptions

Opzionale. Opzioni per configurare la pipeline HTTP.

Restituisce

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per DataLakeServiceClient costruito con credenziali chiave condivise.

Genera un URI di firma di accesso condiviso (SAS) dell'account in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parametri

expiresOn

Date

Opzionale. Ora in cui la firma di accesso condiviso non è valida. Il valore predefinito è un'ora successiva, se non specificato.

permissions
AccountSASPermissions

Specifica l'elenco di autorizzazioni da associare alla firma di accesso condiviso.

resourceTypes

string

Specifica i tipi di risorsa associati alla firma di accesso condiviso.

options
ServiceGenerateAccountSasUrlOptions

Parametri facoltativi.

Restituisce

string

URI di firma di accesso condiviso dell'account costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponibile solo per DataLakeServiceClient costruito con credenziali chiave condivise.

Genera una stringa per firmare un account firma di accesso condiviso in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parametri

expiresOn

Date

Opzionale. Ora in cui la firma di accesso condiviso non è valida. Il valore predefinito è un'ora successiva, se non specificato.

permissions
AccountSASPermissions

Specifica l'elenco di autorizzazioni da associare alla firma di accesso condiviso.

resourceTypes

string

Specifica i tipi di risorsa associati alla firma di accesso condiviso.

options
ServiceGenerateAccountSasUrlOptions

Parametri facoltativi.

Restituisce

string

URI di firma di accesso condiviso dell'account costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

getFileSystemClient(string)

Crea un oggetto DataLakeFileSystemClient.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parametri

fileSystemName

string

Nome del file system.

Restituisce

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Ottiene le proprietà dell'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per le regole di Analisi archiviazione e CORS (Condivisione risorse tra le origini).

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parametri

options
ServiceGetPropertiesOptions

Opzioni per l'operazione Service Get Properties.Options to the Service Get Properties operation.

Restituisce

Promise<DataLakeServiceGetPropertiesResponse>

Dati di risposta per l'operazione Service Get Properties.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBILE SOLO QUANDO SI USA L'AUTENTICAZIONE TOKEN BEARER (TokenCredential).

Recupera una chiave di delega utente per il servizio Data Lake. Si tratta di un'operazione valida solo quando si usa l'autenticazione del token di connessione.

Esempio

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Required. Date type
    expiresOn, // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parametri

startsOn

Date

Ora di inizio per la firma di accesso condiviso della delega utente. Deve essere entro 7 giorni dall'ora corrente.

expiresOn

Date

Ora di fine per la firma di accesso condiviso della delega utente. Deve essere entro 7 giorni dall'ora corrente.

options
ServiceGetUserDelegationKeyOptions

Restituisce

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Restituisce un iteratore iteratore asincrono per elencare tutti i file system nell'account specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i file system nelle pagine.

Esempio di utilizzo della sintassi for await:

let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
  console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}

Esempio di utilizzo di iter.next():

let i = 1;
const iter = serviceClient.listFileSystems();
let fileSystemItem = await iter.next();
while (!fileSystemItem.done) {
  console.log(`FileSystem ${i++}: ${fileSystemItem.value.name}`);
  fileSystemItem = await iter.next();
}

Esempio di utilizzo di byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`FileSystem ${i++}: ${fileSystem.name}`);
    }
  }
}

Esempio di utilizzo del paging con un marcatore:

let i = 1;
let iterator = serviceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = serviceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
     console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2

function listFileSystems(options?: ServiceListFileSystemsOptions): PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

Parametri

options
ServiceListFileSystemsOptions

Restituisce

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Imposta le proprietà per l'endpoint del servizio BLOB di un account di archiviazione, incluse le proprietà per Analisi archiviazione, le regole CORS (Condivisione risorse tra le origini) e le impostazioni di eliminazione temporanea.

Fare riferimento a https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parametri

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Opzioni per l'operazione Proprietà set di servizi.

Restituisce

Promise<ServiceSetPropertiesResponse>

Dati di risposta per l'operazione Proprietà set di servizi.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Ripristinare un file system eliminato in precedenza. Questa API è funzionale solo se l'eliminazione temporanea del contenitore è abilitata per l'account di archiviazione.

function undeleteFileSystem(deletedFileSystemName: string, deleteFileSystemVersion: string, options?: ServiceUndeleteFileSystemOptions): Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>

Parametri

deletedFileSystemName

string

Nome del file system di origine.

deleteFileSystemVersion

string

Nuovo nome del file system.

options
ServiceUndeleteFileSystemOptions

Opzioni per configurare l'operazione di ripristino del file system.

Restituisce

Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>