Compute - Get
Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}?api-version=2023-10-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
compute
|
path | True |
string |
Name of the Azure Machine Learning compute. |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
Name of Azure Machine Learning workspace. Regex pattern: |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. |
|
Other Status Codes |
Error response describing why the request failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get a AKS Compute |
Get a AML Compute |
Get a Kubernetes Compute |
Get an Compute |
Get a AKS Compute
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2023-10-01
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus",
"properties": {
"createdOn": "2021-04-01T22:00:00.0000000+00:00",
"modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
"description": "some compute",
"resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
"computeType": "AKS",
"provisioningState": "Succeeded"
}
}
Get a AML Compute
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2023-10-01
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus2",
"properties": {
"description": "some compute",
"createdOn": "2021-04-01T22:00:00.0000000+00:00",
"modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
"computeType": "AmlCompute",
"provisioningState": "Succeeded",
"properties": {
"vmSize": "STANDARD_NC6",
"vmPriority": "Dedicated",
"osType": "Windows",
"virtualMachineImage": null,
"isolatedNetwork": false,
"subnet": {
"id": "test-subnet-resource-id"
},
"scaleSettings": {
"maxNodeCount": 1,
"minNodeCount": 0,
"nodeIdleTimeBeforeScaleDown": "PT5M"
},
"remoteLoginPortPublicAccess": "Enabled",
"allocationState": "Resizing",
"allocationStateTransitionTime": "2017-09-27T22:28:08.998Z",
"errors": null,
"currentNodeCount": 0,
"targetNodeCount": 1,
"nodeStateCounts": {
"preparingNodeCount": 0,
"runningNodeCount": 0,
"idleNodeCount": 0,
"unusableNodeCount": 0,
"leavingNodeCount": 0,
"preemptedNodeCount": 0
},
"enableNodePublicIp": true
}
}
}
Get a Kubernetes Compute
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2023-10-01
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus",
"properties": {
"createdOn": "2021-04-01T22:00:00.0000000+00:00",
"modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
"description": "some compute",
"resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
"computeType": "Kubernetes",
"provisioningState": "Succeeded",
"isAttachedCompute": true,
"properties": {
"relayConnectionString": null,
"serviceBusConnectionString": null,
"extensionPrincipalId": null,
"extensionInstanceReleaseTrain": "stable",
"vcName": null,
"namespace": "default",
"defaultInstanceType": "defaultInstanceType",
"instanceTypes": {
"defaultInstanceType": {
"nodeSelector": null,
"resources": {
"requests": {
"cpu": "1",
"memory": "4Gi",
"nvidia.com/gpu": null
},
"limits": {
"cpu": "1",
"memory": "4Gi",
"nvidia.com/gpu": null
}
}
}
}
}
}
}
Get an ComputeInstance
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2023-10-01
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus2",
"properties": {
"description": "some compute",
"createdOn": "2021-04-01T22:00:00.0000000+00:00",
"modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
"computeType": "ComputeInstance",
"provisioningState": "Succeeded",
"properties": {
"vmSize": "STANDARD_NC6",
"subnet": {
"id": "test-subnet-resource-id"
},
"applicationSharingPolicy": "Shared",
"sshSettings": {
"sshPublicAccess": "Enabled",
"adminUserName": "azureuser",
"sshPort": 22
},
"osImageMetadata": {
"currentImageVersion": "22.06.14",
"latestImageVersion": "22.07.22",
"isLatestOsImageVersion": false
},
"customServices": [
{
"docker": {
"privileged": true
},
"environmentVariables": {
"test_var": {
"type": "local",
"value": "test_val"
}
},
"volumes": [
{
"type": "bind",
"readOnly": false,
"source": "/home/azureuser/cloudfiles",
"target": "/home/azureuser/cloudfiles"
}
],
"endpoints": [
{
"name": "connect",
"target": 8787,
"published": 8787,
"protocol": "http"
}
],
"image": {
"type": "docker",
"reference": "ghcr.io/azure/rocker-rstudio-ml-verse:latest"
},
"name": "rstudio"
}
],
"computeInstanceAuthorizationType": "personal",
"personalComputeInstanceSettings": {
"assignedUser": {
"objectId": "00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
}
},
"createdBy": {
"userName": "foobar@microsoft.com",
"userOrgId": "00000000-0000-0000-0000-000000000000",
"userId": "00000000-0000-0000-0000-000000000000"
},
"connectivityEndpoints": {
"publicIpAddress": "10.0.0.1",
"privateIpAddress": "10.0.0.1"
},
"applications": [
{
"displayName": "Jupyter",
"endpointUri": "https://compute123.eastus2.azureml.net/jupyter"
}
],
"errors": null,
"state": "Running"
}
}
}
Definitions
Name | Description |
---|---|
AKS |
A Machine Learning compute based on AKS. |
Aks |
Advance configuration for AKS networking |
Allocation |
Allocation state. |
Aml |
An Azure Machine Learning compute. |
Aml |
AML Compute properties |
application |
Sharing policy for applications on this compute instance |
Assigned |
A user that can be assigned to a compute instance. |
autosave |
Auto save settings. |
Bind |
Describes the bind options for the container |
caching |
Caching type of Data Disk. |
Cluster |
Intended usage of the cluster |
Compute |
An Azure Machine Learning compute instance. |
Compute |
Defines an Aml Instance application and its connectivity endpoint URI. |
Compute |
Compute Instance Authorization type. |
Compute |
Defines all connectivity endpoints and properties for an ComputeInstance. |
Compute |
Defines an Aml Instance container. |
Compute |
Describes information on user who created this ComputeInstance. |
Compute |
Defines an Aml Instance DataDisk. |
Compute |
Defines an Aml Instance DataMount. |
Compute |
Environment information |
Compute |
The last operation on ComputeInstance. |
Compute |
Compute Instance properties |
Compute |
Specifies policy and settings for SSH access. |
Compute |
Current state of an ComputeInstance. |
Compute |
Version of computeInstance. |
Compute |
The compute power action. |
Compute |
Enum to describe the frequency of a compute recurrence schedule |
Compute |
|
Compute |
Machine Learning compute object wrapped into ARM resource envelope. |
Compute |
The list of schedules to be applied on the computes |
Compute |
Compute start stop schedule properties |
Compute |
Is the trigger type recurrence or cron. |
Compute |
The type of compute |
Compute |
Enum of weekday |
created |
The type of identity that created the resource. |
Cron |
The workflow trigger cron for ComputeStartStop schedule type. |
Custom |
Specifies the custom service configuration |
Databricks |
A DataFactory compute. |
Databricks |
Properties of Databricks |
Data |
A DataFactory compute. |
Data |
A DataLakeAnalytics compute. |
Docker |
Docker container configuration |
Endpoint |
Describes the endpoint configuration for the container |
Environment |
Environment Variables for the container |
Environment |
Type of Environment Variable |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
HDInsight |
A HDInsight compute. |
HDInsight |
HDInsight compute properties |
Image |
Describes the Image Specifications |
Image |
Returns metadata about the operating system image for this compute instance. |
Image |
Type of the image |
Instance |
Instance type schema. |
Kubernetes |
A Machine Learning compute based on Kubernetes Compute. |
Kubernetes |
Kubernetes properties |
Load |
Load Balancer Type |
Managed |
Managed service identity (system assigned and/or user assigned identities) |
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
mount |
Mount Action. |
mount |
Mount state. |
network |
network of this container. |
Node |
Counts of various compute node states on the amlCompute. |
Operation |
Name of the last operation. |
Operation |
Operation status. |
operation |
Trigger of operation. |
Os |
Compute OS Type |
Personal |
Settings for a personal compute instance. |
Properties |
AKS properties |
protocol |
Endpoint Communication Protocol |
Provisioning |
The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. |
provisioning |
The current deployment state of schedule. |
Recurrence |
The workflow trigger recurrence for ComputeStartStop schedule type. |
remote |
Close remote Login Access Port |
Resource |
Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. |
Resources |
Resource requests/limits for this instance type |
Scale |
scale settings for AML Compute |
Schedule |
|
Schedule |
The current deployment state of schedule. |
Schedule |
Is the schedule enabled or disabled? |
Script |
Script reference |
Scripts |
Customized setup scripts |
Setup |
Details of customized scripts to execute for setting up the cluster. |
Sku |
The resource model definition representing SKU |
Sku |
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. |
source |
Data source type. |
ssh |
Access policy for SSH |
Ssl |
Enable or disable ssl for scoring |
Ssl |
The ssl configuration for scoring |
storage |
type of this storage account. |
Synapse |
A SynapseSpark compute. |
system |
Metadata pertaining to creation and last modification of the resource. |
System |
A system service running on a compute. |
Tmpfs |
Describes the tmpfs options for the container |
User |
Settings for user account that gets created on each on the nodes of a compute. |
User |
User assigned identity properties |
Virtual |
A Machine Learning compute based on Azure Virtual Machines. |
Virtual |
Virtual Machine image for Windows AML Compute |
Virtual |
Admin credentials for virtual machine |
Vm |
Virtual Machine priority |
Volume |
Describes the volume configuration for the container |
Volume |
Type of Volume Definition |
Volume |
Describes the volume options for the container |
AKS
A Machine Learning compute based on AKS.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties |
AKS properties |
|
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
AksNetworkingConfiguration
Advance configuration for AKS networking
Name | Type | Description |
---|---|---|
dnsServiceIP |
string |
An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. |
dockerBridgeCidr |
string |
A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range. |
serviceCidr |
string |
A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. |
subnetId |
string |
Virtual network subnet resource ID the compute nodes belong to |
AllocationState
Allocation state.
Name | Type | Description |
---|---|---|
Resizing |
string |
|
Steady |
string |
AmlCompute
An Azure Machine Learning compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties |
Properties of AmlCompute |
|
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
AmlComputeProperties
AML Compute properties
Name | Type | Default Value | Description |
---|---|---|---|
allocationState |
Allocation state. |
||
allocationStateTransitionTime |
string |
Allocation state transition time. |
|
currentNodeCount |
integer |
Current node count. |
|
enableNodePublicIp |
boolean |
True |
Enable node public IP. |
errors |
Errors. |
||
isolatedNetwork |
boolean |
Network is isolated or not |
|
nodeStateCounts |
Node state counts. |
||
osType | Linux |
Compute OS Type |
|
propertyBag |
object |
A property bag containing additional properties. |
|
remoteLoginPortPublicAccess | NotSpecified |
Close remote Login Access Port |
|
scaleSettings |
Scale settings for AML Compute |
||
subnet |
Subnet. |
||
targetNodeCount |
integer |
Target node count. |
|
userAccountCredentials |
User account credentials. |
||
virtualMachineImage |
Virtual Machine image for AML Compute - windows only |
||
vmPriority |
Virtual Machine priority |
||
vmSize |
string |
Virtual Machine Size |
applicationSharingPolicy
Sharing policy for applications on this compute instance
Name | Type | Description |
---|---|---|
Personal |
string |
|
Shared |
string |
AssignedUser
A user that can be assigned to a compute instance.
Name | Type | Description |
---|---|---|
objectId |
string |
User’s AAD Object Id. |
tenantId |
string |
User’s AAD Tenant Id. |
autosave
Auto save settings.
Name | Type | Description |
---|---|---|
Local |
string |
|
None |
string |
|
Remote |
string |
BindOptions
Describes the bind options for the container
Name | Type | Description |
---|---|---|
createHostPath |
boolean |
Indicate whether to create host path. |
propagation |
string |
Type of Bind Option |
selinux |
string |
Mention the selinux options. |
caching
Caching type of Data Disk.
Name | Type | Description |
---|---|---|
None |
string |
|
ReadOnly |
string |
|
ReadWrite |
string |
ClusterPurpose
Intended usage of the cluster
Name | Type | Description |
---|---|---|
DenseProd |
string |
|
DevTest |
string |
|
FastProd |
string |
ComputeInstance
An Azure Machine Learning compute instance.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties |
Properties of ComputeInstance |
|
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
ComputeInstanceApplication
Defines an Aml Instance application and its connectivity endpoint URI.
Name | Type | Description |
---|---|---|
displayName |
string |
Name of the ComputeInstance application. |
endpointUri |
string |
Application' endpoint URI. |
ComputeInstanceAuthorizationType
Compute Instance Authorization type.
Name | Type | Description |
---|---|---|
personal |
string |
ComputeInstanceConnectivityEndpoints
Defines all connectivity endpoints and properties for an ComputeInstance.
Name | Type | Description |
---|---|---|
privateIpAddress |
string |
Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). |
publicIpAddress |
string |
Public IP Address of this ComputeInstance. |
ComputeInstanceContainer
Defines an Aml Instance container.
Name | Type | Description |
---|---|---|
autosave |
Auto save settings. |
|
environment |
Environment information of this container. |
|
gpu |
string |
Information of GPU. |
name |
string |
Name of the ComputeInstance container. |
network |
network of this container. |
|
services |
object[] |
services of this containers. |
ComputeInstanceCreatedBy
Describes information on user who created this ComputeInstance.
Name | Type | Description |
---|---|---|
userId |
string |
Uniquely identifies the user within his/her organization. |
userName |
string |
Name of the user. |
userOrgId |
string |
Uniquely identifies user' Azure Active Directory organization. |
ComputeInstanceDataDisk
Defines an Aml Instance DataDisk.
Name | Type | Default Value | Description |
---|---|---|---|
caching |
Caching type of Data Disk. |
||
diskSizeGB |
integer |
The initial disk size in gigabytes. |
|
lun |
integer |
The logical unit number. |
|
storageAccountType | Standard_LRS |
type of this storage account. |
ComputeInstanceDataMount
Defines an Aml Instance DataMount.
Name | Type | Description |
---|---|---|
createdBy |
string |
who this data mount created by. |
error |
string |
Error of this data mount. |
mountAction |
Mount Action. |
|
mountName |
string |
name of the ComputeInstance data mount. |
mountPath |
string |
Path of this data mount. |
mountState |
Mount state. |
|
mountedOn |
string |
Mounted time. |
source |
string |
Source of the ComputeInstance data mount. |
sourceType |
Data source type. |
ComputeInstanceEnvironmentInfo
Environment information
Name | Type | Description |
---|---|---|
name |
string |
name of environment. |
version |
string |
version of environment. |
ComputeInstanceLastOperation
The last operation on ComputeInstance.
Name | Type | Description |
---|---|---|
operationName |
Name of the last operation. |
|
operationStatus |
Operation status. |
|
operationTime |
string |
Time of the last operation. |
operationTrigger |
Trigger of operation. |
ComputeInstanceProperties
Compute Instance properties
Name | Type | Default Value | Description |
---|---|---|---|
applicationSharingPolicy | Shared |
Sharing policy for applications on this compute instance |
|
applications |
Describes available applications and their endpoints on this ComputeInstance. |
||
computeInstanceAuthorizationType | personal |
Compute Instance Authorization type. |
|
connectivityEndpoints |
Describes all connectivity endpoints available for this ComputeInstance. |
||
containers |
Describes informations of containers on this ComputeInstance. |
||
createdBy |
Describes information on user who created this ComputeInstance. |
||
customServices |
List of Custom Services added to the compute. |
||
dataDisks |
Describes informations of dataDisks on this ComputeInstance. |
||
dataMounts |
Describes informations of dataMounts on this ComputeInstance. |
||
enableNodePublicIp |
boolean |
Enable node public IP. |
|
errors |
Errors. |
||
lastOperation |
The last operation on ComputeInstance. |
||
osImageMetadata |
Returns metadata about the operating system image for this compute instance. |
||
personalComputeInstanceSettings |
Personal Compute Instance settings. |
||
schedules |
The list of schedules to be applied on the computes. |
||
setupScripts |
Details of customized scripts to execute for setting up the cluster. |
||
sshSettings |
Specifies policy and settings for SSH access. |
||
state |
The current state of this ComputeInstance. |
||
subnet |
Subnet. |
||
versions |
ComputeInstance version. |
||
vmSize |
string |
Virtual Machine Size |
ComputeInstanceSshSettings
Specifies policy and settings for SSH access.
Name | Type | Default Value | Description |
---|---|---|---|
adminPublicKey |
string |
Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. |
|
adminUserName |
string |
Describes the admin user name. |
|
sshPort |
integer |
Describes the port for connecting through SSH. |
|
sshPublicAccess | Disabled |
Access policy for SSH |
ComputeInstanceState
Current state of an ComputeInstance.
Name | Type | Description |
---|---|---|
CreateFailed |
string |
|
Creating |
string |
|
Deleting |
string |
|
JobRunning |
string |
|
Restarting |
string |
|
Running |
string |
|
SettingUp |
string |
|
SetupFailed |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Unknown |
string |
|
Unusable |
string |
|
UserSettingUp |
string |
|
UserSetupFailed |
string |
ComputeInstanceVersion
Version of computeInstance.
Name | Type | Description |
---|---|---|
runtime |
string |
Runtime of compute instance. |
ComputePowerAction
The compute power action.
Name | Type | Description |
---|---|---|
Start |
string |
|
Stop |
string |
ComputeRecurrenceFrequency
Enum to describe the frequency of a compute recurrence schedule
Name | Type | Description |
---|---|---|
Day |
string |
Day frequency |
Hour |
string |
Hour frequency |
Minute |
string |
Minute frequency |
Month |
string |
Month frequency |
Week |
string |
Week frequency |
ComputeRecurrenceSchedule
Name | Type | Description |
---|---|---|
hours |
integer[] |
[Required] List of hours for the schedule. |
minutes |
integer[] |
[Required] List of minutes for the schedule. |
monthDays |
integer[] |
List of month days for the schedule |
weekDays |
List of days for the schedule. |
ComputeResource
Machine Learning compute object wrapped into ARM resource envelope.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
identity |
The identity of the resource. |
|
location |
string |
Specifies the location of the resource. |
name |
string |
The name of the resource |
properties | Compute: |
Compute properties |
sku |
The sku of the workspace. |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
tags |
object |
Contains resource tags defined as key/value pairs. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ComputeSchedules
The list of schedules to be applied on the computes
Name | Type | Description |
---|---|---|
computeStartStop |
The list of compute start stop schedules to be applied. |
ComputeStartStopSchedule
Compute start stop schedule properties
Name | Type | Description |
---|---|---|
action |
[Required] The compute power action. |
|
cron |
Required if triggerType is Cron. |
|
id |
string |
A system assigned id for the schedule. |
provisioningStatus |
The current deployment state of schedule. |
|
recurrence |
Required if triggerType is Recurrence. |
|
schedule |
[Deprecated] Not used any more. |
|
status |
Is the schedule enabled or disabled? |
|
triggerType |
[Required] The schedule trigger type. |
ComputeTriggerType
Is the trigger type recurrence or cron.
Name | Type | Description |
---|---|---|
Cron |
string |
|
Recurrence |
string |
ComputeType
The type of compute
Name | Type | Description |
---|---|---|
AKS |
string |
|
AmlCompute |
string |
|
ComputeInstance |
string |
|
DataFactory |
string |
|
DataLakeAnalytics |
string |
|
Databricks |
string |
|
HDInsight |
string |
|
Kubernetes |
string |
|
SynapseSpark |
string |
|
VirtualMachine |
string |
ComputeWeekDay
Enum of weekday
Name | Type | Description |
---|---|---|
Friday |
string |
Friday weekday |
Monday |
string |
Monday weekday |
Saturday |
string |
Saturday weekday |
Sunday |
string |
Sunday weekday |
Thursday |
string |
Thursday weekday |
Tuesday |
string |
Tuesday weekday |
Wednesday |
string |
Wednesday weekday |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Cron
The workflow trigger cron for ComputeStartStop schedule type.
Name | Type | Default Value | Description |
---|---|---|---|
expression |
string |
[Required] Specifies cron expression of schedule. The expression should follow NCronTab format. |
|
startTime |
string |
The start time in yyyy-MM-ddTHH:mm:ss format. |
|
timeZone |
string |
UTC |
Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 |
CustomService
Specifies the custom service configuration
Name | Type | Description |
---|---|---|
docker |
Describes the docker settings for the image |
|
endpoints |
Endpoint[] |
Configuring the endpoints for the container |
environmentVariables |
<string,
Environment |
Environment Variable for the container |
image |
Describes the Image Specifications |
|
name |
string |
Name of the Custom Service |
volumes |
Configuring the volumes for the container |
Databricks
A DataFactory compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties |
Properties of Databricks |
|
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
DatabricksProperties
Properties of Databricks
Name | Type | Description |
---|---|---|
databricksAccessToken |
string |
Databricks access token |
workspaceUrl |
string |
Workspace Url |
DataFactory
A DataFactory compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
DataLakeAnalytics
A DataLakeAnalytics compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties | ||
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
Docker
Docker container configuration
Name | Type | Description |
---|---|---|
privileged |
boolean |
Indicate whether container shall run in privileged or non-privileged mode. |
Endpoint
Describes the endpoint configuration for the container
Name | Type | Default Value | Description |
---|---|---|---|
hostIp |
string |
Host IP over which the application is exposed from the container |
|
name |
string |
Name of the Endpoint |
|
protocol | tcp |
Endpoint Communication Protocol |
|
published |
integer |
Port over which the application is exposed from container. |
|
target |
integer |
Application port inside the container. |
EnvironmentVariable
Environment Variables for the container
Name | Type | Default Value | Description |
---|---|---|---|
type | local |
Type of Environment Variable |
|
value |
string |
Value of the Environment variable |
EnvironmentVariableType
Type of Environment Variable
Name | Type | Description |
---|---|---|
local |
string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
HDInsight
A HDInsight compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties |
HDInsight compute properties |
|
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
HDInsightProperties
HDInsight compute properties
Name | Type | Description |
---|---|---|
address |
string |
Public IP address of the master node of the cluster. |
administratorAccount |
Admin credentials for master node of the cluster |
|
sshPort |
integer |
Port open for ssh connections on the master node of the cluster. |
Image
Describes the Image Specifications
Name | Type | Default Value | Description |
---|---|---|---|
reference |
string |
Image reference |
|
type | docker |
Type of the image |
ImageMetadata
Returns metadata about the operating system image for this compute instance.
Name | Type | Description |
---|---|---|
currentImageVersion |
string |
Specifies the current operating system image version this compute instance is running on. |
isLatestOsImageVersion |
boolean |
Specifies whether this compute instance is running on the latest operating system image. |
latestImageVersion |
string |
Specifies the latest available operating system image version. |
ImageType
Type of the image
Name | Type | Description |
---|---|---|
azureml |
string |
|
docker |
string |
InstanceTypeSchema
Instance type schema.
Name | Type | Description |
---|---|---|
nodeSelector |
object |
Node Selector |
resources |
Resource requests/limits for this instance type |
Kubernetes
A Machine Learning compute based on Kubernetes Compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties |
Properties of Kubernetes |
|
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
KubernetesProperties
Kubernetes properties
Name | Type | Default Value | Description |
---|---|---|---|
defaultInstanceType |
string |
Default instance type |
|
extensionInstanceReleaseTrain |
string |
Extension instance release train. |
|
extensionPrincipalId |
string |
Extension principal-id. |
|
instanceTypes |
<string,
Instance |
Instance Type Schema |
|
namespace |
string |
default |
Compute namespace |
relayConnectionString |
string |
Relay connection string. |
|
serviceBusConnectionString |
string |
ServiceBus connection string. |
|
vcName |
string |
VC name. |
LoadBalancerType
Load Balancer Type
Name | Type | Description |
---|---|---|
InternalLoadBalancer |
string |
|
PublicIp |
string |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Name | Type | Description |
---|---|---|
principalId |
string |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId |
string |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
userAssignedIdentities |
<string,
User |
User-Assigned Identities |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
mountAction
Mount Action.
Name | Type | Description |
---|---|---|
Mount |
string |
|
Unmount |
string |
mountState
Mount state.
Name | Type | Description |
---|---|---|
MountFailed |
string |
|
MountRequested |
string |
|
Mounted |
string |
|
UnmountFailed |
string |
|
UnmountRequested |
string |
|
Unmounted |
string |
network
network of this container.
Name | Type | Description |
---|---|---|
Bridge |
string |
|
Host |
string |
NodeStateCounts
Counts of various compute node states on the amlCompute.
Name | Type | Description |
---|---|---|
idleNodeCount |
integer |
Idle node count. |
leavingNodeCount |
integer |
Leaving node count. |
preemptedNodeCount |
integer |
Preempted node count. |
preparingNodeCount |
integer |
Preparing node count. |
runningNodeCount |
integer |
Running node count. |
unusableNodeCount |
integer |
Unusable node count. |
OperationName
Name of the last operation.
Name | Type | Description |
---|---|---|
Create |
string |
|
Delete |
string |
|
Reimage |
string |
|
Restart |
string |
|
Start |
string |
|
Stop |
string |
OperationStatus
Operation status.
Name | Type | Description |
---|---|---|
CreateFailed |
string |
|
DeleteFailed |
string |
|
InProgress |
string |
|
ReimageFailed |
string |
|
RestartFailed |
string |
|
StartFailed |
string |
|
StopFailed |
string |
|
Succeeded |
string |
operationTrigger
Trigger of operation.
Name | Type | Description |
---|---|---|
IdleShutdown |
string |
|
Schedule |
string |
|
User |
string |
OsType
Compute OS Type
Name | Type | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
PersonalComputeInstanceSettings
Settings for a personal compute instance.
Name | Type | Description |
---|---|---|
assignedUser |
Assigned User. |
Properties
AKS properties
Name | Type | Default Value | Description |
---|---|---|---|
agentCount |
integer |
Number of agents |
|
agentVmSize |
string |
Agent virtual machine size |
|
aksNetworkingConfiguration |
AKS networking configuration for vnet |
||
clusterFqdn |
string |
Cluster full qualified domain name |
|
clusterPurpose | FastProd |
Intended usage of the cluster |
|
loadBalancerSubnet |
string |
Load Balancer Subnet |
|
loadBalancerType | PublicIp |
Load Balancer Type |
|
sslConfiguration |
SSL configuration |
||
systemServices |
System services |
protocol
Endpoint Communication Protocol
Name | Type | Description |
---|---|---|
http |
string |
|
tcp |
string |
|
udp |
string |
ProvisioningState
The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Unknown |
string |
|
Updating |
string |
provisioningStatus
The current deployment state of schedule.
Name | Type | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
Provisioning |
string |
Recurrence
The workflow trigger recurrence for ComputeStartStop schedule type.
Name | Type | Default Value | Description |
---|---|---|---|
frequency |
[Required] The frequency to trigger schedule. |
||
interval |
integer |
[Required] Specifies schedule interval in conjunction with frequency |
|
schedule |
[Required] The recurrence schedule. |
||
startTime |
string |
The start time in yyyy-MM-ddTHH:mm:ss format. |
|
timeZone |
string |
UTC |
Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 |
remoteLoginPortPublicAccess
Close remote Login Access Port
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
ResourceId
Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.
Name | Type | Description |
---|---|---|
id |
string |
The ID of the resource |
Resources
Resource requests/limits for this instance type
Name | Type | Description |
---|---|---|
limits |
object |
Resource limits for this instance type |
requests |
object |
Resource requests for this instance type |
ScaleSettings
scale settings for AML Compute
Name | Type | Default Value | Description |
---|---|---|---|
maxNodeCount |
integer |
Max number of nodes to use |
|
minNodeCount |
integer |
0 |
Min number of nodes to use |
nodeIdleTimeBeforeScaleDown |
string |
Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. |
ScheduleBase
Name | Type | Description |
---|---|---|
id |
string |
A system assigned id for the schedule. |
provisioningStatus |
The current deployment state of schedule. |
|
status |
Is the schedule enabled or disabled? |
ScheduleProvisioningState
The current deployment state of schedule.
Name | Type | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
Provisioning |
string |
ScheduleStatus
Is the schedule enabled or disabled?
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ScriptReference
Script reference
Name | Type | Description |
---|---|---|
scriptArguments |
string |
Optional command line arguments passed to the script to run. |
scriptData |
string |
The location of scripts in the mounted volume. |
scriptSource |
string |
The storage source of the script: workspace. |
timeout |
string |
Optional time period passed to timeout command. |
ScriptsToExecute
Customized setup scripts
Name | Type | Description |
---|---|---|
creationScript |
Script that's run only once during provision of the compute. |
|
startupScript |
Script that's run every time the machine starts. |
SetupScripts
Details of customized scripts to execute for setting up the cluster.
Name | Type | Description |
---|---|---|
scripts |
Customized setup scripts |
Sku
The resource model definition representing SKU
Name | Type | Description |
---|---|---|
capacity |
integer |
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. |
family |
string |
If the service has different generations of hardware, for the same SKU, then that can be captured here. |
name |
string |
The name of the SKU. Ex - P3. It is typically a letter+number code |
size |
string |
The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. |
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. |
SkuTier
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.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Free |
string |
|
Premium |
string |
|
Standard |
string |
sourceType
Data source type.
Name | Type | Description |
---|---|---|
Dataset |
string |
|
Datastore |
string |
|
URI |
string |
sshPublicAccess
Access policy for SSH
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
SslConfigStatus
Enable or disable ssl for scoring
Name | Type | Description |
---|---|---|
Auto |
string |
|
Disabled |
string |
|
Enabled |
string |
SslConfiguration
The ssl configuration for scoring
Name | Type | Description |
---|---|---|
cert |
string |
Cert data |
cname |
string |
CNAME of the cert |
key |
string |
Key data |
leafDomainLabel |
string |
Leaf domain label of public endpoint |
overwriteExistingDomain |
boolean |
Indicates whether to overwrite existing domain label. |
status |
Enable or disable ssl for scoring |
storageAccountType
type of this storage account.
Name | Type | Description |
---|---|---|
Premium_LRS |
string |
|
Standard_LRS |
string |
SynapseSpark
A SynapseSpark compute.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties | ||
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
SystemService
A system service running on a compute.
Name | Type | Description |
---|---|---|
publicIpAddress |
string |
Public IP address |
systemServiceType |
string |
The type of this system service. |
version |
string |
The version for this type. |
TmpfsOptions
Describes the tmpfs options for the container
Name | Type | Description |
---|---|---|
size |
integer |
Mention the Tmpfs size |
UserAccountCredentials
Settings for user account that gets created on each on the nodes of a compute.
Name | Type | Description |
---|---|---|
adminUserName |
string |
User name. |
adminUserPassword |
string |
Password. |
adminUserSshPublicKey |
string |
SSH public key. |
UserAssignedIdentity
User assigned identity properties
Name | Type | Description |
---|---|---|
clientId |
string |
The client ID of the assigned identity. |
principalId |
string |
The principal ID of the assigned identity. |
VirtualMachine
A Machine Learning compute based on Azure Virtual Machines.
Name | Type | Description |
---|---|---|
computeLocation |
string |
Location for the underlying compute |
computeType | string: |
The type of compute |
createdOn |
string |
The time at which the compute was created. |
description |
string |
The description of the Machine Learning compute. |
disableLocalAuth |
boolean |
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. |
isAttachedCompute |
boolean |
Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. |
modifiedOn |
string |
The time at which the compute was last modified. |
properties | ||
provisioningErrors |
Errors during provisioning |
|
provisioningState |
The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. |
|
resourceId |
string |
ARM resource id of the underlying compute |
VirtualMachineImage
Virtual Machine image for Windows AML Compute
Name | Type | Description |
---|---|---|
id |
string |
Virtual Machine image path |
VirtualMachineSshCredentials
Admin credentials for virtual machine
Name | Type | Description |
---|---|---|
password |
string |
Password of admin account |
privateKeyData |
string |
Private key data |
publicKeyData |
string |
Public key data |
username |
string |
Username of admin account |
VmPriority
Virtual Machine priority
Name | Type | Description |
---|---|---|
Dedicated |
string |
|
LowPriority |
string |
VolumeDefinition
Describes the volume configuration for the container
Name | Type | Default Value | Description |
---|---|---|---|
bind |
Bind Options of the mount |
||
consistency |
string |
Consistency of the volume |
|
readOnly |
boolean |
Indicate whether to mount volume as readOnly. Default value for this is false. |
|
source |
string |
Source of the mount. For bind mounts this is the host path. |
|
target |
string |
Target of the mount. For bind mounts this is the path in the container. |
|
tmpfs |
tmpfs option of the mount |
||
type | bind |
Type of Volume Definition |
|
volume |
Volume Options of the mount |
VolumeDefinitionType
Type of Volume Definition
Name | Type | Description |
---|---|---|
bind |
string |
|
npipe |
string |
|
tmpfs |
string |
|
volume |
string |
VolumeOptions
Describes the volume options for the container
Name | Type | Description |
---|---|---|
nocopy |
boolean |
Indicate whether volume is nocopy |