Bagikan melalui

@azure/storage-file-datalake package

Kelas

AccountSASPermissions

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Ini adalah kelas pembantu untuk membuat string yang mewakili izin yang diberikan oleh AccountSAS. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan izin untuk operasi tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan ditetapkan sebagai bidang izin pada objek AccountSASSignatureValues. Dimungkinkan untuk membangun string izin tanpa kelas ini, tetapi urutan izin khusus dan kelas ini menjamin kebenaran.
AccountSASResourceTypes

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Ini adalah kelas pembantu untuk membuat string yang mewakili sumber daya yang dapat diakses oleh AccountSAS. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan akses ke jenis sumber daya tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan ditetapkan sebagai bidang sumber daya pada objek AccountSASSignatureValues. Dimungkinkan untuk membangun string sumber daya tanpa kelas ini, tetapi urutan sumber daya khusus dan kelas ini menjamin kebenaran.
AccountSASServices

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Ini adalah kelas pembantu untuk membuat string yang mewakili layanan yang dapat diakses oleh AccountSAS. Mengatur nilai ke true berarti bahwa SETIAP SAS yang menggunakan izin ini akan memberikan akses ke layanan tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan ditetapkan sebagai bidang layanan pada objek AccountSASSignatureValues. Dimungkinkan untuk membangun string layanan tanpa kelas ini, tetapi urutan layanan khusus dan kelas ini menjamin kebenaran.
AnonymousCredential

