workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.ml_services.workspaces

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

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)
kind	string
location	string
properties	object	Additional attributes of the entity.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

The request was successful; the request was well-formed and received properly.

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)
kind	string
location	string
properties	object	Additional attributes of the entity.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

The request was successful; the request was well-formed and received properly.

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)
kind	string
location	string
properties	object	Additional attributes of the entity.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName
list_by_resource_group	select	subscriptionId, resourceGroupName	kind, $skip, aiCapabilities
list_by_subscription	select	subscriptionId	kind, $skip, aiCapabilities
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, data__properties
update	update	subscriptionId, resourceGroupName, workspaceName
delete	delete	subscriptionId, resourceGroupName, workspaceName	forceToPurge
diagnose	exec	subscriptionId, resourceGroupName, workspaceName
prepare_notebook	exec	subscriptionId, resourceGroupName, workspaceName
resync_keys	exec	subscriptionId, resourceGroupName, workspaceName

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	Azure Machine Learning Workspace Name
$skip	string	Continuation token for pagination.
aiCapabilities	string
forceToPurge	boolean	Flag to indicate delete is a purge request.
kind	string	Kind of workspace.

SELECT examples

get

The request was successful; the request was well-formed and received properly.

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

list_by_resource_group

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.ml_services.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND kind = '{{ kind }}'
AND $skip = '{{ $skip }}'
AND aiCapabilities = '{{ aiCapabilities }}'
;

list_by_subscription

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.ml_services.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND kind = '{{ kind }}'
AND $skip = '{{ $skip }}'
AND aiCapabilities = '{{ aiCapabilities }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.workspaces (
data__identity,
data__kind,
data__location,
data__properties,
data__sku,
data__tags,
subscriptionId,
resourceGroupName,
workspaceName
)
SELECT 
'{{ identity }}',
'{{ kind }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ sku }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: kind
      value: string
    - name: location
      value: string
    - name: properties
      value: object
      description: |
        Additional attributes of the entity.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: tags
      value: object

UPDATE examples

update

No description available.

UPDATE azure.ml_services.workspaces
SET 
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND forceToPurge = '{{ forceToPurge }}'
;

Lifecycle Methods

diagnose

The request was successful; the request was well-formed and received properly.

EXEC azure.ml_services.workspaces.diagnose 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required 
@@json=
'{
"value": "{{ value }}"
}'
;

prepare_notebook

The request was successful; the request was well-formed and received properly.

EXEC azure.ml_services.workspaces.prepare_notebook 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required
;

resync_keys

Success

EXEC azure.ml_services.workspaces.resync_keys 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required
;