DataLakePathClient class

套件:

@azure/storage-file-datalake

DataLakePathClient 代表 Azure 記憶體路徑（目錄或檔案）的 URL。

Extends

StorageClient

建構函式

DataLakePathClient(string, Pipeline)	從 URL 和管線建立 DataLakePathClient 的實例。
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	從 URL 和認證建立 DataLakePathClient 的實例。

屬性

fileSystemName	目前檔案系統的名稱。
name	目前路徑的名稱（目錄或檔案）。

繼承的屬性

accountName
credential	例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。
url	編碼的 URL 字串值。

方法

create(PathResourceTypeModel, PathCreateOptions)	建立目錄或路徑。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	建立目錄或檔案。 如果資源已經存在，則不會變更。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
delete(boolean, PathDeleteOptions)	刪除目前的路徑（目錄或檔案）。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	如果存在，請刪除目前的路徑（目錄或檔案）。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	如果此用戶端所代表的 Data Lake 檔案存在，則傳回 true;否則為 false。 注意：請小心使用此函式，因為其他用戶端或應用程式可能會刪除現有的檔案。 反之亦然，此函式完成之後，其他用戶端或應用程式可能會新增新的檔案。
getAccessControl(PathGetAccessControlOptions)	傳回路徑的訪問控制數據（檔案目錄）。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	取得管理路徑 （目錄或檔案） 租用的 DataLakeLeaseClient。
getProperties(PathGetPropertiesOptions)	傳回路徑 （目錄或檔案） 的所有使用者定義元數據、標準 HTTP 屬性和系統屬性。 警告：回應中傳回的 metadata 物件會以小寫表示，即使它們原本包含大寫字元也一樣。 這與 dataLakeFileSystemClient 方法所傳回的元數據索引鍵不同， 使用 includeMetadata 選項列出路徑，這會保留其原始大小寫。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	在相同的檔案系統內移動目錄或檔案。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	將目錄或檔案移至另一個檔案系統。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	拿掉路徑和子路徑上的訪問控制。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	設定路徑的訪問控制數據（檔案目錄）。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	設定路徑和子路徑上的訪問控制。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	在路徑上設定系統屬性（目錄或檔案）。 如果未提供任何值，或未為指定的 Blob HTTP 標頭提供任何值，則會清除沒有值的這些 Blob HTTP 標頭。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	將指定路徑的使用者定義元資料（檔案目錄）設定為一或多個名稱/值組。 如果未提供任何選項，或參數中未定義任何元數據，則會移除路徑元數據。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	設定路徑上的檔案許可權。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	如果目前的路徑是目錄，請將目前的 DataLakePathClient 轉換為 DataLakeDirectoryClient。
toFileClient()	如果目前的路徑是檔案，請將目前的 DataLakePathClient 轉換為 DataLakeFileClient。
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	修改路徑和子路徑上的訪問控制。 請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

建構函式詳細資料

DataLakePathClient(string, Pipeline)

從 URL 和管線建立 DataLakePathClient 的實例。

new DataLakePathClient(url: string, pipeline: Pipeline)

參數

url

string

指向 Azure 記憶體資料湖路徑（目錄或檔案）的用戶端字串，例如 「https://myaccount.dfs.core.windows.net/filesystem/directory"或 「https://myaccount.dfs.core.windows.net/filesystem/file"」。 如果使用 AnonymousCredential，則可以附加 SAS，例如 “https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"。

pipeline

Pipeline

呼叫 newPipeline（） 以建立預設管線，或提供自定義管線。

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

從 URL 和認證建立 DataLakePathClient 的實例。

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

參數

url

string

指向 Azure 記憶體資料湖路徑（目錄或檔案）的用戶端字串，例如 「https://myaccount.dfs.core.windows.net/filesystem/directory"或 「https://myaccount.dfs.core.windows.net/filesystem/file"」。 如果使用 AnonymousCredential，則可以附加 SAS，例如 “https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。

options

StoragePipelineOptions

自選。 設定 HTTP 管線的選項。

屬性詳細資料

fileSystemName

目前檔案系統的名稱。

string fileSystemName

屬性值

string

name

目前路徑的名稱（目錄或檔案）。

string name

屬性值

string

繼承的屬性詳細資料

accountName

accountName: string

屬性值

string

繼承自 StorageClient.accountName

credential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何來自 @azure/identity 套件的認證，以驗證對服務的要求。 您也可以提供實作 TokenCredential 介面的物件。 如果未指定，則會使用 AnonymousCredential。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

屬性值

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

繼承自 StorageClient.credential

url

編碼的 URL 字串值。

url: string

屬性值

string

繼承自 StorageClient.url

方法詳細資料

create(PathResourceTypeModel, PathCreateOptions)

建立目錄或路徑。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

參數

resourceType

PathResourceTypeModel

資源類型、“directory” 或 “file”。

options

PathCreateOptions

自選。 建立路徑時的選項。

傳回

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

建立目錄或檔案。 如果資源已經存在，則不會變更。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

參數

resourceType

PathResourceTypeModel

資源類型、“directory” 或 “file”。

options

PathCreateIfNotExistsOptions

傳回

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

刪除目前的路徑（目錄或檔案）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

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

參數

recursive

boolean

只有在資源是目錄時，才必要且有效。 如果為 「true」 將會刪除目錄下的所有路徑。

