Aracılığıyla paylaş

DataLakeServiceClient class

  • Başvuru
Paket:
@azure/storage-file-datalake

DataLakeServiceClient, Azure Data Lake hizmet kaynaklarını ve dosya sistemlerini işlemenize olanak tanır. Depolama hesabı, Data Lake hizmeti için en üst düzey ad alanını sağlar.

Extends

StorageClient

Oluşturucular

DataLakeServiceClient(string, Pipeline)

URL ve işlem hattından DataLakeServiceClient örneği oluşturur.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

URL'den DataLakeServiceClient örneği oluşturur.

Devralınan Özellikler

accountName
credential

AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
url

Kodlanmış URL dizesi değeri.

Yöntemler

fromConnectionString(string, StoragePipelineOptions)

Bağlantı dizesinden DataLakeServiceClient örneği oluşturur.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen DataLakeServiceClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen DataLakeServiceClient için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) için imzalayacak dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

DataLakeFileSystemClient nesnesi oluşturur.
getProperties(ServiceGetPropertiesOptions)

Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının Blob hizmet uç noktasının özelliklerini alır.

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

YALNıZCA TAŞıYıCı BELIRTEÇ KIMLIK DOĞRULAMASı (TokenCredential) KULLANıLıRKEN KULLANıLABILIR.

Data Lake hizmeti için bir kullanıcı temsilcisi anahtarı alır. Bu yalnızca taşıyıcı belirteç kimlik doğrulaması kullanılırken geçerli bir işlemdir.

Örnek

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

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

Belirtilen hesap altındaki tüm dosya sistemlerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage(), dosya sistemlerini sayfalarda listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

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

iter.next()kullanan örnek:

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

byPage()kullanan örnek:

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

İşaretçi ile disk belleği kullanma örneği:

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

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

Depolama Analizi, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları gibi depolama hesabının Blob hizmet uç noktasının özelliklerini ayarlar.

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

Daha önce silinmiş bir Dosya Sistemini geri yükleyin. Bu API yalnızca depolama hesabı için Kapsayıcı Geçici Silme etkinleştirildiğinde çalışır.

Oluşturucu Ayrıntıları

DataLakeServiceClient(string, Pipeline)

URL ve işlem hattından DataLakeServiceClient örneği oluşturur.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parametreler

url

string

"https://myaccount.dfs.core.windows.net" gibi Azure Depolama data lake hizmetini işaret eden bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.dfs.core.windows.net?sasString" gibi bir SAS ekleyebilirsiniz.

pipeline
Pipeline

Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() çağrısında bulunabilirsiniz.

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

URL'den DataLakeServiceClient örneği oluşturur.

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

Parametreler

url

string

"https://myaccount.dfs.core.windows.net" gibi Azure Depolama data lake hizmetini işaret eden bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.dfs.core.windows.net?sasString" gibi bir SAS ekleyebilirsiniz.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.

options
StoragePipelineOptions

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

Devralınan Özellik Detayları

accountName 

accountName: string

Özellik Değeri

string

StorageClient.accountName'den Devralınan

credential

AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

StorageClient.credential'dan Devralınmış

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralınan

Yöntem Ayrıntıları

fromConnectionString(string, StoragePipelineOptions)

Bağlantı dizesinden DataLakeServiceClient örneği oluşturur.

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

Parametreler

connectionString

string

Bir Azure depolama hesabının hesap bağlantı dizesi veya SAS bağlantı dizesi. [ Not - Hesap bağlantı dizesi yalnızca NODE.JS çalışma zamanında kullanılabilir. ] Hesap bağlantı dizesi örneği - SAS bağlantı dizesi örneği DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - 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

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

Döndürülenler

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen DataLakeServiceClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

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

Parametreler

expiresOn

Date

Opsiyonel. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Belirtilmezse varsayılan olarak bir saat sonraya ayarlanmıştır.

permissions
AccountSASPermissions

SAS ile ilişkilendirilecek izinlerin listesini belirtir.

resourceTypes

string

Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.

options
ServiceGenerateAccountSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren bir hesap SAS URI'si.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen DataLakeServiceClient için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) için imzalayacak dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

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

Parametreler

expiresOn

Date

Opsiyonel. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Belirtilmezse varsayılan olarak bir saat sonraya ayarlanmıştır.

permissions
AccountSASPermissions

SAS ile ilişkilendirilecek izinlerin listesini belirtir.

resourceTypes

string

Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.

options
ServiceGenerateAccountSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren bir hesap SAS URI'si.

getFileSystemClient(string)

DataLakeFileSystemClient nesnesi oluşturur.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parametreler

fileSystemName

string

Dosya sistemi adı.

Döndürülenler

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının Blob hizmet uç noktasının özelliklerini alır.

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

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

Parametreler

options
ServiceGetPropertiesOptions

Hizmet Alma Özellikleri işleminin seçenekleri.

Döndürülenler

Promise<DataLakeServiceGetPropertiesResponse>

Hizmet Alma Özellikleri işlemi için yanıt verileri.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

YALNıZCA TAŞıYıCı BELIRTEÇ KIMLIK DOĞRULAMASı (TokenCredential) KULLANıLıRKEN KULLANıLABILIR.

Data Lake hizmeti için bir kullanıcı temsilcisi anahtarı alır. Bu yalnızca taşıyıcı belirteç kimlik doğrulaması kullanılırken geçerli bir işlemdir.

Örnek

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

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

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

Parametreler

startsOn

Date

Kullanıcı temsilcisi SAS'sinin başlangıç saati. Geçerli saatten sonra 7 gün içinde olmalıdır.

expiresOn

Date

Kullanıcı temsilcisi SAS'sinin bitiş saati. Geçerli saatten sonra 7 gün içinde olmalıdır.

options
ServiceGetUserDelegationKeyOptions

Döndürülenler

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Belirtilen hesap altındaki tüm dosya sistemlerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage(), dosya sistemlerini sayfalarda listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

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

iter.next()kullanan örnek:

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

byPage()kullanan örnek:

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

İşaretçi ile disk belleği kullanma örneği:

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

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

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

Parametreler

options
ServiceListFileSystemsOptions

Döndürülenler

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Depolama Analizi, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları gibi depolama hesabının Blob hizmet uç noktasının özelliklerini ayarlar.

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

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

Parametreler

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Hizmet Kümesi Özellikleri işleminin seçenekleri.

Döndürülenler

Promise<ServiceSetPropertiesResponse>

Hizmet Kümesi Özellikleri işlemi için yanıt verileri.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Daha önce silinmiş bir Dosya Sistemini geri yükleyin. Bu API yalnızca depolama hesabı için Kapsayıcı Geçici Silme etkinleştirildiğinde çalışır.

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

Parametreler

deletedFileSystemName

string

Kaynak Dosya Sisteminin adı.

deleteFileSystemVersion

string

Dosya Sisteminin yeni adı.

options
ServiceUndeleteFileSystemOptions

Dosya Sistemi Geri Yükleme işlemini yapılandırma seçenekleri.

Döndürülenler

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