AnonymousCredential menyediakan anggota credentialPolicyCreator yang digunakan untuk membuat objek AnonymousCredentialPolicy. AnonymousCredentialPolicy digunakan dengan permintaan HTTP (S) yang membaca sumber daya publik atau untuk digunakan dengan Tanda Tangan Akses Bersama (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy digunakan dengan permintaan HTTP (S) yang membaca sumber daya publik atau untuk digunakan dengan Tanda Tangan Akses Bersama (SAS).
BaseRequestPolicy

Kelas dasar dari mana semua kebijakan permintaan berasal.
Credential

Info masuk adalah kelas abstrak untuk penandatanganan permintaan HTTP Azure Storage. Kelas ini akan menghosting pabrik credentialPolicyCreator yang menghasilkan CredentialPolicy.
CredentialPolicy

Kebijakan kredensial yang digunakan untuk menandatangani permintaan HTTP sebelum mengirim. Ini adalah kelas abstrak.
DataLakeAclChangeFailedError

Kesalahan muncul ketika operasi terganggu dan dapat dilanjutkan nanti.
DataLakeDirectoryClient

DataLakeDirectoryClient mewakili URL ke direktori Azure Storage.
DataLakeFileClient

DataLakeFileClient mewakili URL ke file Azure Storage.
DataLakeFileSystemClient

DataLakeFileSystemClient mewakili URL ke sistem file Azure Storage yang memungkinkan Anda memanipulasi direktori dan filenya.
DataLakeLeaseClient
DataLakePathClient

DataLakePathClient mewakili URL ke jalur Azure Storage (direktori atau file).
DataLakeSASPermissions

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Ini adalah kelas pembantu untuk membuat string yang mewakili izin yang diberikan oleh ServiceSAS. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan izin untuk operasi tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan diatur sebagai bidang izin pada objek DataLakeSASSSignatureValues. Dimungkinkan untuk membangun string izin tanpa kelas ini, tetapi urutan izin khusus dan kelas ini menjamin kebenaran.
DataLakeServiceClient

DataLakeServiceClient memungkinkan Anda memanipulasi sumber daya dan sistem file layanan Azure Data Lake. Akun penyimpanan menyediakan namespace layanan tingkat atas untuk layanan Data Lake.
DirectorySASPermissions

Ini adalah kelas pembantu untuk membuat string yang mewakili izin yang diberikan oleh ServiceSAS ke direktori. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan izin untuk operasi tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan diatur sebagai bidang izin pada objek DataLakeSASSSignatureValues. Dimungkinkan untuk membangun string izin tanpa kelas ini, tetapi urutan izin khusus dan kelas ini menjamin kebenaran.
FileSystemSASPermissions

Ini adalah kelas pembantu untuk membuat string yang mewakili izin yang diberikan oleh ServiceSAS ke kontainer. Mengatur nilai ke true berarti bahwa setiap SAS yang menggunakan izin ini akan memberikan izin untuk operasi tersebut. Setelah semua nilai diatur, ini harus diserialisasikan dengan toString dan diatur sebagai bidang izin pada objek DataLakeSASSSignatureValues. Dimungkinkan untuk membangun string izin tanpa kelas ini, tetapi urutan izin khusus dan kelas ini menjamin kebenaran.
Pipeline

Kelas Alur yang berisi kebijakan permintaan HTTP. Anda dapat membuat Alur default dengan memanggil newPipeline. Atau Anda dapat membuat Alur dengan kebijakan Anda sendiri oleh konstruktor Alur.

Lihat newPipeline dan kebijakan yang disediakan sebelum menerapkan Alur yang disesuaikan.
SASQueryParameters

Mewakili komponen yang membentuk parameter kueri Azure Storage SAS. Jenis ini tidak dibangun langsung oleh pengguna; ini hanya dihasilkan oleh jenis AccountSASSignatureValues dan <xref:BlobSASSignatureValues>. Setelah dibuat, itu dapat dikodekan ke dalam toString() dan ditambahkan ke URL secara langsung (meskipun hati-hati harus diambil di sini jika ada parameter kueri yang ada, yang mungkin memengaruhi cara yang sesuai untuk menambahkan parameter kueri ini).

CATATAN: Instans kelas ini tidak dapat diubah.
StorageBrowserPolicy

StorageBrowserPolicy akan menangani perbedaan antara Node.js dan runtime browser, termasuk:

  1. Browser menyimpan permintaan GET/HEAD dengan menambahkan header kondisional seperti 'IF_MODIFIED_SINCE'. StorageBrowserPolicy adalah kebijakan yang digunakan untuk menambahkan kueri tanda waktu ke URL permintaan GET/HEAD sehingga menghindari cache browser.

  2. Hapus header cookie untuk keamanan

  3. Menghapus header panjang konten untuk menghindari peringatan browser
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory adalah kelas pabrik yang membantu menghasilkan objek StorageBrowserPolicy.
StorageRetryPolicy

Coba lagi kebijakan dengan coba lagi eksponensial dan coba lagi linier yang diterapkan.
StorageRetryPolicyFactory

StorageRetryPolicyFactory adalah kelas pabrik yang membantu menghasilkan storageRetryPolicy objek.
StorageSharedKeyCredential

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

StorageSharedKeyCredential untuk otorisasi kunci akun layanan Azure Storage.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy adalah kebijakan yang digunakan untuk menandatangani permintaan HTTP dengan kunci bersama.

Antarmuka

AccessControlChangeCounters

AccessControlChangeCounters berisi jumlah operasi yang mengubah Daftar Kontrol Akses secara rekursif.
AccessControlChangeError

Mewakili entri yang gagal memperbarui Daftar Kontrol Akses selama setAccessControlRecursive, updateAccessControlRecursive dan removeAccessControlRecursive.
AccessControlChanges

AccessControlChanges berisi jumlah batch dan kumulatif operasi yang mengubah Daftar Kontrol Akses secara rekursif. Selain itu, ini mengekspos entri jalur yang gagal diperbarui saat operasi ini berlangsung.
AccessPolicy
AccountSASSignatureValues

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

AccountSASSignatureValues digunakan untuk menghasilkan Tanda Tangan Akses Bersama (SAS) untuk akun Azure Storage. Setelah semua nilai di sini diatur dengan tepat, panggil generateAccountSASQueryParameters untuk mendapatkan representasi SAS yang benar-benar dapat diterapkan ke url data lake. Catatan: bahwa kelas ini dan SASQueryParameters ada karena yang pertama dapat diubah dan representasi logis sementara yang terakhir tidak dapat diubah dan digunakan untuk menghasilkan permintaan REST yang sebenarnya.

Lihat https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 untuk informasi konseptual selengkapnya tentang SAS Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas untuk deskripsi parameter, termasuk yang diperlukan
BlobHierarchyListSegment
BlobItemModel

Blob Azure Storage
BlobPrefix
BlobPropertiesModel

Properti blob
CommonGenerateSasUrlOptions

Opsi umum FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions dan FileGenerateSasUrlOptions.
CommonOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
CpkInfo

Grup parameter
DataLakeRequestConditions

Grup parameter
DataLakeSASSignatureValues

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

DataLakeSASSignatureValues digunakan untuk membantu menghasilkan token SAS layanan Blob dan DataLake untuk kontainer, blob, sistem file, direktori, dan file.
DataLakeServiceProperties

Properti Layanan Penyimpanan.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
DirectoryCreateIfNotExistsResponse

Berisi data respons untuk operasi createIfNotExists.
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Opsi untuk mengonfigurasi menghasilkan operasi SasUrl.
FileAppendOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileCreateIfNotExistsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileCreateIfNotExistsResponse

Berisi data respons untuk operasi createIfNotExists.
FileCreateOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileCreateResponse
FileFlushOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileGenerateSasUrlOptions

Opsi untuk mengonfigurasi menghasilkan operasi SasUrl.
FileParallelUploadOptions

Antarmuka opsi untuk file Data Lake - Operasi unggah

See:
FileQueryCsvTextConfiguration

Opsi untuk mengkueri file dengan format CSV.
FileQueryError

Jenis kesalahan kueri file.
FileQueryJsonTextConfiguration

Opsi untuk mengkueri file dengan format JSON.
FileQueryOptions

Antarmuka opsi untuk file Data Lake - operasi kueri

See:
FileQueryParquetConfiguration

Opsi untuk mengkueri file dengan format Parquet.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Antarmuka opsi untuk file Data Lake - operasi readToBuffer

See:
FileSetExpiryHeaders

Menentukan header untuk operasi Path_setExpiry.
FileSetExpiryOptions

Antarmuka opsi untuk operasi setExpiry.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Berisi data respons untuk operasi createIfNotExists.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Berisi data respons untuk operasi deleteIfExists.
FileSystemDeleteOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileSystemEncryptionScope

Opsi untuk menentukan cakupan enkripsi pada sistem file.
FileSystemExistsOptions

Antarmuka opsi untuk sistem file Data Lake ada operasi

See:
FileSystemGenerateSasUrlOptions

Opsi untuk mengonfigurasi menghasilkan operasi SasUrl.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Menentukan header untuk operasi FileSystem_listBlobHierarchySegment.
FileSystemListPathsHeaders

Menentukan header untuk operasi FileSystem_listPaths.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
FileSystemUndeletePathOption

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
HttpHeaders

Kumpulan pasangan kunci/nilai header HTTP.
HttpOperationResponse

Respons Http yang kompatibel dengan core-v1(core-http).
Lease

Detail untuk sewa tertentu.
LeaseAccessConditions

Grup parameter
LeaseOperationOptions

Mengonfigurasi operasi sewa.
ListBlobsHierarchySegmentResponse

Enumerasi blob
ListDeletedPathsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
ListDeletedPathsSegmentOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
ListFileSystemsSegmentResponse
ListPathsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
ListPathsSegmentOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Menentukan header untuk operasi Path_appendData.
PathChangeAccessControlRecursiveOptions

Jenis opsi untuk setAccessControlRecursive, updateAccessControlRecursive dan removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Jenis respons untuk setAccessControlRecursive, updateAccessControlRecursive, dan removeAccessControlRecursive.
PathCreateHeaders

Menentukan header untuk operasi Path_create.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathCreateIfNotExistsResponse

Berisi data respons untuk operasi createIfNotExists.
PathCreateOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathDeleteHeaders

Menentukan header untuk operasi Path_delete.
PathDeleteIfExistsResponse

Berisi data respons untuk operasi deleteIfExists.
PathDeleteOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathExistsOptions

Antarmuka opsi untuk direktori/file Data Lake ada operasi

See:
PathFlushDataHeaders

Menentukan header untuk operasi Path_flushData.
PathGetAccessControlHeaders
PathGetAccessControlOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Menentukan header untuk operasi Path_getProperties.
PathGetPropertiesOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Menentukan header untuk operasi Path_setAccessControl.
PathSetAccessControlOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathSetMetadataHeaders
PathSetMetadataOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathSetPermissionsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
PathUndeleteHeaders

Menentukan header untuk operasi Path_undelete.
PathUpdateHeaders

Menentukan header untuk operasi Path_update.
PipelineLike

Antarmuka untuk kelas Alur yang berisi kebijakan permintaan HTTP. Anda dapat membuat Alur default dengan memanggil newPipeline. Atau Anda dapat membuat Alur dengan kebijakan Anda sendiri oleh konstruktor Alur.

Lihat newPipeline dan kebijakan yang disediakan sebelum menerapkan Alur yang disesuaikan.
PipelineOptions

Antarmuka opsi untuk konstruktor Alur.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicy

Antarmuka yang kompatibel untuk kebijakan permintaan core-http
RequestPolicyFactory

Antarmuka untuk kompatibilitas dengan RequestPolicyFactory core-http
RequestPolicyOptions

Antarmuka untuk kompatibilitas dengan RequestPolicy
RolePermissions
SASQueryParametersOptions

Opsi untuk membangun SASQueryParameters.
SasIPRange

Rentang IP yang diizinkan untuk SAS.
ServiceClientOptions

Subset dari @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions

Opsi untuk mengonfigurasi operasi generateAccountSasUrl.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

Antarmuka untuk opsi yang umum untuk setiap operasi jarak jauh.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Opsi untuk mengonfigurasi undeleteFileSystem .
SignedIdentifier
StoragePipelineOptions

Antarmuka opsi untuk fungsi newPipeline.
StorageRetryOptions

Antarmuka opsi coba lagi Storage Blob.
UserDelegationKey

Kunci delegasi pengguna.
UserDelegationKeyModel

Kunci delegasi pengguna
WebResource

Deskripsi permintaan HTTP yang akan dibuat ke server jarak jauh.

Alias Jenis

AccessControlType
CopyStatusType
CredentialPolicyCreator

Fungsi pabrik yang membuat CredentialPolicy baru yang menggunakan nextPolicy yang disediakan.
DataLakeServiceGetPropertiesResponse

Berisi data respons untuk operasi getProperties.
EncryptionAlgorithmType

Menentukan nilai untuk EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> dapat digunakan secara bergantian dengan EncryptionAlgorithmType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

None
AES256
FileAppendResponse
FileExpiryMode

Menentukan nilai untuk PathExpiryOptions.
FileFlushResponse
FileQueryArrowConfiguration

Opsi untuk mengkueri file dengan format Apache Arrow. Hanya berlaku untuk outputtextConfiguration .
FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Berisi data respons untuk operasi <xref:DataLakeServiceClient.renameFileSystem>.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Berisi data respons untuk operasi undeleteFileSystem.
FileUploadResponse
HttpRequestBody

Jenis isi yang didukung pada permintaan. NodeJS.ReadableStream dan () => NodeJS.ReadableStream hanya node. Blob, ReadableStream<Uint8Array>, dan () => ReadableStream<Uint8Array> hanya browser.
LeaseDurationType
LeaseOperationResponse

Berisi data respons untuk operasi yang membuat, memodifikasi, atau menghapus sewa.

Lihat <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

Menentukan nilai untuk PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Menentukan nilai untuk PathRenameMode.
PathResourceTypeModel

Menentukan nilai untuk PathResourceType.
PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Berisi data respons untuk operasi listContainersSegment.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Opsi untuk mengonfigurasi <xref:DataLakeServiceClient.renameFileSystem>.

Enum

PathGetPropertiesAction

Menentukan nilai untuk PathGetPropertiesAction. Nilai yang mungkin termasuk: 'getAccessControl', 'getStatus'
PathRenameMode

Menentukan nilai untuk PathRenameMode. Nilai yang mungkin termasuk: 'warisan', 'posix'
PathResourceType

Menentukan nilai untuk PathResourceType. Nilai yang mungkin termasuk: 'direktori', 'file'
SASProtocol

Protokol untuk SAS yang dihasilkan.
StorageDataLakeAudience

Menentukan audiens cloud yang diketahui untuk Storage.
StorageRetryPolicyType

RetryPolicy jenis.

Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Menghasilkan objek SASQueryParameters yang berisi semua parameter kueri SAS yang diperlukan untuk membuat permintaan REST yang sebenarnya.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat instans SASQueryParameters.

Hanya menerima pengaturan yang diperlukan untuk membuat SAS. Untuk pengaturan opsional, atur properti yang sesuai secara langsung, seperti izin, startsOn, dan pengidentifikasi.

PERINGATAN: Ketika pengidentifikasi tidak disediakan, izin dan expiresOn diperlukan. Anda HARUS menetapkan nilai untuk pengidentifikasi atau kedaluwarsa Izin & secara manual jika Anda menginisialisasi dengan konstruktor ini.

Isi detail yang diperlukan sebelum menjalankan cuplikan berikut.

Example

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Isi detail yang diperlukan sebelum menjalankan cuplikan.

Example

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat instans SASQueryParameters. PERINGATAN: pengidentifikasi akan diabaikan saat menghasilkan SAS delegasi pengguna, izin, dan kedaluwarsaOn diperlukan.

Example

// 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, // Optional. Date type
    expiresOn, // Required. 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();
getDataLakeServiceAccountAudience(string)

Untuk mendapatkan audiens OAuth untuk akun penyimpanan untuk layanan datalake.
isPipelineLike(unknown)

Pembantu untuk memutuskan apakah argumen tertentu memenuhi kontrak Alur
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Membuat objek Alur baru dengan Kredensial yang disediakan.

Variabel

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.
StorageOAuthScopes

Cakupan OAuth untuk digunakan dengan Azure Storage.
ToBlobEndpointHostMappings
ToDfsEndpointHostMappings
logger

Konfigurasi @azure/logger untuk paket ini.

Detail Fungsi

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Menghasilkan objek SASQueryParameters yang berisi semua parameter kueri SAS yang diperlukan untuk membuat permintaan REST yang sebenarnya.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Mengembalikan

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat instans SASQueryParameters.

Hanya menerima pengaturan yang diperlukan untuk membuat SAS. Untuk pengaturan opsional, atur properti yang sesuai secara langsung, seperti izin, startsOn, dan pengidentifikasi.

PERINGATAN: Ketika pengidentifikasi tidak disediakan, izin dan expiresOn diperlukan. Anda HARUS menetapkan nilai untuk pengidentifikasi atau kedaluwarsa Izin & secara manual jika Anda menginisialisasi dengan konstruktor ini.

Isi detail yang diperlukan sebelum menjalankan cuplikan berikut.

Example

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Isi detail yang diperlukan sebelum menjalankan cuplikan.

Example

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameter

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Mengembalikan

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat instans SASQueryParameters. PERINGATAN: pengidentifikasi akan diabaikan saat menghasilkan SAS delegasi pengguna, izin, dan kedaluwarsaOn diperlukan.

Example

// 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, // Optional. Date type
    expiresOn, // Required. 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();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Parameter

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Mengembalikan nilai blobServiceClient.getUserDelegationKey()

accountName

string

Mengembalikan

SASQueryParameters

getDataLakeServiceAccountAudience(string)

Untuk mendapatkan audiens OAuth untuk akun penyimpanan untuk layanan datalake.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parameter

storageAccountName

string

Mengembalikan

string

isPipelineLike(unknown)

Pembantu untuk memutuskan apakah argumen tertentu memenuhi kontrak Alur

function isPipelineLike(pipeline: unknown): pipeline

Parameter

pipeline

unknown

Argumen yang mungkin berupa Alur

Mengembalikan

pipeline

true ketika argumen memenuhi kontrak Alur

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Membuat objek Alur baru dengan Kredensial yang disediakan.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parameter

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

pipelineOptions
StoragePipelineOptions

Optional. Options.

Mengembalikan

Pipeline

Objek Alur baru.

Variable Details

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

RestError: RestErrorConstructor

Jenis

RestErrorConstructor

StorageOAuthScopes

Cakupan OAuth untuk digunakan dengan Azure Storage.

StorageOAuthScopes: string | string[]

Jenis

string | string[]

ToBlobEndpointHostMappings 

ToBlobEndpointHostMappings: string[][]

Jenis

string[][]

ToDfsEndpointHostMappings 

ToDfsEndpointHostMappings: string[][]

Jenis

string[][]

logger

Konfigurasi @azure/logger untuk paket ini.

logger: AzureLogger

Jenis

AzureLogger