DataLakeServiceClient class
DataLakeServiceClient umožňuje manipulovat s prostředky a systémy souborů služby Azure Data Lake. Účet úložiště poskytuje obor názvů nejvyšší úrovně pro službu Data Lake.
- Extends
-
StorageClient
Konstruktory
Data |
Vytvoří instanci DataLakeServiceClient z adresy URL a kanálu. |
Data |
Vytvoří instanci DataLakeServiceClient z adresy URL. |
Zděděné vlastnosti
account |
|
credential | Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z |
url | Zakódovaná hodnota řetězce adresy URL. |
Metody
from |
Vytvoří instanci DataLakeServiceClient z připojovacího řetězce. |
generate |
K dispozici pouze pro DataLakeServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas. |
get |
Vytvoří Objekt DataLakeFileSystemClient . |
get |
Získá vlastnosti koncového bodu služby Blob service účtu úložiště, včetně vlastností pro pravidla Analýza úložiště a CORS (Sdílení prostředků mezi zdroji). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties. |
get |
K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝ TOKEN (TokenCredential). Načte klíč delegování uživatele pro službu Data Lake. Jedná se pouze o platnou operaci při použití ověřování nosný token. Příklad
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key. |
list |
Vrátí asynchronní iterátor pro výpis všech systémů souborů pod zadaným účtem. .byPage() vrátí asynchronní iterátor pro výpis systémů souborů na stránkách. Příklad s využitím
Příklad použití
Příklad použití
Příklad použití stránkování se značkou:
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2. |
set |
Nastaví vlastnosti pro koncový bod služby Blob Service účtu úložiště, včetně vlastností pro Analýza úložiště, pravidel CORS (Sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties. |
undelete |
Obnovte dříve odstraněný systém souborů. Toto rozhraní API je funkční jenom v případě, že je pro účet úložiště povolené obnovitelné odstranění kontejneru. |
Podrobnosti konstruktoru
DataLakeServiceClient(string, Pipeline)
Vytvoří instanci DataLakeServiceClient z adresy URL a kanálu.
new DataLakeServiceClient(url: string, pipeline: Pipeline)
Parametry
- url
-
string
Řetězec klienta odkazující na službu Azure Storage Data Lake, například "https://myaccount.dfs.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net?sasString".
- pipeline
- Pipeline
Voláním příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Vytvoří instanci DataLakeServiceClient z adresy URL.
new DataLakeServiceClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametry
- url
-
string
Řetězec klienta odkazující na službu Azure Storage Data Lake, například "https://myaccount.dfs.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity
balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.
- options
- StoragePipelineOptions
Nepovinný parametr. Možnosti konfigurace kanálu HTTP
Podrobnosti zděděných vlastností
accountName
accountName: string
Hodnota vlastnosti
string
Zděděno z StorageClient.accountName
credential
Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity
balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Hodnota vlastnosti
Zděděno z StorageClient.credential
url
Zakódovaná hodnota řetězce adresy URL.
url: string
Hodnota vlastnosti
string
Zděděno z StorageClient.url
Podrobnosti metody
fromConnectionString(string, StoragePipelineOptions)
Vytvoří instanci DataLakeServiceClient z připojovacího řetězce.
static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient
Parametry
- connectionString
-
string
Připojovací řetězec účtu nebo připojovací řetězec SAS účtu úložiště Azure.
[ Poznámka – Připojovací řetězec účtu se dá použít jenom v modulu runtime NODE.JS. ] Příklad připojovacího řetězce účtu –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Příklad připojovacího řetězce 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
Nepovinný parametr. Možnosti konfigurace kanálu HTTP
Návraty
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)
K dispozici pouze pro DataLakeServiceClient vytvořený pomocí přihlašovacích údajů sdíleného klíče.
Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) účtu na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas.
function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string
Parametry
- expiresOn
-
Date
Nepovinný parametr. Čas, kdy se sdílený přístupový podpis stane neplatným. Výchozí hodnota je o hodinu později, pokud není zadáno.
- permissions
- AccountSASPermissions
Určuje seznam oprávnění, která se mají přidružit k SAS.
- resourceTypes
-
string
Určuje typy prostředků přidružené ke sdílenému přístupovém podpisu.
Volitelné parametry.
Návraty
string
Identifikátor URI SAS účtu, který se skládá z identifikátoru URI prostředku reprezentovaného tímto klientem, následovaného vygenerovaným tokenem SAS.
getFileSystemClient(string)
Vytvoří Objekt DataLakeFileSystemClient .
function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient
Parametry
- fileSystemName
-
string
Název systému souborů.
Návraty
getProperties(ServiceGetPropertiesOptions)
Získá vlastnosti koncového bodu služby Blob service účtu úložiště, včetně vlastností pro pravidla Analýza úložiště a CORS (Sdílení prostředků mezi zdroji).
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties.
function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>
Parametry
- options
- ServiceGetPropertiesOptions
Možnosti operace Získání vlastností služby
Návraty
Promise<DataLakeServiceGetPropertiesResponse>
Data odpovědi pro operaci Service Get Properties
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)
K DISPOZICI POUZE PŘI POUŽITÍ OVĚŘOVÁNÍ NOSNÝ TOKEN (TokenCredential).
Načte klíč delegování uživatele pro službu Data Lake. Jedná se pouze o platnou operaci při použití ověřování nosný token.
Příklad
// 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();
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key.
function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>
Parametry
- startsOn
-
Date
Počáteční čas SAS delegování uživatele. Musí být do 7 dnů od aktuálního času.
- expiresOn
-
Date
Koncový čas SAS delegování uživatele. Musí být do 7 dnů od aktuálního času.
Návraty
Promise<ServiceGetUserDelegationKeyResponse>
listFileSystems(ServiceListFileSystemsOptions)
Vrátí asynchronní iterátor pro výpis všech systémů souborů pod zadaným účtem.
.byPage() vrátí asynchronní iterátor pro výpis systémů souborů na stránkách.
Příklad s využitím for await
syntaxe:
let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}
Příklad použití 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říklad použití 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říklad použití stránkování se značkou:
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}`);
}
}
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2.
function listFileSystems(options?: ServiceListFileSystemsOptions): PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>
Parametry
- options
- ServiceListFileSystemsOptions
Návraty
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)
Nastaví vlastnosti pro koncový bod služby Blob Service účtu úložiště, včetně vlastností pro Analýza úložiště, pravidel CORS (Sdílení prostředků mezi zdroji) a nastavení obnovitelného odstranění.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties.
function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>
Parametry
- properties
- DataLakeServiceProperties
- options
- ServiceSetPropertiesOptions
Možnosti operace Vlastnosti sady služeb.
Návraty
Promise<ServiceSetPropertiesResponse>
Data odpovědi pro operaci Vlastnosti sady služeb.
undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)
Obnovte dříve odstraněný systém souborů. Toto rozhraní API je funkční jenom v případě, že je pro účet úložiště povolené obnovitelné odstranění kontejneru.
function undeleteFileSystem(deletedFileSystemName: string, deleteFileSystemVersion: string, options?: ServiceUndeleteFileSystemOptions): Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>
Parametry
- deletedFileSystemName
-
string
Název zdrojového systému souborů.
- deleteFileSystemVersion
-
string
Nový název systému souborů.
- options
- ServiceUndeleteFileSystemOptions
Možnosti konfigurace operace obnovení systému souborů
Návraty
Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>