options

PathDeleteOptions

自選。 刪除路徑時的選項。

傳回

Promise<PathDeleteResponse>

deleteIfExists(boolean, PathDeleteOptions)

如果存在，請刪除目前的路徑（目錄或檔案）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

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

參數

recursive

boolean

只有在資源是目錄時，才必要且有效。 如果為 「true」 將會刪除目錄下的所有路徑。

options

PathDeleteOptions

傳回

Promise<PathDeleteIfExistsResponse>

exists(PathExistsOptions)

如果此用戶端所代表的 Data Lake 檔案存在，則傳回 true;否則為 false。

注意：請小心使用此函式，因為其他用戶端或應用程式可能會刪除現有的檔案。 反之亦然，此函式完成之後，其他用戶端或應用程式可能會新增新的檔案。

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

參數

options

PathExistsOptions

[存在] 作業的選項。

傳回

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

傳回路徑的訪問控制數據（檔案目錄）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

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

參數

options

PathGetAccessControlOptions

自選。 取得檔案訪問控制時的選項。

傳回

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

取得管理路徑 （目錄或檔案） 租用的 DataLakeLeaseClient。

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

參數

proposeLeaseId

string

自選。 初始建議的租用標識碼。

傳回

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

傳回路徑 （目錄或檔案） 的所有使用者定義元數據、標準 HTTP 屬性和系統屬性。

警告：回應中傳回的 metadata 物件會以小寫表示，即使它們原本包含大寫字元也一樣。 這與 dataLakeFileSystemClient 方法所傳回的元數據索引鍵不同， 使用 includeMetadata 選項列出路徑，這會保留其原始大小寫。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

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

參數

options

PathGetPropertiesOptions

自選。 取得路徑屬性時的選項。

傳回

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

在相同的檔案系統內移動目錄或檔案。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

參數

destinationPath

string

目的地目錄路徑，例如 「directory」 或檔案路徑 「directory/file」。。 如果 destinationPath 已使用 SAS 進行驗證，請將 SAS 新增至目的地路徑，例如 “directory/file？sasToken”。

options

PathMoveOptions

自選。 移動目錄或檔案時的選項。

傳回

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

將目錄或檔案移至另一個檔案系統。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

參數

destinationFileSystem

string

目的地文件系統，例如 「filesystem」。。

destinationPath

string

目的地目錄路徑，例如 「directory」 或檔案路徑 「directory/file」 如果 destinationPath 已向 SAS 進行驗證，請將 SAS 新增至目的地路徑，例如 「directory/file？sasToken」。

options

PathMoveOptions

自選。 移動目錄或檔案時的選項。

傳回

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

拿掉路徑和子路徑上的訪問控制。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

參數

acl

RemovePathAccessControlItem[]

檔案或目錄的 POSIX 訪問控制清單。

options

PathChangeAccessControlRecursiveOptions

自選。 選項

傳回

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

設定路徑的訪問控制數據（檔案目錄）。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

參數

acl

PathAccessControlItem[]

檔案或目錄的 POSIX 訪問控制清單。

options

PathSetAccessControlOptions

自選。 設定路徑存取控制時的選項。

傳回

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

設定路徑和子路徑上的訪問控制。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

參數

acl

PathAccessControlItem[]

檔案或目錄的 POSIX 訪問控制清單。

options

PathChangeAccessControlRecursiveOptions

自選。 選項

傳回

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

在路徑上設定系統屬性（目錄或檔案）。

如果未提供任何值，或未為指定的 Blob HTTP 標頭提供任何值，則會清除沒有值的這些 Blob HTTP 標頭。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

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

參數

httpHeaders

PathHttpHeaders

options

PathSetHttpHeadersOptions

傳回

Promise<PathSetHttpHeadersResponse>

setMetadata(Metadata, PathSetMetadataOptions)

將指定路徑的使用者定義元資料（檔案目錄）設定為一或多個名稱/值組。

如果未提供任何選項，或參數中未定義任何元數據，則會移除路徑元數據。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

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

參數

metadata

Metadata

自選。 將現有的元數據取代為此值。 如果未提供任何值，則會移除現有的元數據。

options

PathSetMetadataOptions

自選。 設定路徑元數據時的選項。

傳回

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

設定路徑上的檔案許可權。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

參數

permissions

PathPermissions

檔案擁有者、檔案擁有者和其他專案的 POSIX 訪問許可權。

options

PathSetPermissionsOptions

自選。 設定路徑許可權時的選項。

傳回

Promise<PathSetPermissionsResponse>

toDirectoryClient()

如果目前的路徑是目錄，請將目前的 DataLakePathClient 轉換為 DataLakeDirectoryClient。

function toDirectoryClient(): DataLakeDirectoryClient

傳回

DataLakeDirectoryClient

toFileClient()

如果目前的路徑是檔案，請將目前的 DataLakePathClient 轉換為 DataLakeFileClient。

function toFileClient(): DataLakeFileClient

傳回

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

修改路徑和子路徑上的訪問控制。

請參閱 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

參數

acl

PathAccessControlItem[]

檔案或目錄的 POSIX 訪問控制清單。

options

PathChangeAccessControlRecursiveOptions

自選。 選項

傳回

Promise<PathChangeAccessControlRecursiveResponse>