SynapseCompute Class
Note
This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.
Manages an Synapse compute target in Azure Machine Learning. Currently it only supports spark.
Azure Synapse is an integrated analytics service that accelerates time to insight across data warehouses and big data analytics systems. At its core, Azure Synapse brings together the best of SQL technologies used in enterprise data warehousing, Spark technologies used for big data, and Pipelines for data integration and ETL/ELT. For more information, see What is an Synapse spark pool instance?.
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
SynapseCompute(workspace, name)Parameters
| Name | Description |
|---|---|
|
workspace
Required
|
The workspace object containing the Compute object to retrieve. |
|
name
Required
|
The name of the of the Compute object to retrieve. |
Methods
| attach_configuration |
Create a configuration object for attaching an Synapse compute target. |
| delete |
Delete is not supported for Synapse object. Try to use detach instead. |
| deserialize |
Convert a json object into a SynapseCompute object. Will fail if the provided workspace is not the workspace the Compute is associated with. |
| detach |
Detaches the Synapse object from its associated workspace. |
| refresh_state |
Perform an in-place update of the properties of the object. Based on the current state of the corresponding cloud object. Primarily useful for manual polling of compute state. |
| serialize |
Convert this SynapseCompute object into a json serialized dictionary. |
attach_configuration
Create a configuration object for attaching an Synapse compute target.
static attach_configuration(linked_service, type, pool_name)Parameters
| Name | Description |
|---|---|
|
linked_service
Required
|
You must link the synapse workspace first and then you can attach the spark pools within the synapse workspace into AML. |
|
type
Required
|
compute target type, currently only support SynapseSpark. |
|
pool_name
Required
|
Name synapse spark pool |
delete
Delete is not supported for Synapse object. Try to use detach instead.
delete()Exceptions
| Type | Description |
|---|---|
deserialize
Convert a json object into a SynapseCompute object.
Will fail if the provided workspace is not the workspace the Compute is associated with.
static deserialize(workspace, object_dict)Parameters
| Name | Description |
|---|---|
|
workspace
Required
|
The workspace object the SynapseCompute object is associated with. |
|
object_dict
Required
|
A json object to convert to a SynapseCompute object. |
Returns
| Type | Description |
|---|---|
|
The SynapseCompute representation of the provided json object. |
Exceptions
| Type | Description |
|---|---|
detach
Detaches the Synapse object from its associated workspace.
detach()Exceptions
| Type | Description |
|---|---|
Remarks
No underlying cloud object will be deleted, the association will just be removed.
refresh_state
Perform an in-place update of the properties of the object.
Based on the current state of the corresponding cloud object.
Primarily useful for manual polling of compute state.
refresh_state()serialize
Convert this SynapseCompute object into a json serialized dictionary.
serialize()Returns
| Type | Description |
|---|---|
|
The json representation of this SynapseCompute object |