Megosztás a következőn keresztül:

DataLakeServiceClient class

  • Referencia
Csomag:
@azure/storage-file-datalake

A DataLakeServiceClient lehetővé teszi az Azure Data Lake-szolgáltatás erőforrásainak és fájlrendszerének manipulálására. A tárfiók biztosítja a Data Lake szolgáltatás legfelső szintű névterét.

Extends

StorageClient

Konstruktorok

DataLakeServiceClient(string, Pipeline)

Létrehoz egy DataLakeServiceClient-példányt az URL-címből és a folyamatból.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehoz egy DataLakeServiceClient-példányt az URL-címből.

Örökölt tulajdonságok

accountName
credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a csomag bármely hitelesítő adata a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.
url

Kódolt URL-sztringérték.

Metódusok

fromConnectionString(string, StoragePipelineOptions)

Létrehoz egy DataLakeServiceClient-példányt a kapcsolati sztring.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott DataLakeServiceClient esetén érhető el.

Létrehoz egy fiók közös hozzáférésű jogosultságkódját (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

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

Létrehoz egy DataLakeFileSystemClient objektumot.
getProperties(ServiceGetPropertiesOptions)

Lekéri a tárfiók blobszolgáltatás-végpontjának tulajdonságait, beleértve a Storage Analytics és a CORS (forrásközi erőforrás-megosztás) szabályainak tulajdonságait.

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

CSAK TULAJDONOSI JOGKIVONAT-HITELESÍTÉS (TokenCredential) HASZNÁLATA ESETÉN ÉRHETŐ EL.

Lekéri a Data Lake szolgáltatás felhasználódelegálási kulcsát. Ez csak akkor érvényes művelet, ha tulajdonosi jogkivonat-hitelesítést használ.

Példa

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

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

Egy aszinkron iterátort ad vissza a megadott fiókban lévő összes fájlrendszer listázásához.

A .byPage() egy aszinkron iterátorral listázhatja a fájlrendszereket a lapokban.

Példa szintaxis használatával for await :

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

Példa a következő használatával 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();
}

