Delen via

DataLakeServiceClient class

  • Referentie
Pakket:
@azure/storage-file-datalake

Met DataLakeServiceClient kunt u Azure Data Lake-serviceresources en -bestandssystemen bewerken. Het opslagaccount biedt de naamruimte op het hoogste niveau voor de Data Lake-service.

Extends

StorageClient

Constructors

DataLakeServiceClient(string, Pipeline)

Hiermee maakt u een exemplaar van DataLakeServiceClient op basis van URL en pijplijn.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van DataLakeServiceClient op basis van de URL.

Overgenomen eigenschappen

accountName
credential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
url

Gecodeerde URL-tekenreekswaarde.

Methoden

fromConnectionString(string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van DataLakeServiceClient op basis van connection string.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Alleen beschikbaar voor DataLakeServiceClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een SAS-URI (Shared Access Signature) gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

Hiermee maakt u een DataLakeFileSystemClient-object .
getProperties(ServiceGetPropertiesOptions)

Hiermee haalt u de eigenschappen op van het Blob-service-eindpunt van een opslagaccount, inclusief eigenschappen voor Opslaganalyse- en CORS-regels (Cross-Origin Resource Sharing).

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

ALLEEN BESCHIKBAAR BIJ GEBRUIK VAN BEARER-TOKENVERIFICATIE (TokenCredential).

Hiermee haalt u een sleutel voor gebruikersdelegatie op voor de Data Lake-service. Dit is alleen een geldige bewerking wanneer bearer-tokenverificatie wordt gebruikt.

Voorbeeld

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

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

Retourneert een asynchrone iterator om alle bestandssystemen onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de bestandssystemen in pagina's weer te geven.

Voorbeeld met syntaxis for await :

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een markering:

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

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

Hiermee stelt u eigenschappen in voor het Blob-service-eindpunt van een opslagaccount, waaronder eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

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

Een eerder verwijderd bestandssysteem herstellen. Deze API is alleen functioneel als Voorlopig verwijderen van container is ingeschakeld voor het opslagaccount.

Constructordetails

DataLakeServiceClient(string, Pipeline)

Hiermee maakt u een exemplaar van DataLakeServiceClient op basis van URL en pijplijn.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parameters

url

string

Een clienttekenreeks die verwijst naar Azure Storage Data Lake-service, zoals 'https://myaccount.dfs.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.

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

Hiermee maakt u een exemplaar van DataLakeServiceClient op basis van de URL.

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

Parameters

url

string

Een clienttekenreeks die verwijst naar Azure Storage Data Lake-service, zoals 'https://myaccount.dfs.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options
StoragePipelineOptions

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

Overgenomen van StorageClient.accountName

credential

Zoals AnonymousCredential, StorageSharedKeyCredential of een referentie uit het @azure/identity pakket om aanvragen voor de service te verifiëren. U kunt ook een -object opgeven waarmee de interface TokenCredential wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Overgenomen van StorageClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

Overgenomen van StorageClient.url

Methodedetails

fromConnectionString(string, StoragePipelineOptions)

Hiermee maakt u een exemplaar van DataLakeServiceClient op basis van connection string.

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

Parameters

connectionString

string

Account connection string of een SAS-connection string van een Azure-opslagaccount. [ Opmerking: account connection string kunnen alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van account connection string -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netVoorbeeld van SAS-connection string -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

Optioneel. Opties voor het configureren van de HTTP-pijplijn.

Retouren

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Alleen beschikbaar voor DataLakeServiceClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een SAS-URI (Shared Access Signature) gegenereerd op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

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

Parameters

expiresOn

Date

Optioneel. Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Standaard ingesteld op een uur later als dit niet is opgegeven.

permissions
AccountSASPermissions

Hiermee geeft u de lijst met machtigingen die moeten worden gekoppeld aan de SAS.

resourceTypes

string

Hiermee geeft u de resourcetypen op die zijn gekoppeld aan de handtekening voor gedeelde toegang.

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

Een SAS-URI van het account die bestaat uit de URI voor de resource die door deze client wordt vertegenwoordigd, gevolgd door het gegenereerde SAS-token.

getFileSystemClient(string)

Hiermee maakt u een DataLakeFileSystemClient-object .

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parameters

fileSystemName

string

Bestandsnaam.

Retouren

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Hiermee haalt u de eigenschappen op van het Blob-service-eindpunt van een opslagaccount, inclusief eigenschappen voor Opslaganalyse- en CORS-regels (Cross-Origin Resource Sharing).

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

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

Parameters

options
ServiceGetPropertiesOptions

Opties voor de bewerking Eigenschappen ophalen van service.

Retouren

Promise<DataLakeServiceGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen ophalen van service.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ALLEEN BESCHIKBAAR BIJ GEBRUIK VAN BEARER-TOKENVERIFICATIE (TokenCredential).

Hiermee haalt u een sleutel voor gebruikersdelegatie op voor de Data Lake-service. Dit is alleen een geldige bewerking wanneer bearer-tokenverificatie wordt gebruikt.

Voorbeeld

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

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

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

Parameters

startsOn

Date

De begintijd voor de SAS voor gebruikersdelegatie. Moet binnen 7 dagen van de huidige tijd zijn.

expiresOn

Date

De eindtijd voor de SAS voor gebruikersdelegatie. Moet binnen 7 dagen van de huidige tijd zijn.

options
ServiceGetUserDelegationKeyOptions

Retouren

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Retourneert een asynchrone iterator om alle bestandssystemen onder het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de bestandssystemen in pagina's weer te geven.

Voorbeeld met syntaxis for await :

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

Voorbeeld met 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();
}

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

Voorbeeld van paging met een markering:

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

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

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

Parameters

options
ServiceListFileSystemsOptions

Retouren

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Hiermee stelt u eigenschappen in voor het Blob-service-eindpunt van een opslagaccount, waaronder eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

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

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

Parameters

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Opties voor de bewerking Eigenschappen van serviceset.

Retouren

Promise<ServiceSetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen van de serviceset.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Een eerder verwijderd bestandssysteem herstellen. Deze API is alleen functioneel als Voorlopig verwijderen van container is ingeschakeld voor het opslagaccount.

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

Parameters

deletedFileSystemName

string

De naam van het bronbestandssysteem.

deleteFileSystemVersion

string

De nieuwe naam van het bestandssysteem.

options
ServiceUndeleteFileSystemOptions

Opties voor het configureren van de herstelbewerking van het bestandssysteem.

Retouren

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