AzureDataLakeDatastore Class

Represents a datastore that saves connection information to Azure Data Lake Storage.

To create a datastore that saves connection information to Azure Data Lake Storage, use the register_azure_data_lake method of the Datastore class.

Note: When using a datastore to access data, you must have permission to access the data, which depends on the credentials registered with the datastore.

Initialize a new Azure Data Lake Datastore.

Inheritance

AbstractADLSDatastore

AzureDataLakeDatastore

Constructor

AzureDataLakeDatastore(workspace, name, store_name, tenant_id, client_id, client_secret, resource_url=None, authority_url=None, subscription_id=None, resource_group=None, service_data_access_auth_identity=None)

Parameters

Name	Description
workspace Required	str The workspace this datastore belongs to.
name Required	str The datastore name.
store_name Required	str The Azure Data Lake store name.
tenant_id Required	str The Directory ID/Tenant ID of the service principal.
client_id Required	str The Client ID/Application ID of the service principal.
client_secret Required	str The secret of the service principal.
resource_url	str, <xref:optional> The resource url, which determines what operations will be performed on the Data Lake Store. default value: None
authority_url	str, <xref:optional> The authority URL used to authenticate the user. default value: None
subscription_id	str, <xref:optional> The ID of the subscription the ADLS store belongs to. Specify both subscription_id and resource_group when using the AzureDataLakeDatastore as a data transfer destination. default value: None
resource_group	str, <xref:optional> The resource group the ADLS store belongs to. Specify both subscription_id and resource_group when using the AzureDataLakeDatastore as a data transfer destination. default value: None
service_data_access_auth_identity	str or <xref:_restclient.models.ServiceDataAccessAuthIdentity> Indicates which identity to use to authenticate service data access to customer's storage. Possible values include: 'None', 'WorkspaceSystemAssignedIdentity', 'WorkspaceUserAssignedIdentity' default value: None
workspace Required	str The workspace this datastore belongs to.
name Required	str The datastore name.
store_name Required	str The Azure Data Lake store name.
tenant_id Required	str The Directory ID/Tenant ID of the service principal.
client_id Required	str The Client ID/Application ID of the service principal.
client_secret Required	str The secret of the service principal.
resource_url Required	str, <xref:optional> The resource url, which determines what operations will be performed on the Data Lake Store.
authority_url Required	str, <xref:optional> The authority URL used to authenticate the user.
subscription_id Required	str, <xref:optional> The ID of the subscription the ADLS store belongs to. Specify both subscription_id and resource_group when using the AzureDataLakeDatastore as a data transfer destination.
resource_group Required	str, <xref:optional> The resource group the ADLS store belongs to. Specify both subscription_id and resource_group when using the AzureDataLakeDatastore as a data transfer destination.
service_data_access_auth_identity Required	str or <xref:_restclient.models.ServiceDataAccessAuthIdentity> Indicates which identity to use to authenticate service data access to customer's storage. Possible values include: 'None', 'WorkspaceSystemAssignedIdentity', 'WorkspaceUserAssignedIdentity'

Attributes

resource_group

Return the resource group of the ADLS store.

Returns

Type	Description
str	The resource group of the ADLS store

subscription_id

Return the subscription ID of the ADLS store.

Returns

Type	Description
str	The subscription ID of the ADLS store.