Share via

KustoCompute Class

Manages a Kusto compute target in Azure Machine Learning.

Kusto, also known as Azure Data Explorer, can be used as a compute target with an Azure Machine Learning pipeline. The compute target holds the Kusto connection string and service principal credentials used to access the target Kusto cluster.

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.

Constructor

KustoCompute(workspace, name)

Parameters

Name Description
workspace
Required
Workspace

The workspace object containing the KustoCompute object to retrieve.
name
Required
str

The name of the KustoCompute object to retrieve.
workspace
Required
Workspace

The workspace object containing the Compute object to retrieve.
name
Required
str

The name of the of the Compute object to retrieve.

Methods

attach_configuration

Create a configuration object for attaching a Kusto compute target.
delete

Delete is not supported for a KustoCompute object. Use detach instead.
deserialize

Convert a JSON object into a KustoCompute object.
detach

Detaches the Kusto object from its associated workspace.

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

Retrieve the credentials for the Kusto 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 KustoCompute object into a JSON serialized dictionary.

attach_configuration

Create a configuration object for attaching a Kusto compute target.

static attach_configuration(resource_group=None, workspace_name=None, resource_id=None, tenant_id=None, kusto_connection_string=None, application_id=None, application_key=None)

Parameters

Name Description
resource_group
str

The name of the resource group of the workspace.

Default value: None
workspace_name
str

The workspace name.

Default value: None
resource_id
str

The Azure resource ID of the compute resource.

Default value: None
tenant_id
str

The tenant ID of the compute resource.

Default value: None
kusto_connection_string
str

The connection string of the Kusto cluster.

Default value: None
application_id
str

The application ID of the compute resource.

Default value: None
application_key
str

The application key of the compute resource.

Default value: None

Returns

Type Description
KustoAttachConfiguration

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

delete

Delete is not supported for a KustoCompute object. Use detach instead.

delete()

Exceptions

Type Description
ComputeTargetException

deserialize

Convert a JSON object into a KustoCompute object.

static deserialize(workspace, object_dict)

Parameters

Name Description
workspace
Required
Workspace

The workspace object the KustoCompute object is associated with.
object_dict
Required
dict

A JSON object to convert to a KustoCompute object.

Returns

Type Description
KustoCompute

The KustoCompute representation of the provided JSON object.

Exceptions

Type Description
ComputeTargetException

Remarks

Raises a ComputeTargetException if the provided workspace is not the workspace the Compute is associated with.

detach

Detaches the Kusto object from its associated workspace.

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

detach()

Exceptions

Type Description
ComputeTargetException

get_credentials

Retrieve the credentials for the Kusto target.

get_credentials()

Returns

Type Description
dict[str, dict[str, str]]

The credentials for the Kusto target.

Exceptions

Type Description
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()

serialize

Convert this KustoCompute object into a JSON serialized dictionary.

serialize()

Returns

Type Description
dict

The JSON representation of this KustoCompute object.