Microsoft.MachineLearningServices workspaces 2020-05-01-preview

The workspaces resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.MachineLearningServices/workspaces resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces@2020-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    allowPublicAccessWhenBehindVnet: bool
    applicationInsights: 'string'
    containerRegistry: 'string'
    description: 'string'
    discoveryUrl: 'string'
    encryption: {
      keyVaultProperties: {
        identityClientId: 'string'
        keyIdentifier: 'string'
        keyVaultArmId: 'string'
      }
      status: 'string'
    }
    friendlyName: 'string'
    hbiWorkspace: bool
    imageBuildCompute: 'string'
    keyVault: 'string'
    sharedPrivateLinkResources: [
      {
        name: 'string'
        properties: {
          groupId: 'string'
          privateLinkResourceId: 'string'
          requestMessage: 'string'
          status: 'string'
        }
      }
    ]
    storageAccount: 'string'
  }
}

Property values

workspaces

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.MachineLearningServices/workspaces'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-05-01-preview'
name The resource name string (required)
location Specifies the location of the resource. string
tags Contains resource tags defined as key/value pairs. Dictionary of tag names and values. See Tags in templates
sku Sku of the resource Sku
identity Identity for the resource. Identity
properties The properties of a machine learning workspace. WorkspaceProperties

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities dictionary containing all the user assigned identities, with resourceId of the UAI as key. object

WorkspaceProperties

Name Description Value
allowPublicAccessWhenBehindVnet The flag to indicate whether to allow public access when behind VNet. bool
applicationInsights ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created string
containerRegistry ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created string
description The description of this workspace. string
discoveryUrl Url for the discovery service to identify regional endpoints for machine learning experimentation services string
encryption EncryptionProperty
friendlyName The friendly name for this workspace. This name in mutable string
hbiWorkspace The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service bool
imageBuildCompute The compute name for image build string
keyVault ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created string
sharedPrivateLinkResources The list of shared private link resources in this workspace. SharedPrivateLinkResource[]
storageAccount ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created string

EncryptionProperty

Name Description Value
keyVaultProperties KeyVaultProperties (required)
status Indicates whether or not the encryption is enabled for the workspace. 'Disabled'
'Enabled'

KeyVaultProperties

Name Description Value
identityClientId For future use - The client id of the identity which will be used to access key vault. string
keyIdentifier Key vault uri to access the encryption key. string (required)
keyVaultArmId The ArmId of the keyVault where the customer owned encryption key is present. string (required)

SharedPrivateLinkResource

Name Description Value
name Unique name of the private link. string
properties Properties of a shared private link resource. SharedPrivateLinkResourceProperty

SharedPrivateLinkResourceProperty

Name Description Value
groupId The private link resource group id. string
privateLinkResourceId The resource id that private link links to. string
requestMessage Request message. string
status The private endpoint connection status. 'Approved'
'Disconnected'
'Pending'
'Rejected'
'Timeout'

Sku

Name Description Value
name Name of the sku string
tier Tier of the sku like Basic or Enterprise string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Machine Learning Workspace

Deploy to Azure
This template creates a new Azure Machine Learning Workspace, along with an encrypted Storage Account, KeyVault and Applications Insights Logging
Advanced template for Azure Machine Learning workspace

Deploy to Azure
A template that creates Azure Machine Learning workspace with private endpoints and resources behind VNET
Create an Azure Machine Learning service workspace.

Deploy to Azure
This template creates an Azure Machine Learning service workspace.
Create AML workspace with multiple Datasets & Datastores

Deploy to Azure
This template creates Azure Machine Learning workspace with multiple datasets & datastores.
Enable encryption at rest for Azure Machine Learning

Deploy to Azure
A template that creates a new Azure Machine Learning workspace. Optionally, you can enable encryption for data at rest in the workspace, and data stored by the workspace in Azure Cosmos DB.
Create an AKS compute target with a Private IP address.

Deploy to Azure
This template creates an AKS compute target in given Azure Machine Learning service workspace with a private IP address.