DataLakePathClient class

Paket:

@azure/storage-file-datalake

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

Memperluas

StorageClient

Konstruktor

DataLakePathClient(string, Pipeline)	Membuat instans DataLakePathClient dari url dan alur.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Membuat instans DataLakePathClient dari url dan kredensial.

Properti

fileSystemName	Nama sistem file saat ini.
name	Nama jalur saat ini (direktori atau file).

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.
url	Nilai string URL yang dikodekan.

Metode

create(PathResourceType, PathCreateOptions)	Buat direktori atau jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)	Buat direktori atau file. Jika sumber daya sudah ada, sumber daya tidak diubah. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	Hapus jalur saat ini (direktori atau file). Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Hapus jalur saat ini (direktori atau file) jika ada. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
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.
getAccessControl(PathGetAccessControlOptions)	Mengembalikan data kontrol akses untuk jalur (direktori file). Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Dapatkan DataLakeLeaseClient yang mengelola sewa di jalur (direktori atau file).
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
move(string, PathMoveOptions)	Pindahkan direktori atau file dalam sistem file yang sama. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Pindahkan direktori atau file ke sistem file lain. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Menghapus Kontrol Akses pada jalur dan sub jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Atur data kontrol akses untuk jalur (direktori file). Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Mengatur Kontrol Akses pada jalur dan sub jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
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
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
setPermissions(PathPermissions, PathSetPermissionsOptions)	Mengatur izin file pada jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Konversikan DataLakePathClient saat ini ke DataLakeDirectoryClient jika jalur saat ini adalah direktori.
toFileClient()	Konversikan DataLakePathClient saat ini ke DataLakeFileClient jika jalur saat ini adalah file.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Memodifikasi Kontrol Akses pada jalur dan sub jalur. Lihat https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

Detail Konstruktor

DataLakePathClient(string, Pipeline)

Membuat instans DataLakePathClient dari url dan alur.

new DataLakePathClient(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.

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

Membuat instans DataLakePathClient dari url dan kredensial.

new DataLakePathClient(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 fileSystemName

Nilai Properti

string

name

Nama jalur saat ini (direktori atau file).

string name

Nilai Properti

string

Detail Properti yang Diwariskan

accountName

accountName: string

Nilai Properti

string

Diwarisi Dari StorageClient.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 | TokenCredential

Nilai Properti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Diwarisi Dari StorageClient.credential

url

Nilai string URL yang dikodekan.

url: string

Nilai Properti

string

Diwariskan Dari StorageClient.url

Detail Metode

create(PathResourceType, PathCreateOptions)

Buat direktori atau jalur.

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, "direktori" atau "file".

options

PathCreateOptions

Optional. Opsi saat membuat jalur.

Mengembalikan

Promise<PathCreateResponse>

createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)

Buat direktori atau file. Jika sumber daya sudah ada, sumber daya tidak diubah.

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, "direktori" atau "file".

options

PathCreateIfNotExistsOptions

Mengembalikan

Promise<PathCreateIfNotExistsResponse>

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>

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>

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>

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>

getDataLakeLeaseClient(string)

Dapatkan DataLakeLeaseClient yang mengelola sewa di jalur (direktori atau file).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

proposeLeaseId

string

Optional. Id sewa awal yang diusulkan.

Mengembalikan

DataLakeLeaseClient

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>

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>

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>

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

acl

RemovePathAccessControlItem[]

Daftar kontrol akses POSIX untuk file atau direktori.

options

PathChangeAccessControlRecursiveOptions

Optional. Opsi

Mengembalikan

Promise<PathChangeAccessControlRecursiveResponse>

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

PathAccessControlItem[]

Daftar kontrol akses POSIX untuk file atau direktori.

options

PathSetAccessControlOptions

Optional. Opsi saat mengatur kontrol akses jalur.

Mengembalikan

Promise<PathSetAccessControlResponse>

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

PathAccessControlItem[]

Daftar kontrol akses POSIX untuk file atau direktori.

options

PathChangeAccessControlRecursiveOptions

Optional. Opsi

Mengembalikan

Promise<PathChangeAccessControlRecursiveResponse>

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>

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>

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>

toDirectoryClient()

Konversikan DataLakePathClient saat ini ke DataLakeDirectoryClient jika jalur saat ini adalah direktori.

function toDirectoryClient(): DataLakeDirectoryClient

Mengembalikan

DataLakeDirectoryClient

toFileClient()

Konversikan DataLakePathClient saat ini ke DataLakeFileClient jika jalur saat ini adalah file.

function toFileClient(): DataLakeFileClient

Mengembalikan

DataLakeFileClient

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

PathAccessControlItem[]

Daftar kontrol akses POSIX untuk file atau direktori.

options

PathChangeAccessControlRecursiveOptions

Optional. Opsi

Mengembalikan

Promise<PathChangeAccessControlRecursiveResponse>