DataLakePathClient class

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

new DataLakePathClient(url: string, pipeline: Pipeline)

參數

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

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

參數

目前檔案系統的名稱。

string fileSystemName

屬性值

目前路徑 (目錄或檔案) 的名稱。

string name

屬性值

accountName: string

屬性值

繼承自 StorageClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

屬性值

繼承自 StorageClient.credential

編碼的 URL 字串值。

url: string

屬性值

繼承自 StorageClient.url

建立目錄或路徑。

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

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

參數

傳回

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

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

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

參數

傳回

刪除當前路徑 (目錄或檔案) 。

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

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

參數

傳回

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

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

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

參數

傳回

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

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

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

參數

傳回

傳回檔案) 路徑 (目錄的存取控制資料。

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

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

參數

傳回

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

參數

傳回

傳回路徑 (目錄或檔案) 的所有使用者定義中繼資料、標準 HTTP 屬性和系統屬性。

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

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

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

參數

傳回

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

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

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

參數

傳回

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

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

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

參數

傳回

移除路徑和子路徑上的存取控制。

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

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

參數

傳回

設定檔案) 路徑 (目錄的存取控制資料。

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

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

參數

傳回

設定路徑和子路徑上的存取控制。

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

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

參數

傳回

設定路徑 (目錄或檔案) 的系統屬性。

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

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

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

參數

傳回

將指定路徑 (檔案目錄的使用者定義中繼資料，) 設定為一或多個名稱/值組。

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

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

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

參數

傳回

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

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

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

參數

傳回

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

function toDirectoryClient(): DataLakeDirectoryClient

傳回

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

function toFileClient(): DataLakeFileClient

傳回

修改路徑和子路徑上的存取控制。

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

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

參數

傳回