workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.machine_learning_services.workspaces

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.
allowPublicAccessWhenBehindVnet	boolean	The flag to indicate whether to allow public access when behind VNet.
applicationInsights	string	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created.
containerRegistry	string	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created.
creationTime	string (date-time)	The creation time of the machine learning workspace in ISO8601 format.
description	string	The description of this workspace.
discoveryUrl	string	Url for the discovery service to identify regional endpoints for machine learning experimentation services.
encryption	object	The encryption settings of Azure ML workspace.
friendlyName	string	The friendly name for this workspace. This name in mutable.
hbiWorkspace	boolean	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.
identity	object	The identity of the resource.
imageBuildCompute	string	The compute name for image build.
keyVault	string	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created.
location	string	Specifies the location of the resource.
notebookInfo	object	The notebook info of Azure ML workspace.
privateEndpointConnections	array	The list of private endpoint connections in the workspace.
privateLinkCount	integer	Count of private connections in the workspace.
provisioningState	string	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
serviceProvisionedResourceGroup	string	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace.
sharedPrivateLinkResources	array	The list of shared private link resources in this workspace.
sku	object	The sku of the workspace.
storageAccount	string	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
workspaceId	string	The immutable id associated with this workspace.

list_by_resource_group

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
allowPublicAccessWhenBehindVnet	boolean	The flag to indicate whether to allow public access when behind VNet.
applicationInsights	string	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created.
containerRegistry	string	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created.
creationTime	string (date-time)	The creation time of the machine learning workspace in ISO8601 format.
description	string	The description of this workspace.
discoveryUrl	string	Url for the discovery service to identify regional endpoints for machine learning experimentation services.
encryption	object	The encryption settings of Azure ML workspace.
friendlyName	string	The friendly name for this workspace. This name in mutable.
hbiWorkspace	boolean	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.
identity	object	The identity of the resource.
imageBuildCompute	string	The compute name for image build.
keyVault	string	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created.
location	string	Specifies the location of the resource.
notebookInfo	object	The notebook info of Azure ML workspace.
privateEndpointConnections	array	The list of private endpoint connections in the workspace.
privateLinkCount	integer	Count of private connections in the workspace.
provisioningState	string	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
serviceProvisionedResourceGroup	string	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace.
sharedPrivateLinkResources	array	The list of shared private link resources in this workspace.
sku	object	The sku of the workspace.
storageAccount	string	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
workspaceId	string	The immutable id associated with this workspace.

list_by_subscription

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
allowPublicAccessWhenBehindVnet	boolean	The flag to indicate whether to allow public access when behind VNet.
applicationInsights	string	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created.
containerRegistry	string	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created.
creationTime	string (date-time)	The creation time of the machine learning workspace in ISO8601 format.
description	string	The description of this workspace.
discoveryUrl	string	Url for the discovery service to identify regional endpoints for machine learning experimentation services.
encryption	object	The encryption settings of Azure ML workspace.
friendlyName	string	The friendly name for this workspace. This name in mutable.
hbiWorkspace	boolean	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.
identity	object	The identity of the resource.
imageBuildCompute	string	The compute name for image build.
keyVault	string	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created.
location	string	Specifies the location of the resource.
notebookInfo	object	The notebook info of Azure ML workspace.
privateEndpointConnections	array	The list of private endpoint connections in the workspace.
privateLinkCount	integer	Count of private connections in the workspace.
provisioningState	string	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. Known values are: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", and "Canceled".
serviceProvisionedResourceGroup	string	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace.
sharedPrivateLinkResources	array	The list of shared private link resources in this workspace.
sku	object	The sku of the workspace.
storageAccount	string	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
workspaceId	string	The immutable id associated with this workspace.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, subscription_id		Gets the properties of the specified machine learning workspace.
list_by_resource_group	select	resource_group_name, subscription_id	$skiptoken	Lists all the available machine learning workspaces under the specified resource group.
list_by_subscription	select	subscription_id	$skiptoken	Lists all the available machine learning workspaces under the specified subscription.
create_or_update	insert	resource_group_name, workspace_name, subscription_id		Creates or updates a workspace with the specified parameters.
update	update	resource_group_name, workspace_name, subscription_id		Updates a machine learning workspace with the specified parameters.
create_or_update	replace	resource_group_name, workspace_name, subscription_id		Creates or updates a workspace with the specified parameters.
delete	delete	resource_group_name, workspace_name, subscription_id		Deletes a machine learning workspace.
list_keys	exec	resource_group_name, workspace_name, subscription_id		Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
resync_keys	exec	resource_group_name, workspace_name, subscription_id		Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

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
resource_group_name	string	Name of the resource group in which workspace is located. Required.
subscription_id	string
workspace_name	string	Name of Azure Machine Learning workspace. Required.
$skiptoken	string	Continuation token for pagination. Default value is None.

