machine_learning_compute

Creates, updates, deletes, gets or lists a machine_learning_compute resource.

Overview

Name	machine_learning_compute
Type	Resource
Id	azure.machine_learning_services.machine_learning_compute

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
computeLocation	string	Location for the underlying compute.
computeType	string	The type of compute. Required. Known values are: "AKS", "AmlCompute", "ComputeInstance", "DataFactory", "VirtualMachine", "HDInsight", "Databricks", and "DataLakeAnalytics".
createdOn	string (date-time)	The date and time when the compute was created.
description	string	The description of the Machine Learning compute.
identity	object	The identity of the resource.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
location	string	Specifies the location of the resource.
modifiedOn	string (date-time)	The date and time when the compute was last modified.
provisioningErrors	array	Errors during provisioning.
provisioningState	string	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
resourceId	string	ARM resource id of the underlying compute.
sku	object	The sku of the workspace.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

list_by_workspace

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
computeLocation	string	Location for the underlying compute.
computeType	string	The type of compute. Required. Known values are: "AKS", "AmlCompute", "ComputeInstance", "DataFactory", "VirtualMachine", "HDInsight", "Databricks", and "DataLakeAnalytics".
createdOn	string (date-time)	The date and time when the compute was created.
description	string	The description of the Machine Learning compute.
identity	object	The identity of the resource.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
location	string	Specifies the location of the resource.
modifiedOn	string (date-time)	The date and time when the compute was last modified.
provisioningErrors	array	Errors during provisioning.
provisioningState	string	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
resourceId	string	ARM resource id of the underlying compute.
sku	object	The sku of the workspace.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, compute_name, subscription_id		Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id	$skiptoken	Gets computes in specified workspace.
create_or_update	insert	resource_group_name, workspace_name, compute_name, subscription_id		Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.
update	update	resource_group_name, workspace_name, compute_name, subscription_id		Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
create_or_update	replace	resource_group_name, workspace_name, compute_name, subscription_id		Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.
delete	delete	resource_group_name, workspace_name, compute_name, subscription_id, underlyingResourceAction		Deletes specified Machine Learning compute.
list_nodes	exec	resource_group_name, workspace_name, compute_name, subscription_id		Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
list_keys	exec	resource_group_name, workspace_name, compute_name, subscription_id		Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
start	exec	resource_group_name, workspace_name, compute_name, subscription_id		Posts a start action to a compute instance.
stop	exec	resource_group_name, workspace_name, compute_name, subscription_id		Posts a stop action to a compute instance.
restart	exec	resource_group_name, workspace_name, compute_name, subscription_id		Posts a restart action to a compute instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compute_name	string	Name of the Azure Machine Learning compute. Required.
resource_group_name	string	Name of the resource group in which workspace is located. Required.
subscription_id	string
underlyingResourceAction	string	Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'. Known values are: "Delete" and "Detach". Required.
workspace_name	string	Name of Azure Machine Learning workspace. Required.
$skiptoken	string	Continuation token for pagination. Default value is None.

SELECT examples

get

Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.

SELECT
id,
name,
computeLocation,
computeType,
createdOn,
description,
identity,
isAttachedCompute,
location,
modifiedOn,
provisioningErrors,
provisioningState,
resourceId,
sku,
tags,
type
FROM azure.machine_learning_services.machine_learning_compute
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND compute_name = '{{ compute_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Gets computes in specified workspace.

SELECT
id,
name,
computeLocation,
computeType,
createdOn,
description,
identity,
isAttachedCompute,
location,
modifiedOn,
provisioningErrors,
provisioningState,
resourceId,
sku,
tags,
type
FROM azure.machine_learning_services.machine_learning_compute
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.

INSERT INTO azure.machine_learning_services.machine_learning_compute (
identity,
location,
tags,
sku,
properties,
resource_group_name,
workspace_name,
compute_name,
subscription_id
)
SELECT 
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ compute_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: machine_learning_compute
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the machine_learning_compute resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the machine_learning_compute resource.
  - name: compute_name
    value: "{{ compute_name }}"
    description: Required parameter for the machine_learning_compute resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the machine_learning_compute resource.
  - name: identity
    description: |
      The identity of the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: location
    value: "{{ location }}"
    description: |
      Specifies the location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Contains resource tags defined as key/value pairs.
  - name: sku
    description: |
      The sku of the workspace.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: properties
    description: |
      Compute properties.
    value:
      computeType: "{{ computeType }}"
      computeLocation: "{{ computeLocation }}"
      provisioningState: "{{ provisioningState }}"
      description: "{{ description }}"
      createdOn: "{{ createdOn }}"
      modifiedOn: "{{ modifiedOn }}"
      resourceId: "{{ resourceId }}"
      provisioningErrors:
        - error:
            code: "{{ code }}"
            message: "{{ message }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
      isAttachedCompute: {{ isAttachedCompute }}

UPDATE examples

update

Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.

UPDATE azure.machine_learning_services.machine_learning_compute
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND compute_name = '{{ compute_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.

REPLACE azure.machine_learning_services.machine_learning_compute
SET 
identity = '{{ identity }}',
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND compute_name = '{{ compute_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes specified Machine Learning compute.

DELETE FROM azure.machine_learning_services.machine_learning_compute
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND compute_name = '{{ compute_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND underlyingResourceAction = '{{ underlyingResourceAction }}' --required
;

Lifecycle Methods

list_nodes

Get the details (e.g IP address, port etc) of all the compute nodes in the compute.

EXEC azure.machine_learning_services.machine_learning_compute.list_nodes 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@compute_name='{{ compute_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_keys

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).

EXEC azure.machine_learning_services.machine_learning_compute.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@compute_name='{{ compute_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Posts a start action to a compute instance.

EXEC azure.machine_learning_services.machine_learning_compute.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@compute_name='{{ compute_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Posts a stop action to a compute instance.

EXEC azure.machine_learning_services.machine_learning_compute.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@compute_name='{{ compute_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restart

Posts a restart action to a compute instance.

EXEC azure.machine_learning_services.machine_learning_compute.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@compute_name='{{ compute_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;