Példa a következő használatával 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}`);
    }
  }
}

Példa jelölővel ellátott lapozásra:

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

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

Beállítja a tárfiók blobszolgáltatás-végpontjának tulajdonságait, beleértve a Storage Analytics tulajdonságait, a CORS-szabályokat (forrásközi erőforrás-megosztás) és a helyreállítható törlési beállításokat.

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

Korábban törölt fájlrendszer visszaállítása. Ez az API csak akkor működik, ha a tároló helyreállítható törlése engedélyezve van a tárfiókhoz.

Konstruktor adatai

DataLakeServiceClient(string, Pipeline)

Létrehoz egy DataLakeServiceClient-példányt az URL-címből és a folyamatból.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Paraméterek

url

string

Az Azure Storage data lake szolgáltatásra mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net". Sas hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

Hívja meg a newPipeline() parancsot egy alapértelmezett folyamat létrehozásához, vagy adjon meg egy testre szabott folyamatot.

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

Létrehoz egy DataLakeServiceClient-példányt az URL-címből.

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

Paraméterek

url

string

Az Azure Storage data lake szolgáltatásra mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net". Sas hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a csomag bármely hitelesítő adata a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

Választható. A HTTP-folyamat konfigurálásának beállításai.

Örökölt tulajdonság részletei

accountName 

accountName: string

Tulajdonság értéke

string

Örökölt forrás StorageClient.accountName

credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a csomag bármely hitelesítő adata a @azure/identity szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential felületet. Ha nincs megadva, az AnonymousCredential lesz használva.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Örökölt forrás StorageClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

Örökölt forrás StorageClient.url

Metódus adatai

fromConnectionString(string, StoragePipelineOptions)

Létrehoz egy DataLakeServiceClient-példányt a kapcsolati sztring.

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

Paraméterek

connectionString

string

Azure Storage-fiók fiók kapcsolati sztring vagy SAS-kapcsolati sztring. [ Megjegyzés – A fiók kapcsolati sztring csak NODE.JS futtatókörnyezetben használható. ] Fiók kapcsolati sztring példa –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.netSAS kapcsolati sztring példa –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

Választható. A HTTP-folyamat konfigurálásának beállításai.

Válaszok

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott DataLakeServiceClient esetén érhető el.

Létrehoz egy fiók közös hozzáférésű jogosultságkódját (SAS) URI-t a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

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

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

Paraméterek

expiresOn

Date

Választható. A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Alapértelmezés szerint egy órával később, ha nincs megadva.

permissions
AccountSASPermissions

Meghatározza az SAS-hez társítandó engedélyek listáját.

resourceTypes

string

Meghatározza a közös hozzáférésű jogosultságkódhoz társított erőforrástípusokat.

options
ServiceGenerateAccountSasUrlOptions

Választható paraméterek.

Válaszok

string

Egy fiók SAS URI-ja, amely az ügyfél által képviselt erőforrás URI-ját tartalmazza, majd a létrehozott SAS-jogkivonatot.

getFileSystemClient(string)

Létrehoz egy DataLakeFileSystemClient objektumot.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Paraméterek

fileSystemName

string

Fájlrendszer neve.

Válaszok

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Lekéri a tárfiók blobszolgáltatás-végpontjának tulajdonságait, beleértve a Storage Analytics és a CORS (forrásközi erőforrás-megosztás) szabályainak tulajdonságait.

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

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

Paraméterek

options
ServiceGetPropertiesOptions

A Szolgáltatás tulajdonságainak lekérése művelet beállításai.

Válaszok

Promise<DataLakeServiceGetPropertiesResponse>

A Szolgáltatás lekérése tulajdonságok művelet válaszadatai.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

CSAK TULAJDONOSI JOGKIVONAT-HITELESÍTÉS (TokenCredential) HASZNÁLATA ESETÉN ÉRHETŐ EL.

Lekéri a Data Lake szolgáltatás felhasználódelegálási kulcsát. Ez csak akkor érvényes művelet, ha tulajdonosi jogkivonat-hitelesítést használ.

Példa

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

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

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

Paraméterek

startsOn

Date

A felhasználói delegálási SAS kezdési időpontja. Az aktuális időponttól számított 7 napon belül kell lennie.

expiresOn

Date

A felhasználói delegálás SAS-jének befejezési ideje. Az aktuális időponttól számított 7 napon belül kell lennie.

options
ServiceGetUserDelegationKeyOptions

Válaszok

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Egy aszinkron iterátort ad vissza a megadott fiókban lévő összes fájlrendszer listázásához.

A .byPage() egy aszinkron iterátorral listázhatja a fájlrendszereket a lapokban.

Példa szintaxis használatával for await :

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

Példa a következő használatával 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();
}

Példa a következő használatával 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}`);
    }
  }
}

Példa jelölővel ellátott lapozásra:

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

Lásd: https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2

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

Paraméterek

options
ServiceListFileSystemsOptions

Válaszok

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Beállítja a tárfiók blobszolgáltatás-végpontjának tulajdonságait, beleértve a Storage Analytics tulajdonságait, a CORS-szabályokat (forrásközi erőforrás-megosztás) és a helyreállítható törlési beállításokat.

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

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

Paraméterek

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

A Szolgáltatáskészlet tulajdonságai művelet beállításai.

Válaszok

Promise<ServiceSetPropertiesResponse>

A Szolgáltatáskészlet tulajdonságai művelet válaszadatai.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Korábban törölt fájlrendszer visszaállítása. Ez az API csak akkor működik, ha a tároló helyreállítható törlése engedélyezve van a tárfiókhoz.

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

Paraméterek

deletedFileSystemName

string

A forrás fájlrendszer neve.

deleteFileSystemVersion

string

A fájlrendszer új neve.

options
ServiceUndeleteFileSystemOptions

A fájlrendszer-visszaállítási művelet konfigurálásának beállításai.

Válaszok

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