DatacacheStore Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

Represents a storage abstraction over an Azure Machine Learning storage account.

DatacacheStores are attached to workspaces and are used to store information related to the underlying datacache solution. Currently, only partitioned blob solution is supported. Datacachestores defines various Blob datastores that could be used for caching.

Use this class to perform management operations, including register, list, get, and update datacachestores. DatacacheStores for each service are created with the register* methods of this class.

Get a datacachestore by name. This call will make a request to the datacache service.

Inheritance

builtins.object

DatacacheStore

Constructor

DatacacheStore(workspace, name, **kwargs)

Parameters

workspace

Workspace

Required

The workspace.

name

str

Required

The name of the datacachestore

Methods

get_by_name	Get a datacachestore by name.
list	List all the datacachestores in the workspace.
register	Register a datacachestore to the workspace.
update	Update datacache policy for a datacachestore.

get_by_name

Get a datacachestore by name.

static get_by_name(workspace, name)

Parameters

workspace

Workspace

Required

The workspace.

name

str

Required

The name of the datacachestore

Returns

The corresponding datastore for that name.

Return type

DatacacheStore

list

List all the datacachestores in the workspace.

static list(workspace)

Parameters

workspace

Workspace

Required

The workspace.

Returns

List of DatacacheStore objects.

Return type

list[DatacacheStore]

register

Register a datacachestore to the workspace.

static register(workspace, name, data_store_list, data_management_compute_target, data_management_compute_auth, ttl_in_days, ttl_expiration_policy, default_replica_count, data_factory_resource_id=None, **kwargs)

Parameters

workspace

Workspace

Required

The workspace.

name

Union[list(str), list(<xref:AbstractDataStore>)]

Required

The name of the datacachestore.

data_store_list

Required

The list of underlying datastores.

data_management_compute_target

ComputeTarget

Required

The data management compute.

data_management_compute_auth

ServicePrincipalAuthentication

Required

The service principal used to submit data management jobs to data management compute.

ttl_in_days

<xref:Int>

Required

Time-To-Live in days.

ttl_expiration_policy

str, <xref:one> of [<xref:"LastAccessTime">, <xref:"CreationTime">]

Required

TTL expire policy.

default_replica_count

<xref:Int>

Required

Default number of replicas to hydrate.

data_factory_resource_id

<xref:str.>

default value: None

Resource id of the ADF to be used for hydration.

Returns

The DatacacheStore object

Return type

DatacacheStore

update

Update datacache policy for a datacachestore.

static update(workspace, name, data_management_compute_target=None, data_management_compute_auth=None, ttl_in_days=None, ttl_expiration_policy=None, default_replica_count=None, data_factory_resource_id=None, **kwargs)

Parameters

workspace

Workspace

Required

The workspace.

name

str

Required

The name of the datacachestore.

data_management_compute_target

ComputeTarget

default value: None

The data management compute.

data_management_compute_auth

ServicePrincipalAuthentication

default value: None

The service principal used to submit data management jobs to data management compute.

ttl_in_days

<xref:Int>

default value: None

Time-To-Live in days.

ttl_expiration_policy

str, <xref:one> of [<xref:"LastAccessTime">, <xref:"CreationTime">]

default value: None

TTL expire policy.

default_replica_count

<xref:Int>

default value: None

Default number of replicas to hydrate.

data_factory_resource_id

<xref:str.>

default value: None

Resource id of the ADF to be used for hydration.

Returns

The DatacacheStore object

Return type

DatacacheStore

Attributes

data_factory_resource_id

Return the resource id of the Azure data factory which can be used for hydration.

Returns

Resource id of the ADF to be used for hydration.

Return type

str

data_management_compute_target

Return the name of the data management compute to be used for hydration.

Returns

The data management compute.

Return type

str

data_store_list

Return the list of underlying datastores for the datacachestores.

Returns

The list of datastores to be used as datacachestores.

Return type

list(<xref:AbstractDataStore>)

default_replica_count

Return the default number of replicas during hydration.

Returns

Default number of replicas to hydrate.

Return type

<xref:Int>

name

Return the name of the datacache store.

Returns

The DatacacheStore name.

Return type

str

ttl_expiration_policy

Return the Time-to-live expiration policy.

Returns

TTL expire policy.

Return type

str

ttl_in_days

Return the Time-to-live policy.

Returns

Time-To-Live in days.

Return type

<xref:Int>

workspace

Return the workspace information.

Returns

The workspace.

Return type

Workspace