computes

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

Overview

Name	computes
Type	Resource
Id	azure.ml_services.computes

Fields

vw_computes

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
description	text	field from the properties object
computeName	text	field from the properties object
compute_location	text	field from the properties object
compute_type	text	field from the properties object
created_on	text	field from the properties object
disable_local_auth	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
is_attached_compute	text	field from the properties object
location	text	Specifies the location of the resource.
modified_on	text	field from the properties object
provisioning_errors	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_id	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Contains resource tags defined as key/value pairs.
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
workspaceName	text	field from the properties object

computes

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	Specifies the location of the resource.
properties	object	Machine Learning compute object.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Contains resource tags defined as key/value pairs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	computeName, resourceGroupName, subscriptionId, workspaceName	Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
list	SELECT	resourceGroupName, subscriptionId, workspaceName	Gets computes in specified workspace.
create_or_update	INSERT	computeName, resourceGroupName, subscriptionId, workspaceName	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	computeName, resourceGroupName, subscriptionId, underlyingResourceAction, workspaceName	Deletes specified Machine Learning compute.
update	UPDATE	computeName, resourceGroupName, subscriptionId, workspaceName	Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
resize	EXEC	computeName, resourceGroupName, subscriptionId, workspaceName	Updates the size of a Compute Instance.
restart	EXEC	computeName, resourceGroupName, subscriptionId, workspaceName	Posts a restart action to a compute instance
start	EXEC	computeName, resourceGroupName, subscriptionId, workspaceName	Posts a start action to a compute instance
stop	EXEC	computeName, resourceGroupName, subscriptionId, workspaceName	Posts a stop action to a compute instance

SELECT examples

Gets computes in specified workspace.

vw_computes

SELECT
id,
name,
description,
computeName,
compute_location,
compute_type,
created_on,
disable_local_auth,
identity,
is_attached_compute,
location,
modified_on,
provisioning_errors,
provisioning_state,
resourceGroupName,
resource_id,
sku,
subscriptionId,
system_data,
tags,
type,
workspaceName
FROM azure.ml_services.vw_computes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

computes

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.ml_services.computes
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

Use the following StackQL query and manifest file to create a new computes resource.

All Properties

/*+ create */
INSERT INTO azure.ml_services.computes (
computeName,
resourceGroupName,
subscriptionId,
workspaceName,
properties,
identity,
location,
tags,
sku
)
SELECT 
'{{ computeName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}',
'{{ identity }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: computeType
          value: []
        - name: computeLocation
          value: string
        - name: provisioningState
          value: string
        - name: description
          value: string
        - name: createdOn
          value: string
        - name: modifiedOn
          value: string
        - name: resourceId
          value: string
        - name: provisioningErrors
          value:
            - - name: error
                value:
                  - name: code
                    value: string
                  - name: message
                    value: string
                  - name: target
                    value: string
                  - name: details
                    value:
                      - - name: code
                          value: string
                        - name: message
                          value: string
                        - name: target
                          value: string
                        - name: details
                          value:
                            - - name: code
                                value: string
                              - name: message
                                value: string
                              - name: target
                                value: string
                              - name: details
                                value:
                                  - - name: code
                                      value: string
                                    - name: message
                                      value: string
                                    - name: target
                                      value: string
                                    - name: details
                                      value:
                                        - - name: code
                                            value: string
                                          - name: message
                                            value: string
                                          - name: target
                                            value: string
                                          - name: details
                                            value:
                                              - - name: code
                                                  value: string
                                                - name: message
                                                  value: string
                                                - name: target
                                                  value: string
                                                - name: details
                                                  value:
                                                    - - name: code
                                                        value: string
                                                      - name: message
                                                        value: string
                                                      - name: target
                                                        value: string
                                                      - name: details
                                                        value:
                                                          - - name: code
                                                              value: string
                                                            - name: message
                                                              value: string
                                                            - name: target
                                                              value: string
                                                            - name: details
                                                              value:
                                                                - []
                                                            - name: additionalInfo
                                                              value:
                                                                - []
                                                      - name: additionalInfo
                                                        value:
                                                          - - name: type
                                                              value: string
                                                            - name: info
                                                              value: object
                                                - name: additionalInfo
                                                  value:
                                                    - - name: type
                                                        value: string
                                                      - name: info
                                                        value: object
                                          - name: additionalInfo
                                            value:
                                              - - name: type
                                                  value: string
                                                - name: info
                                                  value: object
                                    - name: additionalInfo
                                      value:
                                        - - name: type
                                            value: string
                                          - name: info
                                            value: object
                              - name: additionalInfo
                                value:
                                  - - name: type
                                      value: string
                                    - name: info
                                      value: object
                        - name: additionalInfo
                          value:
                            - - name: type
                                value: string
                              - name: info
                                value: object
                  - name: additionalInfo
                    value:
                      - - name: type
                          value: string
                        - name: info
                          value: object
        - name: isAttachedCompute
          value: boolean
        - name: disableLocalAuth
          value: boolean
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: location
      value: string
    - name: tags
      value: object
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer

UPDATE example

Updates a computes resource.

/*+ update */
UPDATE azure.ml_services.computes
SET 
properties = '{{ properties }}'
WHERE 
computeName = '{{ computeName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified computes resource.

/*+ delete */
DELETE FROM azure.ml_services.computes
WHERE computeName = '{{ computeName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND underlyingResourceAction = '{{ underlyingResourceAction }}'
AND workspaceName = '{{ workspaceName }}';