SELECT examples

get

Gets the properties of the specified machine learning workspace.

SELECT
id,
name,
allowPublicAccessWhenBehindVnet,
applicationInsights,
containerRegistry,
creationTime,
description,
discoveryUrl,
encryption,
friendlyName,
hbiWorkspace,
identity,
imageBuildCompute,
keyVault,
location,
notebookInfo,
privateEndpointConnections,
privateLinkCount,
provisioningState,
serviceProvisionedResourceGroup,
sharedPrivateLinkResources,
sku,
storageAccount,
tags,
type,
workspaceId
FROM azure.machine_learning_services.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the available machine learning workspaces under the specified resource group.

SELECT
id,
name,
allowPublicAccessWhenBehindVnet,
applicationInsights,
containerRegistry,
creationTime,
description,
discoveryUrl,
encryption,
friendlyName,
hbiWorkspace,
identity,
imageBuildCompute,
keyVault,
location,
notebookInfo,
privateEndpointConnections,
privateLinkCount,
provisioningState,
serviceProvisionedResourceGroup,
sharedPrivateLinkResources,
sku,
storageAccount,
tags,
type,
workspaceId
FROM azure.machine_learning_services.workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

list_by_subscription

Lists all the available machine learning workspaces under the specified subscription.

SELECT
id,
name,
allowPublicAccessWhenBehindVnet,
applicationInsights,
containerRegistry,
creationTime,
description,
discoveryUrl,
encryption,
friendlyName,
hbiWorkspace,
identity,
imageBuildCompute,
keyVault,
location,
notebookInfo,
privateEndpointConnections,
privateLinkCount,
provisioningState,
serviceProvisionedResourceGroup,
sharedPrivateLinkResources,
sku,
storageAccount,
tags,
type,
workspaceId
FROM azure.machine_learning_services.workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
;

INSERT examples

create_or_update

Creates or updates a workspace with the specified parameters.

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

Manifest

# Description fields are for documentation purposes
- name: workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspaces resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspaces 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
    value:
      description: "{{ description }}"
      friendlyName: "{{ friendlyName }}"
      keyVault: "{{ keyVault }}"
      applicationInsights: "{{ applicationInsights }}"
      containerRegistry: "{{ containerRegistry }}"
      storageAccount: "{{ storageAccount }}"
      discoveryUrl: "{{ discoveryUrl }}"
      encryption:
        status: "{{ status }}"
        keyVaultProperties:
          keyVaultArmId: "{{ keyVaultArmId }}"
          keyIdentifier: "{{ keyIdentifier }}"
          identityClientId: "{{ identityClientId }}"
      hbiWorkspace: {{ hbiWorkspace }}
      imageBuildCompute: "{{ imageBuildCompute }}"
      allowPublicAccessWhenBehindVnet: {{ allowPublicAccessWhenBehindVnet }}
      sharedPrivateLinkResources:
        - name: "{{ name }}"
          properties:
            privateLinkResourceId: "{{ privateLinkResourceId }}"
            groupId: "{{ groupId }}"
            requestMessage: "{{ requestMessage }}"
            status: "{{ status }}"

UPDATE examples

update

Updates a machine learning workspace with the specified parameters.

UPDATE azure.machine_learning_services.workspaces
SET 
tags = '{{ tags }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_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 a workspace with the specified parameters.

REPLACE azure.machine_learning_services.workspaces
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes a machine learning workspace.

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

Lifecycle Methods

list_keys

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

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

resync_keys

Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

EXEC azure.machine_learning_services.workspaces.resync_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;