Aracılığıyla paylaş


DataLakeFileClient class

DataLakeFileClient, Azure Depolama dosyasının URL'sini temsil eder.

Extends

Oluşturucular

DataLakeFileClient(string, Pipeline)

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

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

URL'den ve kimlik bilgisinden DataLakeFileClient örneği oluşturur.

Özellikler

fileSystemName

Geçerli dosya sisteminin adı.

name

Geçerli yolun adı (dizin veya dosya).

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

append(RequestBodyType, number, number, FileAppendOptions)

Dosyaya eklenecek verileri karşıya yükler. Veriler yalnızca bir dosyaya eklenebilir. Bir dosyaya yanlışlıkla yüklenen verileri uygulamak için flush çağrısında bulunabilirsiniz.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

create(FileCreateOptions)

Bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

create(PathResourceType, PathCreateOptions)

Bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

createIfNotExists(FileCreateIfNotExistsOptions)

Henüz yoksa bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)

Henüz yoksa bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

flush(number, FileFlushOptions)

Daha önce eklenen verileri bir dosyaya boşaltır (yazar).

generateSasStringToSign(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

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

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

generateSasUrl(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

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

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, giriş kullanıcı temsilcisi anahtarı tarafından imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, giriş kullanıcı temsilcisi anahtarı tarafından imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

query(string, FileQueryOptions)

JSON veya CSV biçimli bir dosya için hızlı sorgu.

Örnek kullanım (Node.js):

import { DataLakeServiceClient } 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 fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
if (queryResponse.readableStreamBody) {
  const responseBuffer = await streamToBuffer(queryResponse.readableStreamBody);
  const downloaded = responseBuffer.toString();
  console.log(`Query file content: ${downloaded}`);
}

async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}
read(number, number, FileReadOptions)

Meta verileri ve özellikleri dahil olmak üzere hizmetten bir dosya indirir.

  • Node.js'de veriler okunabilir bir akışta döndürülebilirStreamBody içinde döndürülüyor
  • Tarayıcılarda veriler promise içeriğinde döndürülüyorAsBlob

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-blob

  • Örnek kullanım (Node.js):
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(),
);

const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
const downloadResponse = await fileClient.read();
if (downloadResponse.readableStreamBody) {
  const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
  console.log("Downloaded file content:", downloaded.toString());
}

// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Örnek kullanım (tarayıcı):

