Microsoft.MachineLearningServices workspaces

Template format

To create a Microsoft.MachineLearningServices/workspaces resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.MachineLearningServices/workspaces",
  "apiVersion": "2020-08-01",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "location": "string",
  "tags": {},
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "description": "string",
    "friendlyName": "string",
    "keyVault": "string",
    "applicationInsights": "string",
    "containerRegistry": "string",
    "storageAccount": "string",
    "discoveryUrl": "string",
    "encryption": {
      "status": "string",
      "keyVaultProperties": {
        "keyVaultArmId": "string",
        "keyIdentifier": "string",
        "identityClientId": "string"
      }
    },
    "hbiWorkspace": "boolean",
    "imageBuildCompute": "string",
    "allowPublicAccessWhenBehindVnet": "boolean",
    "sharedPrivateLinkResources": [
      {
        "name": "string",
        "properties": {
          "privateLinkResourceId": "string",
          "groupId": "string",
          "requestMessage": "string",
          "status": "string"
        }
      }
    ]
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.MachineLearningServices/workspaces object

Name Type Required Value
name string Yes Name of Azure Machine Learning workspace.
type enum Yes Microsoft.MachineLearningServices/workspaces
apiVersion enum Yes 2020-08-01
identity object No The identity of the resource. - Identity object
location string No Specifies the location of the resource.
tags object No Contains resource tags defined as key/value pairs.
sku object No The sku of the workspace. - Sku object
properties object Yes The properties of the machine learning workspace. - WorkspaceProperties object
resources array No privateEndpointConnections computes connections

Identity object

Name Type Required Value
type enum Yes The identity type. - SystemAssigned, UserAssigned, SystemAssigned,UserAssigned, None
userAssignedIdentities object No The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Sku object

Name Type Required Value
name string No Name of the sku
tier string No Tier of the sku like Basic or Enterprise

WorkspaceProperties object

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

EncryptionProperty object

Name Type Required Value
status enum Yes Indicates whether or not the encryption is enabled for the workspace. - Enabled or Disabled
keyVaultProperties object Yes Customer Key vault properties. - KeyVaultProperties object

SharedPrivateLinkResource object

Name Type Required Value
name string No Unique name of the private link.
properties object No Resource properties. - SharedPrivateLinkResourceProperty object

KeyVaultProperties object

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

SharedPrivateLinkResourceProperty object

Name Type Required Value
privateLinkResourceId string No The resource id that private link links to.
groupId string No The private link resource group id.
requestMessage string No Request message.
status enum No Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. - Pending, Approved, Rejected, Disconnected, Timeout

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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.
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
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.