Microsoft.MachineLearningServices workspaces 2019-05-01

Bicep resource definition

The workspaces resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.MachineLearningServices/workspaces@2019-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'SystemAssigned'
  }
  properties: {
    applicationInsights: 'string'
    containerRegistry: 'string'
    description: 'string'
    discoveryUrl: 'string'
    friendlyName: 'string'
    keyVault: 'string'
    storageAccount: 'string'
  }
}

Property values

workspaces

Name Description Value
name The resource name string (required)

Character limit: 3-33

Valid characters:
Alphanumerics, hyphens, and underscores.
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
identity The identity of the resource. Identity
properties The properties of the machine learning workspace. WorkspaceProperties

Identity

Name Description Value
type The identity type. 'SystemAssigned'

WorkspaceProperties

Name Description Value
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
friendlyName The friendly name for this workspace. This name in mutable string
keyVault ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created string
storageAccount ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created 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
Create AML workspace with multiple Datasets & Datastores

Deploy to Azure
This template creates Azure Machine Learning workspace with multiple datasets & datastores.
Azure Machine Learning end-to-end secure setup

Deploy to Azure
This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)

Deploy to Azure
This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
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.
Create an Azure Machine Learning service workspace

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the minimal set of resources you require to get started with Azure Machine Learning.
Create an Azure Machine Learning service workspace (CMK)

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. The example shows how to configure Azure Machine Learning for encryption with a customer-managed encryption key.
Create an Azure Machine Learning service workspace (vnet)

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Machine Learning service workspace (legacy)

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.

ARM template resource definition

The workspaces resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.MachineLearningServices/workspaces",
  "apiVersion": "2019-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "applicationInsights": "string",
    "containerRegistry": "string",
    "description": "string",
    "discoveryUrl": "string",
    "friendlyName": "string",
    "keyVault": "string",
    "storageAccount": "string"
  }
}

Property values

workspaces

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces'
apiVersion The resource api version '2019-05-01'
name The resource name string (required)

Character limit: 3-33

Valid characters:
Alphanumerics, hyphens, and underscores.
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
identity The identity of the resource. Identity
properties The properties of the machine learning workspace. WorkspaceProperties

Identity

Name Description Value
type The identity type. 'SystemAssigned'

WorkspaceProperties

Name Description Value
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
friendlyName The friendly name for this workspace. This name in mutable string
keyVault ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created string
storageAccount ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created 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
Create AML workspace with multiple Datasets & Datastores

Deploy to Azure
This template creates Azure Machine Learning workspace with multiple datasets & datastores.
Azure Machine Learning end-to-end secure setup

Deploy to Azure
This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)

Deploy to Azure
This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
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.
Create an Azure Machine Learning service workspace

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the minimal set of resources you require to get started with Azure Machine Learning.
Create an Azure Machine Learning service workspace (CMK)

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. The example shows how to configure Azure Machine Learning for encryption with a customer-managed encryption key.
Create an Azure Machine Learning service workspace (vnet)

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.
Create an Azure Machine Learning service workspace (legacy)

Deploy to Azure
This deployment template specifies an Azure Machine Learning workspace, and its associated resources including Azure Key Vault, Azure Storage, Azure Application Insights and Azure Container Registry. This configuration describes the set of resources you require to get started with Azure Machine Learning in a network isolated set up.

Terraform (AzAPI provider) resource definition

The workspaces resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces@2019-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      applicationInsights = "string"
      containerRegistry = "string"
      description = "string"
      discoveryUrl = "string"
      friendlyName = "string"
      keyVault = "string"
      storageAccount = "string"
    }
  })
}

Property values

workspaces

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces@2019-05-01"
name The resource name string (required)

Character limit: 3-33

Valid characters:
Alphanumerics, hyphens, and underscores.
location Specifies the location of the resource. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Contains resource tags defined as key/value pairs. Dictionary of tag names and values.
identity The identity of the resource. Identity
properties The properties of the machine learning workspace. WorkspaceProperties

Identity

Name Description Value
type The identity type. "SystemAssigned"

WorkspaceProperties

Name Description Value
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
friendlyName The friendly name for this workspace. This name in mutable string
keyVault ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created string
storageAccount ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created string