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
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

workspace
str
Required

The workspace this datastore belongs to.

name
str
Required

The datastore name.

store_name
str
Required

The Azure Data Lake store name.

tenant_id
str
Required

The Directory ID/Tenant ID of the service principal.

client_id
str
Required

The Client ID/Application ID of the service principal.

client_secret
str
Required

The secret of the service principal.

resource_url
str, <xref:optional>
default value: None

The resource url, which determines what operations will be performed on the Data Lake Store.

authority_url
str, <xref:optional>
default value: None

The authority URL used to authenticate the user.

subscription_id
str, <xref:optional>
default value: None

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
str, <xref:optional>
default value: None

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
str or <xref:_restclient.models.ServiceDataAccessAuthIdentity>
default value: None

Indicates which identity to use to authenticate service data access to customer's storage. Possible values include: 'None', 'WorkspaceSystemAssignedIdentity', 'WorkspaceUserAssignedIdentity'

workspace
str
Required

The workspace this datastore belongs to.

name
str
Required

The datastore name.

store_name
str
Required

The Azure Data Lake store name.

tenant_id
str
Required

The Directory ID/Tenant ID of the service principal.

client_id
str
Required

The Client ID/Application ID of the service principal.

client_secret
str
Required

The secret of the service principal.

resource_url
str, <xref:optional>
Required

The resource url, which determines what operations will be performed on the Data Lake Store.

authority_url
str, <xref:optional>
Required

The authority URL used to authenticate the user.

subscription_id
str, <xref:optional>
Required

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
str, <xref:optional>
Required

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
str or <xref:_restclient.models.ServiceDataAccessAuthIdentity>
Required

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

The resource group of the ADLS store

Return type

str

subscription_id

Return the subscription ID of the ADLS store.

Returns

The subscription ID of the ADLS store.

Return type

str