import { DataLakeServiceClient } 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 fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadResponse.contentAsBlob
const downloadResponse = await fileClient.read();
if (downloadResponse.contentAsBlob) {
  const blob = await downloadResponse.contentAsBlob;
  const downloaded = await blob.text();
  console.log(`Downloaded file content ${downloaded}`);
}
readToBuffer(Buffer, number, number, FileReadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Data Lake dosyasını bir arabelleğe paralel olarak okur. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de 0 geçirerek dosyanın tamamını okur.

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan büyük dosyalar için readToFilegöz önünde bulundurun.

readToBuffer(number, number, FileReadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR

Data Lake dosyasını bir arabelleğe paralel olarak okur. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de dosyanın tamamını okumak için 0 geçirin

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan büyük dosyalar için readToFilegöz önünde bulundurun.

readToFile(string, number, number, FileReadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Data Lake dosyasını yerel bir dosyaya indirir. Verilen dosya yolu zaten çıkarsa başarısız olur. Uzaklık ve sayı isteğe bağlıdır, dosyanın tamamını indirmek için sırasıyla 0 ve undefined değerini geçirir.

setExpiry(PathExpiryOptions, FileSetExpiryOptions)

Dosyaya bir süre sonu zamanı ayarlar; bu süre karşılandığında dosya silinir.

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView dosyasını bir Dosyaya yükler.

uploadFile(string, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Yerel bir dosyayı Data Lake dosyasına yükler.

uploadStream(Readable, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Node.js Okunabilir bir akışı Data Lake dosyasına yükler. Bu yöntem bir dosya oluşturmaya çalışır ve öbekleri öbek olarak karşıya yüklemeye başlar. Lütfen olası akış boyutunun FILE_MAX_SIZE_BYTES aşmadığından ve olası öbek sayısının BLOCK_BLOB_MAX_BLOCKS aşmadığından emin olun.

PERFORMANS GELIŞTIRME IPUÇLARı:

  • Giriş akışı highWaterMark, buffer.concat() işlemlerinden kaçınacak options.chunkSize parametresiyle aynı değeri ayarlamak daha iyidir.

Devralınan Yöntemler

delete(boolean, PathDeleteOptions)

Geçerli yolu (dizin veya dosya) silin.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

deleteIfExists(boolean, PathDeleteOptions)

Varsa geçerli yolu (dizin veya dosya) silin.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

exists(PathExistsOptions)

Bu istemci tarafından temsil edilen Data Lake dosyası varsa true döndürür; false olarak ayarlayın.

NOT: Mevcut bir dosya diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni dosyalar eklenebilir.

getAccessControl(PathGetAccessControlOptions)

Bir yol (dosya dizini) için erişim denetimi verilerini döndürür.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties

getDataLakeLeaseClient(string)

Yolda (dizin veya dosya) kiraları yöneten bir DataLakeLeaseClient alın.

getProperties(PathGetPropertiesOptions)

Yol (dizin veya dosya) için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür.

UYARI: Yanıtta döndürülen metadata nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak seçeneğini kullanarak yolları listeleyen dataLakeFileSystemClient yöntemleri tarafından döndürülen meta veri anahtarlarından farklıdır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

move(string, PathMoveOptions)

Dizini veya dosyayı aynı dosya sistemi içinde taşıyın.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

move(string, string, PathMoveOptions)

Dizini veya dosyayı başka bir dosya sistemine taşıyın.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Yol ve alt yollardaki Erişim Denetimini kaldırır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Bir yol (dosya dizini) için erişim denetimi verilerini ayarlayın.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Bir yolda ve alt yollarda Erişim Denetimi'ni ayarlar.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Yoldaki sistem özelliklerini (dizin veya dosya) ayarlar.

Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

setMetadata(Metadata, PathSetMetadataOptions)

Belirtilen yol (dosya dizini) için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar.

Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa, yol meta verileri kaldırılır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Bir yolda dosya izinlerini ayarlar.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

toDirectoryClient()

Geçerli yol bir dizinse geçerli DataLakePathClient'ı DataLakeDirectoryClient'a dönüştürün.

toFileClient()

Geçerli yol bir dosyaysa, geçerli DataLakePathClient'ı DataLakeFileClient'a dönüştürün.

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Bir yol ve alt yol üzerindeki Erişim Denetimi'ni değiştirir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

Oluşturucu Ayrıntıları

DataLakeFileClient(string, Pipeline)

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

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parametreler

url

string

"https://myaccount.dfs.core.windows.net/filesystem/file" gibi Azure Storage data lake dosyasını gösteren bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.dfs.core.windows.net/filesystem/directory/file?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.

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

URL'den ve kimlik bilgisinden DataLakeFileClient örneği oluşturur.

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

Parametreler

url

string

"https://myaccount.dfs.core.windows.net/filesystem/file" gibi Azure Storage data lake dosyasını gösteren bir İstemci dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.dfs.core.windows.net/filesystem/directory/file?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

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

Özellik Ayrıntıları

fileSystemName

Geçerli dosya sisteminin adı.

string fileSystemName

Özellik Değeri

string

name

Geçerli yolun adı (dizin veya dosya).

string name

Özellik Değeri

string

Devralınan Özellik Detayları

accountName

accountName: string

Özellik Değeri

string

Devralındığı yer:DataLakePathClient.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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Özellik Değeri

Devralındığı yer:DataLakePathClient.credential

url

Kodlanmış URL dizesi değeri.

url: string

Özellik Değeri

string

Devralındığı yer:DataLakePathClient.url

Yöntem Ayrıntıları

append(RequestBodyType, number, number, FileAppendOptions)

Dosyaya eklenecek verileri karşıya yükler. Veriler yalnızca bir dosyaya eklenebilir. Bir dosyaya yanlışlıkla yüklenen verileri uygulamak için flush çağrısında bulunabilirsiniz.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>

Parametreler

body
HttpRequestBody

Karşıya yüklenecek içerik.

offset

number

Bayt cinsinden uzaklığı ekler.

length

number

Bayt cinsinden eklenecek içeriğin uzunluğu.

options
FileAppendOptions

Optional. Veri eklerken seçenekler.

Döndürülenler

create(FileCreateOptions)

Bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: FileCreateOptions): Promise<FileCreateResponse>

Parametreler

options
FileCreateOptions

Optional. Dosya oluştururken seçenekler.

Döndürülenler

create(PathResourceType, PathCreateOptions)

Bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>

Parametreler

resourceType
PathResourceTypeModel

Kaynak türü, DataLakeFileClient için "file" olmalıdır.

options
PathCreateOptions

Optional. Dosya oluştururken seçenekler.

Döndürülenler

createIfNotExists(FileCreateIfNotExistsOptions)

Henüz yoksa bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>

Parametreler

options
FileCreateIfNotExistsOptions

Optional. Dosya oluştururken seçenekler.

Döndürülenler

createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)

Henüz yoksa bir dosya oluşturun.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Parametreler

resourceType
PathResourceTypeModel

Kaynak türü, DataLakeFileClient için "file" olmalıdır.

Döndürülenler

flush(number, FileFlushOptions)

Daha önce eklenen verileri bir dosyaya boşaltır (yazar).

function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>

Parametreler

position

number

Boşaltacak dosya konumu. Bu parametre, çağıranın verileri paralel olarak karşıya yüklemesine ve dosyaya eklenme sırasını denetlemesine olanak tanır. Dosyaya eklenecek verileri karşıya yüklerken ve daha önce karşıya yüklenen veriler dosyaya boşaltılırken gereklidir. Değer, verilerin eklendiği konum olmalıdır. Karşıya yüklenen veriler hemen temizlenmez veya dosyaya yazılmaz. Boşaltmak için, önceden karşıya yüklenen verilerin bitişik olması, position parametresinin belirtilmesi ve tüm veriler yazıldıktan sonra dosyanın uzunluğuna eşit olması ve istekle birlikte bir istek varlığı gövdesi olmaması gerekir.

options
FileFlushOptions

Optional. Verileri temizlerken seçenekler.

Döndürülenler

generateSasStringToSign(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

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

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametreler

options
FileGenerateSasUrlOptions

İ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 SAS URI'sini.

generateSasUrl(FileGenerateSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle inşa edilen istemciler için kullanılabilir.

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

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>

Parametreler

options
FileGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

Promise<string>

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

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, giriş kullanıcı temsilcisi anahtarı tarafından imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options
FileGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() dönüş değeri

Döndürülenler

string

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

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, giriş kullanıcı temsilcisi anahtarı tarafından imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametreler

options
FileGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() dönüş değeri

Döndürülenler

Promise<string>

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

query(string, FileQueryOptions)

JSON veya CSV biçimli bir dosya için hızlı sorgu.

Örnek kullanım (Node.js):

import { DataLakeServiceClient } 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 fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
if (queryResponse.readableStreamBody) {
  const responseBuffer = await streamToBuffer(queryResponse.readableStreamBody);
  const downloaded = responseBuffer.toString();
  console.log(`Query file content: ${downloaded}`);
}

async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}
function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>

Parametreler

query

string

Döndürülenler

Promise<FileReadResponse>

read(number, number, FileReadOptions)

Meta verileri ve özellikleri dahil olmak üzere hizmetten bir dosya indirir.

  • Node.js'de veriler okunabilir bir akışta döndürülebilirStreamBody içinde döndürülüyor
  • Tarayıcılarda veriler promise içeriğinde döndürülüyorAsBlob

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-blob

  • Örnek kullanım (Node.js):
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(),
);

const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
const downloadResponse = await fileClient.read();
if (downloadResponse.readableStreamBody) {
  const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
  console.log("Downloaded file content:", downloaded.toString());
}

// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Örnek kullanım (tarayıcı):

import { DataLakeServiceClient } 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 fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadResponse.contentAsBlob
const downloadResponse = await fileClient.read();
if (downloadResponse.contentAsBlob) {
  const blob = await downloadResponse.contentAsBlob;
  const downloaded = await blob.text();
  console.log(`Downloaded file content ${downloaded}`);
}
function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

Parametreler

offset

number

Optional. Dosyayı okumak için uzaklık, varsayılan değer 0'dır.

count

number

Optional. Kaç bayt okunacaksa, varsayılan değer uzaklığından sonuna kadar okur.

options
FileReadOptions

Optional. Dosyayı okurken seçenekler.

Döndürülenler

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Data Lake dosyasını bir arabelleğe paralel olarak okur. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de 0 geçirerek dosyanın tamamını okur.

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan büyük dosyalar için readToFilegöz önünde bulundurun.

function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

Parametreler

buffer

Buffer

Arabellek doldurulacak, uzunluğu sayıdan büyük olmalıdır

offset

number

Data Lake dosyasının okunacak konumundan

count

number

Okunacak veri miktarı. Undefined geçirirken sonuna kadar okur

Döndürülenler

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR

Data Lake dosyasını bir arabelleğe paralel olarak okur. Uzaklık ve sayı isteğe bağlıdır, her ikisi için de dosyanın tamamını okumak için 0 geçirin

Uyarı: Arabellekler, Node.js/V8 sınırlamaları nedeniyle 32 bit sistemlerde yaklaşık bir gigabayt veya 64 bit sistemlerde yaklaşık iki gigabayt kadar dosyaları destekleyebilir. Bu boyuttan büyük dosyalar için readToFilegöz önünde bulundurun.

function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

Parametreler

offset

number

Data Lake dosyasının okunacak konumundan (bayt cinsinden)

count

number

Okunacak veri miktarı (bayt cinsinden). Undefined geçirirken sonuna kadar okur

Döndürülenler

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Data Lake dosyasını yerel bir dosyaya indirir. Verilen dosya yolu zaten çıkarsa başarısız olur. Uzaklık ve sayı isteğe bağlıdır, dosyanın tamamını indirmek için sırasıyla 0 ve undefined değerini geçirir.

function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

Parametreler

filePath

string

offset

number

Dosyanın indirilmesi gereken konumdan.

count

number

ne kadar veri indirileceği. Undefined'i geçirirken sonuna kadar indirilir.

options
FileReadOptions

Data Lake dosyasını okuma seçenekleri.

Döndürülenler

Promise<FileReadResponse>

Dosya okuma işlemi için yanıt verileri, ancak içeriği zaten okundu ve belirtilen yolda yerel bir dosyaya yazıldığından readableStreamBody tanımsız olarak ayarlandı.

setExpiry(PathExpiryOptions, FileSetExpiryOptions)

Dosyaya bir süre sonu zamanı ayarlar; bu süre karşılandığında dosya silinir.

function setExpiry(mode: PathExpiryOptions, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>

Parametreler

Döndürülenler

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView dosyasını bir Dosyaya yükler.

function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

Parametreler

data

Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer veya ArrayBufferView

Döndürülenler

uploadFile(string, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Yerel bir dosyayı Data Lake dosyasına yükler.

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

Parametreler

filePath

string

Yerel dosyanın tam yolu

Döndürülenler

uploadStream(Readable, FileParallelUploadOptions)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Node.js Okunabilir bir akışı Data Lake dosyasına yükler. Bu yöntem bir dosya oluşturmaya çalışır ve öbekleri öbek olarak karşıya yüklemeye başlar. Lütfen olası akış boyutunun FILE_MAX_SIZE_BYTES aşmadığından ve olası öbek sayısının BLOCK_BLOB_MAX_BLOCKS aşmadığından emin olun.

PERFORMANS GELIŞTIRME IPUÇLARı:

  • Giriş akışı highWaterMark, buffer.concat() işlemlerinden kaçınacak options.chunkSize parametresiyle aynı değeri ayarlamak daha iyidir.
function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

Parametreler

stream

Readable

Okunabilir akışı Node.js.

Döndürülenler

Devralınan Yöntemin Ayrıntıları

delete(boolean, PathDeleteOptions)

Geçerli yolu (dizin veya dosya) silin.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Parametreler

recursive

boolean

Gerekli ve yalnızca kaynak bir dizin olduğunda geçerlidir. "True" ise, dizinin altındaki tüm yollar silinir.

options
PathDeleteOptions

Optional. Yolu silerken seçenekler.

Döndürülenler

Devralındığı yer:DataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

Varsa geçerli yolu (dizin veya dosya) silin.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Parametreler

recursive

boolean

Gerekli ve yalnızca kaynak bir dizin olduğunda geçerlidir. "True" ise, dizinin altındaki tüm yollar silinir.

Döndürülenler

Devralındığı yer:DataLakePathClient.deleteIfExists

exists(PathExistsOptions)

Bu istemci tarafından temsil edilen Data Lake dosyası varsa true döndürür; false olarak ayarlayın.

NOT: Mevcut bir dosya diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni dosyalar eklenebilir.

function exists(options?: PathExistsOptions): Promise<boolean>

Parametreler

options
PathExistsOptions

seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

Devralındığı yer:DataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

Bir yol (dosya dizini) için erişim denetimi verilerini döndürür.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Parametreler

options
PathGetAccessControlOptions

Optional. Dosya erişim denetimi alma seçenekleri.

Döndürülenler

Devralındığı yer:DataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

Yolda (dizin veya dosya) kiraları yöneten bir DataLakeLeaseClient alın.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametreler

proposeLeaseId

string

Optional. İlk önerilen kira kimliği.

Döndürülenler

Devralındığı yer:DataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Yol (dizin veya dosya) için tüm kullanıcı tanımlı meta verileri, standart HTTP özelliklerini ve sistem özelliklerini döndürür.

UYARI: Yanıtta döndürülen metadata nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak seçeneğini kullanarak yolları listeleyen dataLakeFileSystemClient yöntemleri tarafından döndürülen meta veri anahtarlarından farklıdır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Parametreler

options
PathGetPropertiesOptions

Optional. Yol özelliklerini alma seçenekleri.

Döndürülenler

Devralındığı yer:DataLakePathClient.getProperties

move(string, PathMoveOptions)

Dizini veya dosyayı aynı dosya sistemi içinde taşıyın.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parametreler

destinationPath

string

"dizin" veya "dizin/dosya" dosya yolu gibi hedef dizin yolu. destinationPath'in kimliği SAS ile doğrulanmışsa, SAS'yi "dizin/dosya?sasToken" gibi hedef yola ekleyin.

options
PathMoveOptions

Optional. Dizin veya dosya taşırken seçenekler.

Döndürülenler

Promise<PathMoveResponse>

Devralındığı yer:DataLakePathClient.move

move(string, string, PathMoveOptions)

Dizini veya dosyayı başka bir dosya sistemine taşıyın.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parametreler

destinationFileSystem

string

"dosya sistemi" gibi hedef dosya sistemi.

destinationPath

string

"dizin" veya dosya yolu "dizin/dosya" gibi hedef dizin yolu DestinationPath'in kimliği SAS ile doğrulanmışsa, SAS'yi "dizin/dosya?sasToken" gibi hedef yola ekleyin.

options
PathMoveOptions

Optional. Dizin veya dosya taşırken seçenekler.

Döndürülenler

Promise<PathMoveResponse>

Devralındığı yer:DataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Yol ve alt yollardaki Erişim Denetimini kaldırır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parametreler

acl

RemovePathAccessControlItem[]

Dosya veya dizin için POSIX erişim denetimi listesi.

options
PathChangeAccessControlRecursiveOptions

Optional. Options

Döndürülenler

Devralındığı yer:DataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Bir yol (dosya dizini) için erişim denetimi verilerini ayarlayın.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Parametreler

acl

PathAccessControlItem[]

Dosya veya dizin için POSIX erişim denetimi listesi.

options
PathSetAccessControlOptions

Optional. Yol erişim denetimini ayarlarken seçenekler.

Döndürülenler

Devralındığı yer:DataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Bir yolda ve alt yollarda Erişim Denetimi'ni ayarlar.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parametreler

acl

PathAccessControlItem[]

Dosya veya dizin için POSIX erişim denetimi listesi.

options
PathChangeAccessControlRecursiveOptions

Optional. Options

Döndürülenler

Devralındığı yer:DataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Yoldaki sistem özelliklerini (dizin veya dosya) ayarlar.

Belirtilen blob HTTP üst bilgileri için değer sağlanmazsa veya değer sağlanmazsa, değeri olmayan bu blob HTTP üst bilgileri temizlenir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Parametreler

httpHeaders
PathHttpHeaders

Döndürülenler

Devralındığı yer:DataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

Belirtilen yol (dosya dizini) için kullanıcı tanımlı meta verileri bir veya daha fazla ad-değer çifti olarak ayarlar.

Seçenek sağlanmadıysa veya parametrede tanımlı meta veri yoksa, yol meta verileri kaldırılır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Parametreler

metadata
Metadata

Optional. Var olan meta verileri bu değerle değiştirin. Değer sağlanmazsa, mevcut meta veriler kaldırılır.

options
PathSetMetadataOptions

Optional. Yol meta verilerini ayarlarken seçenekler.

Döndürülenler

Devralındığı yer:DataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Bir yolda dosya izinlerini ayarlar.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Parametreler

permissions
PathPermissions

Dosya sahibi, dosya sahibi grubu ve diğerleri için POSIX erişim izinleri.

options
PathSetPermissionsOptions

Optional. Yol izinlerini ayarlarken seçenekler.

Döndürülenler

Devralındığı yer:DataLakePathClient.setPermissions

toDirectoryClient()

Geçerli yol bir dizinse geçerli DataLakePathClient'ı DataLakeDirectoryClient'a dönüştürün.

function toDirectoryClient(): DataLakeDirectoryClient

Döndürülenler

Devralındığı yer:DataLakePathClient.toDirectoryClient

toFileClient()

Geçerli yol bir dosyaysa, geçerli DataLakePathClient'ı DataLakeFileClient'a dönüştürün.

function toFileClient(): DataLakeFileClient

Döndürülenler

Devralındığı yer:DataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Bir yol ve alt yol üzerindeki Erişim Denetimi'ni değiştirir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parametreler

acl

PathAccessControlItem[]

Dosya veya dizin için POSIX erişim denetimi listesi.

options
PathChangeAccessControlRecursiveOptions

Optional. Options

Döndürülenler

Devralındığı yer:DataLakePathClient.updateAccessControlRecursive