Microsoft.MachineLearningServices workspaces/computes
- Latest
- 2022-05-01
- 2022-02-01-preview
- 2022-01-01-preview
- 2021-07-01
- 2021-04-01
- 2021-03-01-preview
- 2021-01-01
- 2020-09-01-preview
- 2020-08-01
- 2020-06-01
- 2020-05-15-preview
- 2020-05-01-preview
- 2020-04-01
- 2020-03-01
- 2020-02-18-preview
- 2020-01-01
- 2019-11-01
- 2019-06-01
- 2019-05-01
- 2018-11-19
- 2018-03-01-preview
The workspaces/computes resource type can be deployed to: Resource groups.
To learn about resource group deployments, see Bicep or ARM template.
For a list of changed properties in each API version, see change log.
Template format
To create a Microsoft.MachineLearningServices/workspaces/computes resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/computes@2022-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
description: 'string'
disableLocalAuth: bool
resourceId: 'string'
computeType: 'string'
// For remaining properties, see Compute objects
}
}
Compute objects
Set the computeType property to specify the type of object.
For AKS, use:
For AmlCompute, use:
For ComputeInstance, use:
For Databricks, use:
For DataFactory, use:
For DataLakeAnalytics, use:
For HDInsight, use:
For Kubernetes, use:
For SynapseSpark, use:
computeType: 'SynapseSpark'
properties: {
autoPauseProperties: {
delayInMinutes: int
enabled: bool
}
autoScaleProperties: {
enabled: bool
maxNodeCount: int
minNodeCount: int
}
nodeCount: int
nodeSize: 'string'
nodeSizeFamily: 'string'
poolName: 'string'
resourceGroup: 'string'
sparkVersion: 'string'
subscriptionId: 'string'
workspaceName: 'string'
}
For VirtualMachine, use:
Property values
workspaces/computes
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.MachineLearningServices/workspaces/computes' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2022-05-01' |
| name | The resource name See how to set names and types for child resources in Bicep or JSON ARM templates. |
string (required) Character limit: 2-16 Valid characters: Alphanumerics and hyphens. |
| 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 | The sku of the workspace. | Sku |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workspaces |
| identity | The identity of the resource. | ManagedServiceIdentity |
| properties | Compute properties | Compute |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | object |
Compute
| Name | Description | Value |
|---|---|---|
| description | The description of the Machine Learning compute. | string |
| disableLocalAuth | Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. | bool |
| resourceId | ARM resource id of the underlying compute | string |
| computeType | Set the object type | AKS AmlCompute ComputeInstance Databricks DataFactory DataLakeAnalytics HDInsight Kubernetes SynapseSpark VirtualMachine |
AKS
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'AKS' |
AmlCompute
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'AmlCompute' |
ComputeInstance
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'ComputeInstance' |
Databricks
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'Databricks' |
DataFactory
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'DataFactory' |
DataLakeAnalytics
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'DataLakeAnalytics' |
HDInsight
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'HDInsight' |
Kubernetes
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'Kubernetes' |
SynapseSpark
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'SynapseSpark' |
| properties | SynapseSparkProperties |
SynapseSparkProperties
| Name | Description | Value |
|---|---|---|
| autoPauseProperties | Auto pause properties. | AutoPauseProperties |
| autoScaleProperties | Auto scale properties. | AutoScaleProperties |
| nodeCount | The number of compute nodes currently assigned to the compute. | int |
| nodeSize | Node size. | string |
| nodeSizeFamily | Node size family. | string |
| poolName | Pool name. | string |
| resourceGroup | Name of the resource group in which workspace is located. | string |
| sparkVersion | Spark version. | string |
| subscriptionId | Azure subscription identifier. | string |
| workspaceName | Name of Azure Machine Learning workspace. | string |
AutoPauseProperties
| Name | Description | Value |
|---|---|---|
| delayInMinutes | int | |
| enabled | bool |
AutoScaleProperties
| Name | Description | Value |
|---|---|---|
| enabled | bool | |
| maxNodeCount | int | |
| minNodeCount | int |
VirtualMachine
| Name | Description | Value |
|---|---|---|
| computeType | The type of compute | 'VirtualMachine' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a Machine Learning Service ADLA Compute. |
This template creates a Machine Learning Service ADLA Compute. |
| Create a Machine Learning Service Aks Compute. |
This template creates a Machine Learning Service Aks Compute. |
| Create a Machine Learning Service DSVM Compute. |
This template creates a Machine Learning Service DSVM Compute. |
| Create a Machine Learning Service HDInsight cluster |
This template creates a Machine Learning Service HDInsight cluster |
| Create an Azure Machine Learning aks compute. |
This template creates an Azure Machine Learning aks compute. |
| Create an Azure Machine Learning compute cluster. |
This template creates an Azure Machine Learning compute cluster. |
| Create an Azure Machine Learning compute instance |
This template creates an Azure Machine Learning compute instance on behalf of another user with a sample inline setup script |
| Create a LinkedService in Azure Machine Learning workspace. |
This template creates a LinkedService in an existing Azure Machine Learning workspace. |
| Create an AKS compute target with a Private IP address. |
This template creates an AKS compute target in given Azure Machine Learning service workspace with a private IP address. |