DataFactoryCompute Class

Manages a DataFactory compute target in Azure Machine Learning.

Azure Data Factory is Azure's cloud ETL service for scale-out serverless data integration and data transformation. For more information, see Azure Data Factory.

Class ComputeTarget constructor.

Retrieve a cloud representation of a Compute object associated with the provided workspace. Returns an instance of a child class corresponding to the specific type of the retrieved Compute object.

Inheritance

ComputeTarget

DataFactoryCompute

Constructor

DataFactoryCompute(workspace, name)

Parameters

workspace

Workspace

Required

The workspace object containing the DataFactoryCompute object to retrieve.

name

str

Required

The name of the DataFactoryCompute object to retrieve.

workspace

Workspace

Required

The workspace object containing the Compute object to retrieve.

name

str

Required

The name of the of the Compute object to retrieve.

Methods

attach	DEPRECATED. Use the attach_configuration method instead. Associate an existing DataFactory compute resource with the provided workspace.
attach_configuration	Create a configuration object for attaching a DataFactory compute target.
delete	Remove the DatafactoryCompute object from its associated workspace.
deserialize	Convert a JSON object into a DataFactoryCompute object.
detach	Detach the Datafactory object from its associated workspace. Underlying cloud objects are not deleted, only the association is removed.
provisioning_configuration	Create a configuration object for provisioning a DataFactoryCompute target.
refresh_state	Perform an in-place update of the properties of the object. This method updates the properties based on the current state of the corresponding cloud object. This is primarily used for manual polling of compute state.
serialize	Convert this DataFactoryCompute object into a JSON serialized dictionary.

attach

DEPRECATED. Use the attach_configuration method instead.

Associate an existing DataFactory compute resource with the provided workspace.

static attach(workspace, name, resource_id)

Parameters

workspace

Workspace

Required

The workspace object to associate the compute resource with.

name

str

Required

The name to associate with the compute resource inside the provided workspace. Does not have to match the name of the compute resource to be attached.

resource_id

str

Required

The Azure resource ID for the compute resource being attached.

Returns

A DataFactoryCompute object representation of the compute object.

Return type

DataFactoryCompute

Exceptions

ComputeTargetException

attach_configuration

Create a configuration object for attaching a DataFactory compute target.

static attach_configuration(resource_group=None, factory_name=None, resource_id=None)

Parameters

resource_group

str

default value: None

The name of the resource group in which the DataFactory is located.

factory_name

str

default value: None

The DataFactory name.

resource_id

str

default value: None

The Azure resource ID for the compute resource being attached.

Returns

A configuration object to be used when attaching a Compute object.

Return type

DataFactoryAttachConfiguration

Exceptions

ComputeTargetException

delete

Remove the DatafactoryCompute object from its associated workspace.

delete()

Exceptions

ComputeTargetException

Remarks

If this object was created through Azure ML, the corresponding cloud based objects will also be deleted. If this object was created externally and only attached to the workspace, it will raise exception and nothing will be changed.

deserialize

Convert a JSON object into a DataFactoryCompute object.

static deserialize(workspace, object_dict)

Parameters

workspace

Workspace

Required

The workspace object the DataFactoryCompute object is associated with.

object_dict

dict

Required

A JSON object to convert to a DataFactoryCompute object.

Returns

The DataFactoryCompute representation of the provided json object.

Return type

DataFactoryCompute

Exceptions

ComputeTargetException

Remarks

Will fail if the provided workspace is not the workspace the Compute is associated with.

detach

Detach the Datafactory object from its associated workspace.

Underlying cloud objects are not deleted, only the association is removed.

detach()

Exceptions

ComputeTargetException

provisioning_configuration

Create a configuration object for provisioning a DataFactoryCompute target.

static provisioning_configuration(location=None)

Parameters

location

str

default value: None

The location to provision cluster in. If not specified, will default to workspace location. Available regions for this compute can be found here: https://azure.microsoft.com/global-infrastructure/services/?regions=all&products=data-factory

Returns

A configuration object to be used when creating a Compute object.

Return type

DataFactoryProvisioningConfiguration

Exceptions

ComputeTargetException

refresh_state

Perform an in-place update of the properties of the object.

This method updates the properties based on the current state of the corresponding cloud object. This is primarily used for manual polling of compute state.

refresh_state()

Exceptions

ComputeTargetException

serialize

Convert this DataFactoryCompute object into a JSON serialized dictionary.

serialize()

Returns

The JSON representation of this DataFactoryCompute object.

Return type

dict

Exceptions

ComputeTargetException