DataLakeServiceClient Class

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

Package:: Azure.Storage.Files.DataLake v12.20.1

Package:: Azure.Storage.Files.DataLake v12.21.0-beta.2

Source:: DataLakeServiceClient.cs

Source:: DataLakeServiceClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The DataLakeServiceClient allows you to manipulate Azure Data Lake service resources and file systems. The storage account provides the top-level namespace for the Data Lake service.

public class DataLakeServiceClient

type DataLakeServiceClient = class

Public Class DataLakeServiceClient

Inheritance: Object
DataLakeServiceClient

Constructors

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

Properties

AccountName	Gets the Storage account name corresponding to the file service client.
CanGenerateAccountSasUri	Determines whether the client is able to generate a SAS. If the client is authenticated with a StorageSharedKeyCredential.
Uri	Gets the Data Lake service's primary Uri endpoint.

Methods

CreateFileSystem(String, DataLakeFileSystemCreateOptions, CancellationToken)	The CreateFileSystem(String, DataLakeFileSystemCreateOptions, CancellationToken) operation creates a new file system under the specified account. If the file systen with the same name already exists, the operation fails. For more information, see Create Container.
CreateFileSystemAsync(String, DataLakeFileSystemCreateOptions, CancellationToken)	The CreateFileSystem(String, DataLakeFileSystemCreateOptions, CancellationToken) operation creates a new file system under the specified account. If the file system with the same name already exists, the operation fails. For more information, see Create Container.
DeleteFileSystem(String, DataLakeRequestConditions, CancellationToken)	The DeleteFileSystem(String, DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion. The file system and any paths contained within it are later deleted during garbage collection which could take several minutes. For more information, see Delete Container.
DeleteFileSystemAsync(String, DataLakeRequestConditions, CancellationToken)	The DeleteFileSystemAsync(String, DataLakeRequestConditions, CancellationToken) operation marks the specified file system for deletion. The file system and any paths contained within it are later deleted during garbage collection which could take several minutes. For more information, see Delete Container.
GenerateAccountSasUri(AccountSasBuilder)	The GenerateAccountSasUri(AccountSasBuilder) returns a Uri that generates a DataLake Account Shared Access Signature (SAS) based on the Client properties and builder 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 CanGenerateAccountSasUri. For more information, see Constructing an Account SAS.
GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes)	The GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes) returns a Uri that generates a DataLake Account Shared Access Signature (SAS) 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 CanGenerateAccountSasUri. For more information, see Constructing an Account SAS.
GetFileSystemClient(String)	Create a new DataLakeFileSystemClient object by appending `fileSystemName` to the end of Uri. The new DataLakeFileSystemClient uses the same request policy pipeline as the DataLakeFileSystemClient.
GetFileSystems(FileSystemTraits, FileSystemStates, String, CancellationToken)	The GetFileSystems(FileSystemTraits, FileSystemStates, String, CancellationToken) operation returns an async sequence of file systems in the storage account. Enumerating the file systems may make multiple requests to the service while fetching all the values. File systems are ordered lexicographically by name. For more information, see List Containers.
GetFileSystemsAsync(FileSystemTraits, FileSystemStates, String, CancellationToken)	The GetFileSystemsAsync(FileSystemTraits, FileSystemStates, String, CancellationToken) operation returns an async sequence of file systems in the storage account. Enumerating the files systems may make multiple requests to the service while fetching all the values. File systems are ordered lexicographically by name. For more information, see List Containers.
GetProperties(CancellationToken)	The GetProperties(CancellationToken) operation gets the properties of a storage account’s Data Lake service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. For more information, see Get Blob Service Properties.
GetPropertiesAsync(CancellationToken)	The GetPropertiesAsync(CancellationToken) operation gets the properties of a storage account’s Data Lake service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. For more information, see Get Blob Service Properties.
GetUserDelegationKey(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken)	The GetUserDelegationKey(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken) operation retrieves a key that can be used to delegate Active Directory authorization to shared access signatures created with DataLakeSasBuilder.
GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken)	The GetUserDelegationKeyAsync(Nullable<DateTimeOffset>, DateTimeOffset, CancellationToken) operation retrieves a key that can be used to delegate Active Directory authorization to shared access signatures created with DataLakeSasBuilder.
SetProperties(DataLakeServiceProperties, CancellationToken)	The SetProperties(DataLakeServiceProperties, CancellationToken) operation sets properties for a storage account’s Data Lake service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings. You can also use this operation to set the default request version for all incoming requests to the Blob service that do not have a version specified. For more information, see Set Blob Service Properties.
SetPropertiesAsync(DataLakeServiceProperties, CancellationToken)	The SetPropertiesAsync(DataLakeServiceProperties, CancellationToken) operation sets properties for a storage account’s Data Lake service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings. You can also use this operation to set the default request version for all incoming requests to the Blob service that do not have a version specified. For more information, see Set Blob Service Properties.
UndeleteFileSystem(String, String, CancellationToken)	Restores a previously deleted file system. This API is only functional is Container Soft Delete is enabled for the storage account associated with the filesystem.
UndeleteFileSystemAsync(String, String, CancellationToken)	Restores a previously deleted file system. This API is only functional is Container Soft Delete is enabled for the storage account associated with the filesystem.

Applies to