DataLakePathClient Class

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.21.0

Source:

DataLakePathClient.cs

A PathClient represents a URI to the Azure DataLake service allowing you to manipulate a file or directory.

public class DataLakePathClient

type DataLakePathClient = class

Public Class DataLakePathClient

Inheritance

Object

DataLakePathClient

Derived

Azure.Storage.Files.DataLake.DataLakeDirectoryClient

Azure.Storage.Files.DataLake.DataLakeFileClient

Constructors

DataLakePathClient()	Initializes a new instance of the DataLakePathClient class for mocking.
DataLakePathClient(DataLakeFileSystemClient, String)	Initializes a new instance of the DataLakePathClient.
DataLakePathClient(String, String, String, DataLakeClientOptions)	Initializes a new instance of the DataLakePathClient.
DataLakePathClient(String, String, String)	Initializes a new instance of the DataLakePathClient.
DataLakePathClient(Uri, AzureSasCredential, DataLakeClientOptions)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri, AzureSasCredential)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri, DataLakeClientOptions)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri, StorageSharedKeyCredential, DataLakeClientOptions)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri, StorageSharedKeyCredential)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri, TokenCredential, DataLakeClientOptions)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri, TokenCredential)	Initializes a new instance of the DataLakePathClient class.
DataLakePathClient(Uri)	Initializes a new instance of the DataLakePathClient class.

Properties

AccountName	Gets the Storage account name corresponding to the directory client.
CanGenerateSasUri	Indicates whether the client is able to generate a SAS uri. Client can generate a SAS url if it is authenticated with a StorageSharedKeyCredential.
FileSystemName	Gets the file system name name corresponding to the directory client.
Name	Gets the name of the file or directory.
Path	Gets the path corresponding to the path client.
Uri	Gets the directory's primary Uri endpoint.

Methods

