Delen via

DataLakeServiceClient class

Pakket:
@azure/storage-file-datalake

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

Uitbreiding

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 referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface 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 de verbindingsreeks.
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://free.blessedness.top/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

Zie https://free.blessedness.top/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 regels voor Storage Analytics en CORS (Cross-Origin Resource Sharing).

Zie https://free.blessedness.top/rest/api/storageservices/get-blob-service-properties
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

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

Hiermee haalt u een gebruikersdelegeringssleutel voor de Data Lake-service op. Dit is alleen een geldige bewerking bij het gebruik van bearer-tokenverificatie.

Example

import {
  DataLakeServiceClient,
  generateDataLakeSASQueryParameters,
  FileSystemSASPermissions,
  SASProtocol,
} from "@azure/storage-file-datalake";

const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net${sas}`,
);

const fileSystemName = "<file system name>";
const accountName = "<account name>";
const startsOn = new Date();
const expiresOn = new Date(+new Date() + 86400 * 1000);
// 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://free.blessedness.top/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 van for await syntaxis:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
for await (const fileSystem of fileSystems) {
  console.log(`File system ${i++}: ${fileSystem.name}`);
}

Voorbeeld van iter.next():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
let { value, done } = await fileSystems.next();
while (!done) {
  console.log(`File system ${i++}: ${value.name}`);
  ({ value, done } = await fileSystems.next());
}

Voorbeeld van byPage():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const response of datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`File System ${i++}: ${fileSystem.name}`);
    }
  }
}

Voorbeeld van het gebruik van paging met een markering:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let fileSystems = datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await fileSystems.next()).value;
// Prints 2 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
fileSystems = datalakeServiceClient
  .listFileSystems()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await fileSystems.next()).value;
// Prints 10 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}

Zie https://free.blessedness.top/rest/api/storageservices/list-containers2
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

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

Zie https://free.blessedness.top/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 containers 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 de 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 geef een aangepaste pijplijn op.

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 de 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 referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options
StoragePipelineOptions

Optional. 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 referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface 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 de verbindingsreeks.

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

Parameters

connectionString

string

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - 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

Optional. 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://free.blessedness.top/rest/api/storageservices/create-account-sas

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

Parameters

expiresOn

Date

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

permissions
AccountSASPermissions

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

resourceTypes

string

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

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

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

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

Zie https://free.blessedness.top/rest/api/storageservices/create-account-sas

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

Parameters

expiresOn

Date

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

permissions
AccountSASPermissions

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

resourceTypes

string

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

options
ServiceGenerateAccountSasUrlOptions

Optionele parameters.

Retouren

string

Een account-SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, 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 regels voor Storage Analytics en CORS (Cross-Origin Resource Sharing).

Zie https://free.blessedness.top/rest/api/storageservices/get-blob-service-properties

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

Parameters

options
ServiceGetPropertiesOptions

Opties voor de bewerking Eigenschappen van service ophalen.

Retouren

Promise<DataLakeServiceGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen van service ophalen.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

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

Hiermee haalt u een gebruikersdelegeringssleutel voor de Data Lake-service op. Dit is alleen een geldige bewerking bij het gebruik van bearer-tokenverificatie.

Example

import {
  DataLakeServiceClient,
  generateDataLakeSASQueryParameters,
  FileSystemSASPermissions,
  SASProtocol,
} from "@azure/storage-file-datalake";

const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net${sas}`,
);

const fileSystemName = "<file system name>";
const accountName = "<account name>";
const startsOn = new Date();
const expiresOn = new Date(+new Date() + 86400 * 1000);
// 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://free.blessedness.top/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 na de huidige tijd zijn.

expiresOn

Date

De eindtijd voor de SAS voor gebruikersdelegatie. Moet binnen 7 dagen na 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 van for await syntaxis:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
for await (const fileSystem of fileSystems) {
  console.log(`File system ${i++}: ${fileSystem.name}`);
}

Voorbeeld van iter.next():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
let { value, done } = await fileSystems.next();
while (!done) {
  console.log(`File system ${i++}: ${value.name}`);
  ({ value, done } = await fileSystems.next());
}

Voorbeeld van byPage():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const response of datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`File System ${i++}: ${fileSystem.name}`);
    }
  }
}

Voorbeeld van het gebruik van paging met een markering:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let fileSystems = datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await fileSystems.next()).value;
// Prints 2 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
fileSystems = datalakeServiceClient
  .listFileSystems()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await fileSystems.next()).value;
// Prints 10 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}

Zie https://free.blessedness.top/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, inclusief eigenschappen voor Opslaganalyse, CORS-regels (Cross-Origin Resource Sharing) en instellingen voor voorlopig verwijderen.

Zie https://free.blessedness.top/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 de 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 containers 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 bestandssysteem.

Retouren

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