Partager via

DataLakeServiceClient class

  • Référence
Paquet:
@azure/storage-file-datalake

DataLakeServiceClient vous permet de manipuler des ressources et des systèmes de fichiers du service Azure Data Lake. Le compte de stockage fournit l’espace de noms de niveau supérieur pour le service Data Lake.

Extends

StorageClient

Constructeurs

DataLakeServiceClient(string, Pipeline)

Crée une instance de DataLakeServiceClient à partir de l’URL et du pipeline.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crée une instance de DataLakeServiceClient à partir de l’URL.

Propriétés héritées

accountName
credential

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é.
url

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

Méthodes

fromConnectionString(string, StoragePipelineOptions)

Crée une instance de DataLakeServiceClient à partir d’une chaîne de connexion.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour DataLakeServiceClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAS) de compte en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getFileSystemClient(string)

Crée un objet DataLakeFileSystemClient .
getProperties(ServiceGetPropertiesOptions)

Obtient les propriétés du point de terminaison de service Blob d’un compte de stockage, y compris les propriétés pour les règles Storage Analytics et CORS (Cross-Origin Resource Sharing).

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBLE UNIQUEMENT LORS DE L’UTILISATION DE L’AUTHENTIFICATION PAR JETON DU PORTEUR (TokenCredential).

Récupère une clé de délégation utilisateur pour le service Data Lake. Il s’agit uniquement d’une opération valide lors de l’utilisation de l’authentification par jeton du porteur.

Exemple

// 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();

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
listFileSystems(ServiceListFileSystemsOptions)

Retourne un itérateur asynchrone itérateur pour répertorier tous les systèmes de fichiers sous le compte spécifié.

.byPage() retourne un itérateur itérateur asynchrone pour répertorier les systèmes de fichiers dans les pages.

Exemple utilisant la for await syntaxe :

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

Exemple utilisant 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();
}

Exemple utilisant 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}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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}`);
  }
}

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Définit les propriétés du point de terminaison de service Blob d’un compte de stockage, y compris les propriétés pour les Storage Analytics, les règles CORS (Cross-Origin Resource Sharing) et les paramètres de suppression réversible.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Restaurez un système de fichiers précédemment supprimé. Cette API est uniquement fonctionnelle si la suppression réversible de conteneur est activée pour le compte de stockage.

Détails du constructeur

DataLakeServiceClient(string, Pipeline)

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

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Paramètres

url

string

Chaîne cliente pointant vers le service de lac de données stockage Azure, telle que « https://myaccount.dfs.core.windows.net". Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.dfs.core.windows.net?sasString" ; ».

pipeline
Pipeline

Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.

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

Crée une instance de DataLakeServiceClient à partir de l’URL.

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

Paramètres

url

string

Chaîne cliente pointant vers le service de lac de données stockage Azure, telle que « https://myaccount.dfs.core.windows.net". Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.dfs.core.windows.net?sasString" ; ».

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

Optionnel. Options pour configurer le pipeline HTTP.

Détails de la propriété héritée

accountName 

accountName: string

Valeur de propriété

string

Hérité de StorageClient.accountName

credential

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é

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hérité de StorageClient.credential

url

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

url: string

Valeur de propriété

string

Hérité de StorageClient.url

Détails de la méthode

fromConnectionString(string, StoragePipelineOptions)

Crée une instance de DataLakeServiceClient à partir d’une chaîne de connexion.

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

Paramètres

connectionString

string

Chaîne de connexion de compte ou chaîne de connexion SAP d’un compte de stockage Azure. [ Remarque : la chaîne de connexion de compte ne peut être utilisée que dans NODE.JS runtime. ] Exemple de chaîne de connexion de compte -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemple de chaîne de connexion SAS - 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

Optionnel. Options pour configurer le pipeline HTTP.

Retours

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponible uniquement pour DataLakeServiceClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAS) de compte en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Paramètres

expiresOn

Date

Optionnel. Heure à laquelle la signature d’accès partagé devient non valide. Par défaut, une heure plus tard s’il n’est pas spécifié.

permissions
AccountSASPermissions

Spécifie la liste des autorisations à associer à la sap.

resourceTypes

string

Spécifie les types de ressources associés à la signature d’accès partagé.

options
ServiceGenerateAccountSasUrlOptions

Paramètres facultatifs.

Retours

string

URI SAP de compte constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

getFileSystemClient(string)

Crée un objet DataLakeFileSystemClient .

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Paramètres

fileSystemName

string

Nom du système de fichiers.

Retours

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Obtient les propriétés du point de terminaison de service Blob d’un compte de stockage, y compris les propriétés pour les règles Storage Analytics et CORS (Cross-Origin Resource Sharing).

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

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

Paramètres

options
ServiceGetPropertiesOptions

Options de l’opération Propriétés d’obtention du service.

Retours

Promise<DataLakeServiceGetPropertiesResponse>

Données de réponse pour l’opération Propriétés d’obtention du service.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

DISPONIBLE UNIQUEMENT LORS DE L’UTILISATION DE L’AUTHENTIFICATION PAR JETON DU PORTEUR (TokenCredential).

Récupère une clé de délégation utilisateur pour le service Data Lake. Il s’agit uniquement d’une opération valide lors de l’utilisation de l’authentification par jeton du porteur.

Exemple

// 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();

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

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

Paramètres

startsOn

Date

Heure de début de la sap de délégation d’utilisateur. Doit être dans les 7 jours suivant l’heure actuelle.

expiresOn

Date

Heure de fin de la sap de délégation d’utilisateur. Doit être dans les 7 jours suivant l’heure actuelle.

options
ServiceGetUserDelegationKeyOptions

Retours

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Retourne un itérateur asynchrone itérateur pour répertorier tous les systèmes de fichiers sous le compte spécifié.

.byPage() retourne un itérateur itérateur asynchrone pour répertorier les systèmes de fichiers dans les pages.

Exemple utilisant la for await syntaxe :

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

Exemple utilisant 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();
}

Exemple utilisant 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}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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}`);
  }
}

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2

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

Paramètres

options
ServiceListFileSystemsOptions

Retours

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Définit les propriétés du point de terminaison de service Blob d’un compte de stockage, y compris les propriétés pour les Storage Analytics, les règles CORS (Cross-Origin Resource Sharing) et les paramètres de suppression réversible.

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

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

Paramètres

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Options de l’opération Propriétés du jeu de services.

Retours

Promise<ServiceSetPropertiesResponse>

Données de réponse pour l’opération Propriétés du jeu de services.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Restaurez un système de fichiers précédemment supprimé. Cette API est uniquement fonctionnelle si la suppression réversible de conteneur est activée pour le compte de stockage.

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

Paramètres

deletedFileSystemName

string

Nom du système de fichiers source.

deleteFileSystemVersion

string

Nouveau nom du système de fichiers.

options
ServiceUndeleteFileSystemOptions

Options permettant de configurer l’opération de restauration du système de fichiers.

Retours

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