Create(PathResourceType, DataLakePathCreateOptions, CancellationToken)	The Create(PathResourceType, DataLakePathCreateOptions, CancellationToken) operation creates a file or directory. If the path already exists, it will be overwritten. If you don't intent to overwrite an existing path, consider using the CreateIfNotExists(PathResourceType, DataLakePathCreateOptions, CancellationToken) API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken)	The CreateAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken) operation creates a file or directory. If the path already exists, it will be overwritten. If you don't intent to overwrite an existing path, consider using the CreateIfNotExistsAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken) API. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateIfNotExists(PathResourceType, DataLakePathCreateOptions, CancellationToken)	The Azure.Storage.Files.DataLake.DataLakePathClient.CreateIfNotExists(Azure.Storage.Files.DataLake.Models.PathResourceType,Azure.Storage.Files.DataLake.Models.PathHttpHeaders,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.String,System.Threading.CancellationToken) operation creates a file or directory. If the file or directory already exists, it is not changed. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
CreateIfNotExistsAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken)	The Azure.Storage.Files.DataLake.DataLakePathClient.CreateIfNotExistsAsync(Azure.Storage.Files.DataLake.Models.PathResourceType,Azure.Storage.Files.DataLake.Models.PathHttpHeaders,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.String,System.Threading.CancellationToken) operation creates a file or directory. If the file or directory already exists, it is not changed. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
Delete(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken)	The Delete(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion. The path is later deleted during garbage collection which could take several minutes. For more information, see Delete Path.
DeleteAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken)	The DeleteAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion. The path is later deleted during garbage collection which could take several minutes. For more information, see Delete Path.
DeleteIfExists(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken)	The DeleteIfExists(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path for deletion, if the path exists. The path is later deleted during garbage collection which could take several minutes. For more information, see Delete Path.
DeleteIfExistsAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken)	The DeleteIfExistsAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation marks the specified path deletion, if the path exists. The path is later deleted during garbage collection which could take several minutes. For more information, see Delete Path.
Exists(CancellationToken)	The Exists(CancellationToken) operation can be called on a DataLakePathClient to see if the associated file or director exists in the file system.
ExistsAsync(CancellationToken)	The ExistsAsync(CancellationToken) operation can be called on a DataLakePathClient to see if the associated file or directory exists in the file system.
GenerateSasUri(DataLakeSasBuilder)	The GenerateSasUri(DataLakeSasBuilder) returns a Uri that generates a DataLake File Service Shared Access Signature (SAS) Uri based on the Client properties and and builder. The SAS is signed by the shared key credential of the client. To check if the client is able to sign a Service Sas see CanGenerateSasUri. For more information, see Constructing a Service SAS.
GenerateSasUri(DataLakeSasPermissions, DateTimeOffset)	The GenerateSasUri(DataLakeSasPermissions, DateTimeOffset) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client properties and parameters passed. The SAS is signed by the shared key credential of the client. To check if the client is able to sign a Service Sas see CanGenerateSasUri. For more information, see Constructing a service SAS.
GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey)	The GenerateUserDelegationSasUri(DataLakeSasBuilder, UserDelegationKey) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client properties and builder passed. The SAS is signed by the user delegation key passed in. For more information, see Creating an user delegation SAS.
GenerateUserDelegationSasUri(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey)	The GenerateUserDelegationSasUri(DataLakeSasPermissions, DateTimeOffset, UserDelegationKey) returns a Uri that generates a DataLake Path Service Shared Access Signature (SAS) Uri based on the Client properties and parameter passed. The SAS is signed by the user delegation key passed in. For more information, see Creating an user delegation SAS.
GetAccessControl(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken)	The GetAccessControl(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation returns the access control data for a path. For more information, see Get Properties.
GetAccessControlAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken)	The GetAccessControlAsync(Nullable<Boolean>, DataLakeRequestConditions, CancellationToken) operation returns the access control data for a path. For more information, see Get Properties.
GetParentDirectoryClientCore()	Create a new DataLakeDirectoryClient that pointing to this DataLakePathClient's parent container. The new DataLakeDirectoryClient uses the same request policy pipeline as the DataLakePathClient.
GetParentFileSystemClientCore()	Create a new DataLakeFileSystemClient that pointing to this DataLakePathClient's parent container. The new DataLakeFileSystemClient uses the same request policy pipeline as the DataLakePathClient.
GetProperties(DataLakeRequestConditions, CancellationToken)	The GetProperties(DataLakeRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the path. It does not return the content of the path. For more information, see Get Properties.
GetPropertiesAsync(DataLakeRequestConditions, CancellationToken)	The GetPropertiesAsync(DataLakeRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the path. It does not return the content of the path. For more information, see Get Properties.
RemoveAccessControlRecursive(IList<RemovePathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken)	The RemoveAccessControlRecursive(IList<RemovePathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation removes the Access Control on a path and subpaths For more information, see Update Path.
RemoveAccessControlRecursiveAsync(IList<RemovePathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken)	The RemoveAccessControlRecursiveAsync(IList<RemovePathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation removes the Access Control on a path and subpaths For more information, see Update Path.
Rename(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken)	The Rename(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken) operation renames a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
RenameAsync(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken)	The RenameAsync(String, String, DataLakeRequestConditions, DataLakeRequestConditions, CancellationToken) operation renames a file or directory. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
SetAccessControlList(IList<PathAccessControlItem>, String, String, DataLakeRequestConditions, CancellationToken)	The SetAccessControlList(IList<PathAccessControlItem>, String, String, DataLakeRequestConditions, CancellationToken) operation sets the Access Control on a path For more information, see Update Path.
SetAccessControlListAsync(IList<PathAccessControlItem>, String, String, DataLakeRequestConditions, CancellationToken)	The SetAccessControlListAsync(IList<PathAccessControlItem>, String, String, DataLakeRequestConditions, CancellationToken) operation sets the Access Control on a path For more information, see Update Path.
SetAccessControlRecursive(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken)	The SetAccessControlRecursive(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation sets the Access Control on a path and subpaths For more information, see Update Path.
SetAccessControlRecursiveAsync(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken)	The SetAccessControlRecursiveAsync(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation sets the Access Control on a path and subpaths For more information, see Update Path.
SetHttpHeaders(PathHttpHeaders, DataLakeRequestConditions, CancellationToken)	The SetHttpHeaders(PathHttpHeaders, DataLakeRequestConditions, CancellationToken) operation sets system properties on the path. For more information, see Set Properties.
SetHttpHeadersAsync(PathHttpHeaders, DataLakeRequestConditions, CancellationToken)	The SetHttpHeadersAsync(PathHttpHeaders, DataLakeRequestConditions, CancellationToken) operation sets system properties on the PATH. For more information, see Set Properties.
SetMetadata(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken)	The SetMetadata(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets user-defined metadata for the specified path as one or more name-value pairs. For more information, see Set Metadata.
SetMetadataAsync(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken)	The SetMetadataAsync(IDictionary<String,String>, DataLakeRequestConditions, CancellationToken) operation sets user-defined metadata for the specified path as one or more name-value pairs. For more information, see Set Metadata.
SetPermissions(PathPermissions, String, String, DataLakeRequestConditions, CancellationToken)	The SetPermissions(PathPermissions, String, String, DataLakeRequestConditions, CancellationToken) operation sets the file permissions on a path. For more information, see Update Path.
SetPermissionsAsync(PathPermissions, String, String, DataLakeRequestConditions, CancellationToken)	The SetPermissionsAsync(PathPermissions, String, String, DataLakeRequestConditions, CancellationToken) operation sets the file permissions on a path. For more information, see Update Path.
UpdateAccessControlRecursive(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken)	The UpdateAccessControlRecursive(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation modifies the Access Control on a path and subpaths For more information, see Update Path.
UpdateAccessControlRecursiveAsync(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken)	The UpdateAccessControlRecursiveAsync(IList<PathAccessControlItem>, String, AccessControlChangeOptions, CancellationToken) operation modifies the Access Control on a path and subpaths For more information, see Update Path.
WithCustomerProvidedKey(Nullable<DataLakeCustomerProvidedKey>)	Initializes a new instance of the DataLakePathClient class with an identical Uri source but the specified customerProvidedKey.

Extension Methods

GetDataLakeLeaseClient(DataLakePathClient, String)	Initializes a new instance of the DataLakeLeaseClient class.
GetParentDirectoryClient(DataLakePathClient)	Create a new DataLakeDirectoryClient that pointing to this DataLakePathClient's parent directory. The new DataLakeDirectoryClient uses the same request policy pipeline as the DataLakePathClient.
GetParentFileSystemClient(DataLakePathClient)	Create a new DataLakeFileSystemClient that pointing to this DataLakePathClient's parent container. The new DataLakeFileSystemClient uses the same request policy pipeline as the DataLakePathClient.