DataLakeDirectoryClient class
DataLakeDirectoryClient mewakili URL ke direktori Azure Storage.
- Memperluas
Konstruktor
| Data |
Membuat instans DataLakePathClient dari url dan alur. |
| Data |
Membuat instans DataLakePathClient dari url dan kredensial. |
Properti
| file |
Nama sistem file saat ini. |
| name | Nama jalur saat ini (direktori atau file). |
Properti yang Diwariskan
| account |
|
| credential | Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket |
| url | Nilai string URL yang dikodekan. |
Metode
Metode yang Diwarisi
| delete(boolean, Path |
Hapus jalur saat ini (direktori atau file). Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| delete |
Hapus jalur saat ini (direktori atau file) jika ada. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete |
| exists(Path |
Mengembalikan true jika file Data Lake yang diwakili oleh klien ini ada; false jika tidak. CATATAN: gunakan fungsi ini dengan hati-hati karena file yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya, file baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai. |
| get |
Mengembalikan data kontrol akses untuk jalur (direktori file). Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties |
| get |
Dapatkan DataLakeLeaseClient |
| get |
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk jalur (direktori atau file). PERINGATAN: Objek Lihat https://learn.microsoft.com/rest/api/storageservices/get-blob-properties |
| move(string, Path |
Pindahkan direktori atau file dalam sistem file yang sama. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| move(string, string, Path |
Pindahkan direktori atau file ke sistem file lain. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create |
| remove |
Menghapus Kontrol Akses pada jalur dan sub jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Atur data kontrol akses untuk jalur (direktori file). Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Mengatur Kontrol Akses pada jalur dan sub jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| set |
Mengatur properti sistem pada jalur (direktori atau file). Jika tidak ada nilai yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP blob yang ditentukan, header HTTP blob ini tanpa nilai akan dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/set-blob-properties |
| set |
Mengatur metadata yang ditentukan pengguna untuk jalur yang ditentukan (direktori file) sebagai satu atau beberapa pasangan nilai nama. Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter, metadata jalur akan dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata |
| set |
Mengatur izin file pada jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
| to |
Konversikan DataLakePathClient saat ini ke DataLakeDirectoryClient jika jalur saat ini adalah direktori. |
| to |
Konversikan DataLakePathClient saat ini ke DataLakeFileClient jika jalur saat ini adalah file. |
| update |
Memodifikasi Kontrol Akses pada jalur dan sub jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update |
Detail Konstruktor
DataLakeDirectoryClient(string, Pipeline)
Membuat instans DataLakePathClient dari url dan alur.
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)Parameter
- url
-
string
String Klien yang menunjuk ke jalur data lake Azure Storage (direktori atau file), seperti "https://myaccount.dfs.core.windows.net/filesystem/directory" atau "https://myaccount.dfs.core.windows.net/filesystem/file". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Membuat instans DataLakePathClient dari url dan kredensial.
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)Parameter
- url
-
string
String Klien yang menunjuk ke jalur data lake Azure Storage (direktori atau file), seperti "https://myaccount.dfs.core.windows.net/filesystem/directory" atau "https://myaccount.dfs.core.windows.net/filesystem/file". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- 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.
- options
- StoragePipelineOptions
Optional. Opsi untuk mengonfigurasi alur HTTP.
Detail Properti
fileSystemName
Nama sistem file saat ini.
string fileSystemNameNilai Properti
string
name
Nama jalur saat ini (direktori atau file).
string nameNilai Properti
string
Detail Properti yang Diwariskan
accountName
credential
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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialNilai Properti
Diwarisi dariDataLakePathClient.credential
url
Nilai string URL yang dikodekan.
url: stringNilai Properti
string
Diwarisi dariDataLakePathClient.url
Detail Metode
create(DirectoryCreateOptions)
Membuat direktori.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parameter
- options
- DirectoryCreateOptions
Optional. Opsi saat membuat direktori.
Mengembalikan
Promise<DirectoryCreateResponse>
create(PathResourceType, PathCreateOptions)
Membuat direktori.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>Parameter
- resourceType
- PathResourceTypeModel
Jenis sumber daya, harus "direktori" untuk DataLakeDirectoryClient.
- options
- PathCreateOptions
Optional. Opsi saat membuat direktori.
Mengembalikan
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
Buat direktori jika belum ada.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>Parameter
Mengembalikan
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
Buat direktori jika belum ada.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>Parameter
- resourceType
- PathResourceTypeModel
Jenis sumber daya, harus "direktori" untuk DataLakeDirectoryClient.
- options
- PathCreateIfNotExistsOptions
Mengembalikan
Promise<PathCreateIfNotExistsResponse>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan.
Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): stringParameter
- options
- DirectoryGenerateSasUrlOptions
Parameter opsional.
Mengembalikan
string
URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.
generateSasUrl(DirectoryGenerateSasUrlOptions)
Hanya tersedia untuk klien yang dibangun dengan kredensial kunci bersama.
Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.
Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parameter
- options
- DirectoryGenerateSasUrlOptions
Parameter opsional.
Mengembalikan
Promise<string>
URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Menghasilkan string untuk menandatangani URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan di SAS ditandatangani oleh kunci delegasi pengguna input.
Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): stringParameter
- options
- DirectoryGenerateSasUrlOptions
Parameter opsional.
- userDelegationKey
- UserDelegationKey
Mengembalikan nilai blobServiceClient.getUserDelegationKey()
Mengembalikan
string
URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.
Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>Parameter
- options
- DirectoryGenerateSasUrlOptions
Parameter opsional.
- userDelegationKey
- UserDelegationKey
Mengembalikan nilai blobServiceClient.getUserDelegationKey()
Mengembalikan
Promise<string>
URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.
getFileClient(string)
Membuat objek DataLakeFileClient
function getFileClient(fileName: string): DataLakeFileClientParameter
- fileName
-
string
Mengembalikan
getSubdirectoryClient(string)
Membuat objek DataLakeDirectoryClient di bawah direktori saat ini.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParameter
- subdirectoryName
-
string
Nama subdirektori.
Mengembalikan
Detail Metode yang Diwarisi
delete(boolean, PathDeleteOptions)
Hapus jalur saat ini (direktori atau file).
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>Parameter
- recursive
-
boolean
Diperlukan dan valid hanya ketika sumber daya adalah direktori. Jika "true", semua jalur di bawah direktori akan dihapus.
- options
- PathDeleteOptions
Optional. Opsi saat menghapus jalur.
Mengembalikan
Promise<PathDeleteResponse>
Diwarisi dariDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Hapus jalur saat ini (direktori atau file) jika ada.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>Parameter
- recursive
-
boolean
Diperlukan dan valid hanya ketika sumber daya adalah direktori. Jika "true", semua jalur di bawah direktori akan dihapus.
- options
- PathDeleteOptions
Mengembalikan
Promise<PathDeleteIfExistsResponse>
Diwarisi dariDataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Mengembalikan true jika file Data Lake yang diwakili oleh klien ini ada; false jika tidak.
CATATAN: gunakan fungsi ini dengan hati-hati karena file yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya, file baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.
function exists(options?: PathExistsOptions): Promise<boolean>Parameter
- options
- PathExistsOptions
opsi untuk operasi Ada.
Mengembalikan
Promise<boolean>
Diwarisi dariDataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Mengembalikan data kontrol akses untuk jalur (direktori file).
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>Parameter
- options
- PathGetAccessControlOptions
Optional. Opsi saat mendapatkan kontrol akses file.
Mengembalikan
Promise<PathGetAccessControlResponse>
Diwarisi dariDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Dapatkan DataLakeLeaseClient
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParameter
- proposeLeaseId
-
string
Optional. Id sewa awal yang diusulkan.
Mengembalikan
Diwarisi dariDataLakePathClient.getDataLakeLeaseClient
getProperties(PathGetPropertiesOptions)
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk jalur (direktori atau file).
PERINGATAN: Objek metadata yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode DataLakeFileSystemClient yang mencantumkan jalur menggunakan opsi includeMetadata, yang akan mempertahankan casing aslinya.
Lihat https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parameter
- options
- PathGetPropertiesOptions
Optional. Opsi saat mendapatkan properti jalur.
Mengembalikan
Promise<PathGetPropertiesResponse>
Diwarisi dariDataLakePathClient.getProperties
move(string, PathMoveOptions)
Pindahkan direktori atau file dalam sistem file yang sama.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parameter
- destinationPath
-
string
Jalur direktori tujuan seperti "direktori" atau jalur file "direktori/file". Jika destinationPath diautentikasi dengan SAS, tambahkan SAS ke jalur tujuan seperti "directory/file?sasToken".
- options
- PathMoveOptions
Optional. Opsi saat memindahkan direktori atau file.
Mengembalikan
Promise<PathMoveResponse>
Diwarisi dariDataLakePathClient.move
move(string, string, PathMoveOptions)
Pindahkan direktori atau file ke sistem file lain.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>Parameter
- destinationFileSystem
-
string
Sistem file tujuan seperti "sistem file".
- destinationPath
-
string
Jalur direktori tujuan seperti "direktori" atau jalur file "direktori/file" Jika destinationPath diautentikasi dengan SAS, tambahkan SAS ke jalur tujuan seperti "direktori/file?sasToken".
- options
- PathMoveOptions
Optional. Opsi saat memindahkan direktori atau file.
Mengembalikan
Promise<PathMoveResponse>
Diwarisi dariDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Menghapus Kontrol Akses pada jalur dan sub jalur.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parameter
Daftar kontrol akses POSIX untuk file atau direktori.
Optional. Opsi
Mengembalikan
Diwarisi dariDataLakePathClient.removeAccessControlRecursive
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Atur data kontrol akses untuk jalur (direktori file).
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>Parameter
- acl
Daftar kontrol akses POSIX untuk file atau direktori.
- options
- PathSetAccessControlOptions
Optional. Opsi saat mengatur kontrol akses jalur.
Mengembalikan
Promise<PathSetAccessControlResponse>
Diwarisi dariDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Mengatur Kontrol Akses pada jalur dan sub jalur.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parameter
- acl
Daftar kontrol akses POSIX untuk file atau direktori.
Optional. Opsi
Mengembalikan
Diwarisi dariDataLakePathClient.setAccessControlRecursive
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Mengatur properti sistem pada jalur (direktori atau file).
Jika tidak ada nilai yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP blob yang ditentukan, header HTTP blob ini tanpa nilai akan dihapus.
Lihat https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>Parameter
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Mengembalikan
Promise<PathSetHttpHeadersResponse>
Diwarisi dariDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Mengatur metadata yang ditentukan pengguna untuk jalur yang ditentukan (direktori file) sebagai satu atau beberapa pasangan nilai nama.
Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter, metadata jalur akan dihapus.
Lihat https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>Parameter
- metadata
- Metadata
Optional. Ganti metadata yang ada dengan nilai ini. Jika tidak ada nilai yang disediakan, metadata yang ada akan dihapus.
- options
- PathSetMetadataOptions
Optional. Opsi saat mengatur metadata jalur.
Mengembalikan
Promise<PathSetMetadataResponse>
Diwarisi dariDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Mengatur izin file pada jalur.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>Parameter
- permissions
- PathPermissions
Izin akses POSIX untuk pemilik file, grup pemilik file, dan lainnya.
- options
- PathSetPermissionsOptions
Optional. Opsi saat mengatur izin jalur.
Mengembalikan
Promise<PathSetPermissionsResponse>
Diwarisi dariDataLakePathClient.setPermissions
toDirectoryClient()
Konversikan DataLakePathClient saat ini ke DataLakeDirectoryClient jika jalur saat ini adalah direktori.
function toDirectoryClient(): DataLakeDirectoryClientMengembalikan
Diwarisi dariDataLakePathClient.toDirectoryClient
toFileClient()
Konversikan DataLakePathClient saat ini ke DataLakeFileClient jika jalur saat ini adalah file.
function toFileClient(): DataLakeFileClientMengembalikan
Diwarisi dariDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Memodifikasi Kontrol Akses pada jalur dan sub jalur.
Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>Parameter
- acl
Daftar kontrol akses POSIX untuk file atau direktori.
Optional. Opsi
Mengembalikan
Diwarisi dariDataLakePathClient.updateAccessControlRecursive