Compute - List

服务:

Machine Learning

API 版本:

2025-04-01

获取指定工作区中的计算。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes?api-version=2025-04-01

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes?api-version=2025-04-01&$skip={$skip}

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure 机器学习工作区的名称。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
$skip	query		string	分页的延续标记。

响应

名称	类型	说明
200 OK	PaginatedComputeResourcesList	响应包括机器学习计算的分页数组，以及下一组结果（如果有）的 URI。 有关资源组中项数的限制的详细信息，请参阅 https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/。
Other Status Codes	ErrorResponse	描述请求失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get Computes

示例请求

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes?api-version=2025-04-01

示例响应

状态代码:

200

{
  "value": [
    {
      "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": {
        "description": "some compute",
        "createdOn": "2021-04-01T22:00:00.0000000+00:00",
        "modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
        "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
        "computeType": "AKS",
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234",
      "type": "Microsoft.MachineLearningServices/workspaces/computes",
      "name": "compute1234",
      "location": "eastus",
      "properties": {
        "description": "some compute",
        "createdOn": "2021-04-01T22:00:00.0000000+00:00",
        "modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
        "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2",
        "computeType": "AKS",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "nextLink"
}

定义

名称	说明
AKS	基于 AKS 的机器学习计算。
AksNetworkingConfiguration	AKS 网络高级配置
AllocationState	分配状态。
AmlCompute	Azure 机器学习计算。
AmlComputeProperties	AML 计算属性
applicationSharingPolicy	此计算实例上的应用程序共享策略
AssignedUser	可分配给计算实例的用户。
autosave	自动保存设置。
BindOptions	描述容器的绑定选项
caching	数据磁盘的缓存类型。
ClusterPurpose	群集的预期用途
ComputeInstance	Azure 机器学习计算实例。
ComputeInstanceApplication	定义 Aml 实例应用程序及其连接终结点 URI。
ComputeInstanceAuthorizationType	计算实例授权类型。
ComputeInstanceConnectivityEndpoints	定义 ComputeInstance 的所有连接终结点和属性。
ComputeInstanceContainer	定义 Aml 实例容器。
ComputeInstanceCreatedBy	介绍创建此 ComputeInstance 的用户的信息。
ComputeInstanceDataDisk	定义 Aml 实例 DataDisk。
ComputeInstanceDataMount	定义 Aml 实例 DataMount。
ComputeInstanceEnvironmentInfo	环境信息
ComputeInstanceLastOperation	ComputeInstance 上的最后一个操作。
ComputeInstanceProperties	计算实例属性
ComputeInstanceSshSettings	指定 SSH 访问的策略和设置。
ComputeInstanceState	ComputeInstance 的当前状态。
ComputeInstanceVersion	computeInstance 的版本。
ComputePowerAction	计算能力操作。
ComputeRecurrenceFrequency	用于描述计算重复计划频率的枚举
ComputeRecurrenceSchedule
ComputeResource	包装在 ARM 资源信封中的机器学习计算对象。
ComputeSchedules	要应用于计算的计划列表
ComputeStartStopSchedule	计算启动停止计划属性
ComputeTriggerType	触发器类型重复周期或 cron。
ComputeType	计算的类型
ComputeWeekDay	工作日枚举
createdByType	创建资源的标识的类型。
Cron	ComputeStartStop 计划类型的工作流触发器 cron。
CustomService	指定自定义服务配置
Databricks	DataFactory 计算。
DatabricksProperties	Databricks 的属性
DataFactory	DataFactory 计算。
DataLakeAnalytics	DataLakeAnalytics 计算。
Docker	Docker 容器配置
Endpoint	描述容器的终结点配置
EnvironmentVariable	容器的环境变量
EnvironmentVariableType	环境变量的类型
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HDInsight	HDInsight 计算。
HDInsightProperties	HDInsight 计算属性
Image	描述映像规范
ImageMetadata	返回有关此计算实例的操作系统映像的元数据。
ImageType	图像的类型
InstanceTypeSchema	实例类型架构。
Kubernetes	基于 Kubernetes 计算的机器学习计算。
KubernetesProperties	Kubernetes 属性
LoadBalancerType	负载均衡器类型
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
mountAction	装载操作。
mountState	装载状态。
network	此容器的网络。
NodeStateCounts	amlCompute 上各种计算节点状态的计数。
OperationName	上次操作的名称。
OperationStatus	作状态。
operationTrigger	操作触发器。
OsType	计算 OS 类型
PaginatedComputeResourcesList	包装在 ARM 资源信封中的机器学习计算对象的分页列表。
PersonalComputeInstanceSettings	个人计算实例的设置。
Properties	AKS 属性
protocol	终结点通信协议
ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
provisioningStatus	计划的当前部署状态。
Recurrence	ComputeStartStop 计划类型的工作流触发器重复周期。
remoteLoginPortPublicAccess	关闭远程登录访问端口
ResourceId	表示资源 ID。 例如，对于子网，它是子网的资源 URL。
Resources	此实例类型的资源请求/限制
ScaleSettings	AML 计算的规模设置
ScheduleBase
ScheduleProvisioningState	计划的当前部署状态。
ScheduleStatus	计划是启用或禁用的吗？
ScriptReference	脚本参考
ScriptsToExecute	自定义设置脚本
SetupScripts	用于设置群集的自定义脚本的详细信息。
Sku	表示 SKU 的资源模型定义
SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。
sourceType	数据源类型。
sshPublicAccess	SSH 访问策略
SslConfigStatus	启用或禁用 ssl 进行评分
SslConfiguration	用于评分的 ssl 配置
storageAccountType	此存储帐户的类型。
SynapseSpark	SynapseSpark 计算。
systemData	与创建和上次修改资源相关的元数据。
SystemService	在计算上运行的系统服务。
TmpfsOptions	介绍容器的 tmpfs 选项
UserAccountCredentials	在计算节点上创建的每个用户帐户的设置。
UserAssignedIdentity	用户分配的标识属性
VirtualMachine	基于 Azure 虚拟机的机器学习计算。
VirtualMachineImage	适用于 Windows AML 计算的虚拟机映像
VirtualMachineSshCredentials	虚拟机的管理员凭据
VmPriority	虚拟机优先级
VolumeDefinition	描述容器的卷配置
VolumeDefinitionType	卷定义的类型
VolumeOptions	描述容器的卷选项

AKS

Object

基于 AKS 的机器学习计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: AKS	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	Properties	AKS 属性
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

AksNetworkingConfiguration

Object

AKS 网络高级配置

名称	类型	说明
dnsServiceIP	string pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$	分配给 Kubernetes DNS 服务的 IP 地址。 它必须位于 serviceCidr 中指定的 Kubernetes 服务地址范围内。
dockerBridgeCidr	string pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$	分配给 Docker 网桥网络的 CIDR 表示法 IP 范围。 它不得与任何子网 IP 范围或 Kubernetes 服务地址范围重叠。
serviceCidr	string pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$	从中分配服务群集 IP 的 CIDR 表示法 IP 范围。 它不得与任何子网 IP 范围重叠。
subnetId	string	计算节点所属的虚拟网络子网资源 ID

AllocationState

枚举

分配状态。

值	说明
Resizing
Steady

AmlCompute

Object

Azure 机器学习计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: AmlCompute	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	AmlComputeProperties	AmlCompute 的属性
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

AmlComputeProperties

Object

AML 计算属性

名称	类型	默认值	说明
allocationState	AllocationState		分配状态。 计算的分配状态。 可能的值为：稳定 - 指示计算未调整大小。 正在进行的计算节点数没有变化。 计算在创建时以及计算上未执行任何操作以更改计算节点数时进入此状态。 调整大小 - 指示计算正在调整大小;也就是说，正在向计算中添加或删除计算节点。
allocationStateTransitionTime	string (date-time)		分配状态转换时间。 计算进入其当前分配状态的时间。
currentNodeCount	integer (int32)		当前节点计数。 当前分配给计算的计算节点数。
enableNodePublicIp	boolean	True	启用节点公共 IP。 启用或禁用节点公共 IP 地址预配。 可能的值为：可能的值为：true - 指示计算节点将预配公共 IP。 false - 指示计算节点将具有专用终结点，并且没有公共 IP。
errors	ErrorResponse[]		错误。 在节点安装过程中，各种计算节点遇到的错误集合。
isolatedNetwork	boolean		网络是隔离或不隔离的
nodeStateCounts	NodeStateCounts		节点状态计数。 计算中各种节点状态的计数。
osType	OsType	Linux	计算 OS 类型
propertyBag	object		包含其他属性的属性包。
remoteLoginPortPublicAccess	remoteLoginPortPublicAccess	NotSpecified	关闭远程登录访问端口 公共 SSH 端口的状态。 可能的值是：已禁用 - 指示公共 ssh 端口已在群集的所有节点上关闭。 已启用 - 指示公共 ssh 端口在群集的所有节点上处于打开状态。 NotSpecified - 指示如果定义了 VNet，则群集的所有节点上关闭公共 SSH 端口，否则将打开所有公共节点。 只能在创建群集期间默认，创建后才会启用或禁用它。
scaleSettings	ScaleSettings		AML 计算的规模设置
subnet	ResourceId		子。 计算节点所属的虚拟网络子网资源 ID。
targetNodeCount	integer (int32)		目标节点计数。 计算的目标计算节点数。 如果 allocationState 调整大小，则此属性表示正在进行的调整大小操作的目标节点计数。 如果 allocationState 稳定，则此属性表示上一重设大小操作的目标节点计数。
userAccountCredentials	UserAccountCredentials		用户帐户凭据。 将在每个计算节点上创建的管理员用户帐户的凭据。
virtualMachineImage	VirtualMachineImage		AML 计算的虚拟机映像 - 仅限窗口
vmPriority	VmPriority		虚拟机优先级
vmSize	string		虚拟机大小

applicationSharingPolicy

枚举

此计算实例上的应用程序共享策略

值	说明
Personal
Shared

AssignedUser

Object

可分配给计算实例的用户。

名称	类型	说明
objectId	string	用户的 AAD 对象 ID。
tenantId	string	用户的 AAD 租户 ID。

autosave

枚举

自动保存设置。

值	说明
Local
None
Remote

BindOptions

Object

描述容器的绑定选项

名称	类型	说明
createHostPath	boolean	指示是否创建主机路径。
propagation	string	绑定选项的类型
selinux	string	提及 selinux 选项。

caching

枚举

数据磁盘的缓存类型。

值	说明
None
ReadOnly
ReadWrite

ClusterPurpose

枚举

群集的预期用途

值	说明
DenseProd
DevTest
FastProd

ComputeInstance

Object

Azure 机器学习计算实例。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: ComputeInstance	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	ComputeInstanceProperties	ComputeInstance 的属性
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

ComputeInstanceApplication

Object

定义 Aml 实例应用程序及其连接终结点 URI。

名称	类型	说明
displayName	string	ComputeInstance 应用程序的名称。
endpointUri	string	应用程序的终结点 URI。

ComputeInstanceAuthorizationType

枚举

计算实例授权类型。

值	说明
personal

ComputeInstanceConnectivityEndpoints

Object

定义 ComputeInstance 的所有连接终结点和属性。

名称	类型	说明
privateIpAddress	string	此 ComputeInstance 的专用 IP 地址（部署计算实例的 VNET 本地）。
publicIpAddress	string	此 ComputeInstance 的公共 IP 地址。

ComputeInstanceContainer

Object

定义 Aml 实例容器。

名称	类型	说明
autosave	autosave	自动保存设置。
environment	ComputeInstanceEnvironmentInfo	此容器的环境信息。
gpu	string	GPU 的信息。
name	string	ComputeInstance 容器的名称。
network	network	此容器的网络。
services	object[]	此容器的服务。

ComputeInstanceCreatedBy

Object

介绍创建此 ComputeInstance 的用户的信息。

名称	类型	说明
userId	string	唯一标识其组织内的用户。
userName	string	用户的名称。
userOrgId	string	唯一标识用户的 Azure Active Directory 组织。

ComputeInstanceDataDisk

Object

定义 Aml 实例 DataDisk。

名称	类型	默认值	说明
caching	caching		数据磁盘的缓存类型。
diskSizeGB	integer (int32)		初始磁盘大小（以 GB 为单位）。 初始磁盘大小（以 GB 为单位）。
lun	integer (int32)		逻辑单元号。 lun 用于唯一标识每个数据磁盘。 如果附加多个磁盘，每个磁盘应具有不同的 lun。
storageAccountType	storageAccountType	Standard_LRS	此存储帐户的类型。

ComputeInstanceDataMount

Object

定义 Aml 实例 DataMount。

名称	类型	说明
createdBy	string	此数据装载者。
error	string	此数据装载的错误。
mountAction	mountAction	装载操作。
mountName	string	ComputeInstance 数据装载的名称。
mountPath	string	此数据装载的路径。
mountState	mountState	装载状态。
mountedOn	string (date-time)	装载时间。 装载磁盘的时间。
source	string	ComputeInstance 数据装载的源。
sourceType	sourceType	数据源类型。

ComputeInstanceEnvironmentInfo

Object

环境信息

名称	类型	说明
name	string	环境的名称。
version	string	环境版本。

ComputeInstanceLastOperation

Object

ComputeInstance 上的最后一个操作。

名称	类型	说明
operationName	OperationName	上次操作的名称。
operationStatus	OperationStatus	作状态。
operationTime	string (date-time)	上次操作的时间。
operationTrigger	operationTrigger	操作触发器。

ComputeInstanceProperties

Object

计算实例属性

名称	类型	默认值	说明
applicationSharingPolicy	applicationSharingPolicy	Shared	此计算实例上的应用程序共享策略 用于在此计算实例上共享父工作区用户的应用程序的策略。 如果个人版，则只有创建者可以访问此计算实例上的应用程序。 共享时，任何工作区用户都可以根据分配的角色访问此实例上的应用程序。
applications	ComputeInstanceApplication[]		介绍此 ComputeInstance 上的可用应用程序及其终结点。
computeInstanceAuthorizationType	ComputeInstanceAuthorizationType	personal	计算实例授权类型。 计算实例授权类型。 可用值为个人值（默认值）。
connectivityEndpoints	ComputeInstanceConnectivityEndpoints		介绍可用于此 ComputeInstance 的所有连接终结点。
containers	ComputeInstanceContainer[]		介绍此 ComputeInstance 上的容器信息。
createdBy	ComputeInstanceCreatedBy		介绍创建此 ComputeInstance 的用户的信息。
customServices	CustomService[]		添加到计算中的自定义服务列表。
dataDisks	ComputeInstanceDataDisk[]		介绍此 ComputeInstance 上的 dataDisks 的信息。
dataMounts	ComputeInstanceDataMount[]		介绍此 ComputeInstance 上的 dataMounts 的信息。
enableNodePublicIp	boolean		启用节点公共 IP。 启用或禁用节点公共 IP 地址预配。 可能的值为：可能的值为：true - 指示计算节点将预配公共 IP。 false - 指示计算节点将具有专用终结点，并且没有公共 IP。
errors	ErrorResponse[]		错误。 此 ComputeInstance 上遇到的错误的集合。
lastOperation	ComputeInstanceLastOperation		ComputeInstance 上的最后一个操作。
osImageMetadata	ImageMetadata		返回有关此计算实例的操作系统映像的元数据。
personalComputeInstanceSettings	PersonalComputeInstanceSettings		个人计算实例设置。 个人计算实例的设置。
schedules	ComputeSchedules		要应用于计算的计划列表。
setupScripts	SetupScripts		用于设置群集的自定义脚本的详细信息。
sshSettings	ComputeInstanceSshSettings		指定 SSH 访问的策略和设置。
state	ComputeInstanceState		此 ComputeInstance 的当前状态。
subnet	ResourceId		子。 计算节点所属的虚拟网络子网资源 ID。
versions	ComputeInstanceVersion		ComputeInstance 版本。
vmSize	string		虚拟机大小

ComputeInstanceSshSettings

Object

指定 SSH 访问的策略和设置。

名称	类型	默认值	说明
adminPublicKey	string		将 SSH rsa 公钥文件指定为字符串。 使用“ssh-keygen -t rsa -b 2048”生成 SSH 密钥对。
adminUserName	string		描述管理员用户名。
sshPort	integer (int32)		描述通过 SSH 进行连接的端口。
sshPublicAccess	sshPublicAccess	Disabled	SSH 访问策略 公共 SSH 端口的状态。 可能的值是：已禁用 - 指示此实例上已关闭公共 ssh 端口。 启用 - 指示公共 ssh 端口已打开，并可根据 VNet/子网策略（如果适用）进行访问。

ComputeInstanceState

枚举

ComputeInstance 的当前状态。

值	说明
CreateFailed
Creating
Deleting
JobRunning
Restarting
Running
SettingUp
SetupFailed
Starting
Stopped
Stopping
Unknown
Unusable
UserSettingUp
UserSetupFailed

ComputeInstanceVersion

Object

computeInstance 的版本。

名称	类型	说明
runtime	string	计算实例的运行时。

ComputePowerAction

枚举

计算能力操作。

值	说明
Start
Stop

ComputeRecurrenceFrequency

枚举

用于描述计算重复计划频率的枚举

值	说明
Day	日频率
Hour	小时频率
Minute	分钟频率
Month	月频率
Week	周频率

ComputeRecurrenceSchedule

Object

名称	类型	说明
hours	integer[] (int32)	[必需]计划小时列表。
minutes	integer[] (int32)	[必需]计划分钟列表。
monthDays	integer[] (int32)	计划月份日期列表
weekDays	ComputeWeekDay[]	计划天数列表。

ComputeResource

Object

包装在 ARM 资源信封中的机器学习计算对象。

名称	类型	说明
id	string	资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	资源的标识。
location	string	指定资源的位置。
name	string	资源的名称
properties	Compute: AKS AmlCompute ComputeInstance DataFactory DataLakeAnalytics Databricks HDInsight Kubernetes SynapseSpark VirtualMachine	计算属性
sku	Sku	工作区的 SKU。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	包含定义为键/值对的资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ComputeSchedules

Object

要应用于计算的计划列表

名称	类型	说明
computeStartStop	ComputeStartStopSchedule[]	要应用的计算启动停止计划的列表。

ComputeStartStopSchedule

Object

计算启动停止计划属性

名称	类型	说明
action	ComputePowerAction	[必需]计算能力操作。
cron	Cron	如果 triggerType 为 Cron，则为必需。
id	string	计划的系统分配 ID。
provisioningStatus	provisioningStatus	计划的当前部署状态。
recurrence	Recurrence	如果 triggerType 为 Recurrence，则为必需。
schedule	ScheduleBase	[已弃用]不再使用。
status	ScheduleStatus	计划是启用或禁用的吗？
triggerType	ComputeTriggerType	[必需]计划触发器类型。

ComputeTriggerType

枚举

触发器类型重复周期或 cron。

值	说明
Cron
Recurrence

ComputeType

枚举

计算的类型

值	说明
AKS
AmlCompute
ComputeInstance
DataFactory
DataLakeAnalytics
Databricks
HDInsight
Kubernetes
SynapseSpark
VirtualMachine

ComputeWeekDay

枚举

工作日枚举

值	说明
Friday	星期五工作日
Monday	星期一工作日
Saturday	星期六工作日
Sunday	星期天工作日
Thursday	星期四工作日
Tuesday	星期二工作日
Wednesday	星期三工作日

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

Cron

Object

ComputeStartStop 计划类型的工作流触发器 cron。

名称	类型	默认值	说明
expression	string		[必需]指定计划的 cron 表达式。 表达式应遵循 NCronTab 格式。
startTime	string		yyyy-MM-ddTHH：mm：ss 格式的开始时间。
timeZone	string	UTC	指定运行计划的时区。 TimeZone 应遵循 Windows 时区格式。 指： https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11

CustomService

Object

指定自定义服务配置

名称	类型	说明
docker	Docker	描述映像的 docker 设置
endpoints	Endpoint[]	配置容器的终结点
environmentVariables	<string,  EnvironmentVariable>	容器的环境变量
image	Image	描述映像规范
name	string	自定义服务的名称
volumes	VolumeDefinition[]	为容器配置卷

Databricks

Object

DataFactory 计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: Databricks	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	DatabricksProperties	Databricks 的属性
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

DatabricksProperties

Object

Databricks 的属性

名称	类型	说明
databricksAccessToken	string	Databricks 访问令牌
workspaceUrl	string	工作区 URL

DataFactory

Object

DataFactory 计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: DataFactory	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

DataLakeAnalytics

Object

DataLakeAnalytics 计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: DataLakeAnalytics	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	Properties
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

Docker

Object

Docker 容器配置

名称	类型	说明
privileged	boolean	指示容器是在特权模式还是非特权模式下运行。

Endpoint

Object

描述容器的终结点配置

名称	类型	默认值	说明
hostIp	string		从容器公开应用程序的主机 IP
name	string		终结点的名称
protocol	protocol	tcp	终结点通信协议 通过此终结点进行通信的协议
published	integer (int32)		应用程序从容器公开的端口。
target	integer (int32)		容器内的应用程序端口。

EnvironmentVariable

Object

容器的环境变量

名称	类型	默认值	说明
type	EnvironmentVariableType	local	环境变量的类型 环境变量的类型。 可能的值为：local - 对于局部变量
value	string		环境变量的值

EnvironmentVariableType

枚举

环境变量的类型

值	说明
local

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

HDInsight

Object

HDInsight 计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: HDInsight	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	HDInsightProperties	HDInsight 计算属性
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

HDInsightProperties

Object

HDInsight 计算属性

名称	类型	说明
address	string	群集主节点的公共 IP 地址。
administratorAccount	VirtualMachineSshCredentials	群集主节点的管理员凭据
sshPort	integer (int32)	在群集的主节点上为 SSH 连接打开端口。

Image

Object

描述映像规范

名称	类型	默认值	说明
reference	string		图像参考
type	ImageType	docker	图像的类型 图像的类型。 可能的值包括：docker - 对于 docker 映像。 azureml - 对于 AzureML 映像

ImageMetadata

Object

返回有关此计算实例的操作系统映像的元数据。

名称	类型	说明
currentImageVersion	string	指定运行此计算实例的当前操作系统映像版本。
isLatestOsImageVersion	boolean	指定此计算实例是否在最新的操作系统映像上运行。
latestImageVersion	string	指定最新的可用操作系统映像版本。

ImageType

枚举

图像的类型

值	说明
azureml
docker

InstanceTypeSchema

Object

实例类型架构。

名称	类型	说明
nodeSelector	object	节点选择器
resources	Resources	此实例类型的资源请求/限制

Kubernetes

Object

基于 Kubernetes 计算的机器学习计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: Kubernetes	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	KubernetesProperties	Kubernetes 的属性
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

KubernetesProperties

Object

Kubernetes 属性

名称	类型	默认值	说明
defaultInstanceType	string		默认实例类型
extensionInstanceReleaseTrain	string		扩展实例发布训练。
extensionPrincipalId	string		扩展主体 ID。
instanceTypes	<string,  InstanceTypeSchema>		实例类型架构
namespace	string	default	计算命名空间
relayConnectionString	string		中继连接字符串。
serviceBusConnectionString	string		ServiceBus 连接字符串。
vcName	string		VC 名称。

LoadBalancerType

枚举

负载均衡器类型

值	说明
InternalLoadBalancer
PublicIp

ManagedServiceIdentity

Object

托管服务标识（系统分配和/或用户分配的标识）

名称	类型	说明
principalId	string (uuid)	系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。
tenantId	string (uuid)	系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。
type	ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned 标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。

ManagedServiceIdentityType

枚举

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

值	说明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

mountAction

枚举

装载操作。

值	说明
Mount
Unmount

mountState

枚举

装载状态。

值	说明
MountFailed
MountRequested
Mounted
UnmountFailed
UnmountRequested
Unmounted

network

枚举

此容器的网络。

值	说明
Bridge
Host

NodeStateCounts

Object

amlCompute 上各种计算节点状态的计数。

名称	类型	说明
idleNodeCount	integer (int32)	空闲节点计数。 处于空闲状态的计算节点数。
leavingNodeCount	integer (int32)	离开节点计数。 离开 amlCompute 的计算节点数。
preemptedNodeCount	integer (int32)	抢占的节点计数。 处于抢占状态的计算节点数。
preparingNodeCount	integer (int32)	正在准备节点计数。 正在准备的计算节点数。
runningNodeCount	integer (int32)	运行节点计数。 正在运行作业的计算节点数。
unusableNodeCount	integer (int32)	不可用的节点计数。 处于不可用状态的计算节点数。

OperationName

枚举

上次操作的名称。

值	说明
Create
Delete
Reimage
Restart
Start
Stop

OperationStatus

枚举

作状态。

值	说明
CreateFailed
DeleteFailed
InProgress
ReimageFailed
RestartFailed
StartFailed
StopFailed
Succeeded

operationTrigger

枚举

操作触发器。

值	说明
IdleShutdown
Schedule
User

OsType

枚举

计算 OS 类型

值	说明
Linux
Windows

PaginatedComputeResourcesList

Object

包装在 ARM 资源信封中的机器学习计算对象的分页列表。

名称	类型	说明
nextLink	string	指向列表中的下一页结果的延续链接（绝对 URI）。
value	ComputeResource[]	包装在 ARM 资源信封中的机器学习计算对象的数组。

PersonalComputeInstanceSettings

Object

个人计算实例的设置。

名称	类型	说明
assignedUser	AssignedUser	分配的用户。 显式分配给个人计算实例的用户。

Properties

Object

AKS 属性

名称	类型	默认值	说明
agentCount	integer (int32) minimum: 0		代理数
agentVmSize	string		代理虚拟机大小
aksNetworkingConfiguration	AksNetworkingConfiguration		vnet 的 AKS 网络配置
clusterFqdn	string		群集完全限定的域名
clusterPurpose	ClusterPurpose	FastProd	群集的预期用途
loadBalancerSubnet	string		负载均衡器子网
loadBalancerType	LoadBalancerType	PublicIp	负载均衡器类型
sslConfiguration	SslConfiguration		SSL 配置
systemServices	SystemService[]		系统服务

protocol

枚举

终结点通信协议

值	说明
http
tcp
udp

ProvisioningState

枚举

群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。

值	说明
Canceled
Creating
Deleting
Failed
Succeeded
Unknown
Updating

provisioningStatus

枚举

计划的当前部署状态。

值	说明
Completed
Failed
Provisioning

Recurrence

Object

ComputeStartStop 计划类型的工作流触发器重复周期。

名称	类型	默认值	说明
frequency	ComputeRecurrenceFrequency		[必需]触发计划的频率。
interval	integer (int32)		[必需]指定计划间隔与频率
schedule	ComputeRecurrenceSchedule		[必需]重复计划。
startTime	string		yyyy-MM-ddTHH：mm：ss 格式的开始时间。
timeZone	string	UTC	指定运行计划的时区。 TimeZone 应遵循 Windows 时区格式。 指： https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11

remoteLoginPortPublicAccess

枚举

关闭远程登录访问端口

值	说明
Disabled
Enabled
NotSpecified

ResourceId

Object

表示资源 ID。 例如，对于子网，它是子网的资源 URL。

名称	类型	说明
id	string	资源的 ID

Resources

Object

此实例类型的资源请求/限制

名称	类型	说明
limits	object	此实例类型的资源限制
requests	object	此实例类型的资源请求

ScaleSettings

Object

AML 计算的规模设置

名称	类型	默认值	说明
maxNodeCount	integer (int32)		要使用的最大节点数
minNodeCount	integer (int32)	0	要使用的节点数最小
nodeIdleTimeBeforeScaleDown	string (duration)		纵向缩减 amlCompute 之前的节点空闲时间。 此字符串需要采用 RFC 格式。

ScheduleBase

Object

名称	类型	说明
id	string	计划的系统分配 ID。
provisioningStatus	ScheduleProvisioningState	计划的当前部署状态。
status	ScheduleStatus	计划是启用或禁用的吗？

ScheduleProvisioningState

枚举

计划的当前部署状态。

值	说明
Completed
Failed
Provisioning

ScheduleStatus

枚举

计划是启用或禁用的吗？

值	说明
Disabled
Enabled

ScriptReference

Object

脚本参考

名称	类型	说明
scriptArguments	string	传递给要运行的脚本的可选命令行参数。
scriptData	string	装载卷中脚本的位置。
scriptSource	string	脚本的存储源：工作区。
timeout	string	传递给超时命令的可选时间段。

ScriptsToExecute

Object

自定义设置脚本

名称	类型	说明
creationScript	ScriptReference	预配计算期间仅运行一次的脚本。
startupScript	ScriptReference	每次计算机启动时运行的脚本。

SetupScripts

Object

用于设置群集的自定义脚本的详细信息。

名称	类型	说明
scripts	ScriptsToExecute	自定义设置脚本

Sku

Object

表示 SKU 的资源模型定义

名称	类型	说明
capacity	integer (int32)	如果 SKU 支持横向扩展/缩减，则应包含容量整数。 如果资源无法横向扩展/缩小，则可能会省略此范围。
family	string	如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name	string	SKU 的名称。 例 - P3。 它通常是字母+数字代码
size	string	SKU 大小。 当名称字段是层和其他一些值的组合时，这将是独立的代码。
tier	SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

SkuTier

枚举

如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

值	说明
Basic
Free
Premium
Standard

sourceType

枚举

数据源类型。

值	说明
Dataset
Datastore
URI

sshPublicAccess

枚举

SSH 访问策略

值	说明
Disabled
Enabled

SslConfigStatus

枚举

启用或禁用 ssl 进行评分

值	说明
Auto
Disabled
Enabled

SslConfiguration

Object

用于评分的 ssl 配置

名称	类型	说明
cert	string	证书数据
cname	string	证书的 CNAME
key	string	密钥数据
leafDomainLabel	string	公共终结点的叶域标签
overwriteExistingDomain	boolean	指示是否覆盖现有域标签。
status	SslConfigStatus	启用或禁用 ssl 进行评分

storageAccountType

枚举

此存储帐户的类型。

值	说明
Premium_LRS
Standard_LRS

SynapseSpark

Object

SynapseSpark 计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: SynapseSpark	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	Properties
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

SystemService

Object

在计算上运行的系统服务。

名称	类型	说明
publicIpAddress	string	公共 IP 地址
systemServiceType	string	此系统服务的类型。
version	string	此类型的版本。

TmpfsOptions

Object

介绍容器的 tmpfs 选项

名称	类型	说明
size	integer (int32)	提及 Tmpfs 大小

UserAccountCredentials

Object

在计算节点上创建的每个用户帐户的设置。

名称	类型	说明
adminUserName	string	用户名。 可用于通过 SSH 连接到节点的管理员用户帐户的名称。
adminUserPassword	string	密码。 管理员用户帐户的密码。
adminUserSshPublicKey	string	SSH 公钥。 管理员用户帐户的 SSH 公钥。

UserAssignedIdentity

Object

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	分配的标识的客户端 ID。
principalId	string (uuid)	已分配标识的主体 ID。

VirtualMachine

Object

基于 Azure 虚拟机的机器学习计算。

名称	类型	说明
computeLocation	string	基础计算的位置
computeType	string: VirtualMachine	计算的类型
createdOn	string (date-time)	创建计算的时间。
description	string	机器学习计算的说明。
disableLocalAuth	boolean	选择退出本地身份验证，并确保客户只能仅使用 MSI 和 AAD 进行身份验证。
isAttachedCompute	boolean	指示计算是由用户预配的，如果为 true，则从外部引入，或者机器学习服务预配了计算（如果为 false）。
modifiedOn	string (date-time)	上次修改计算的时间。
properties	Properties
provisioningErrors	ErrorResponse[]	预配过程中的错误
provisioningState	ProvisioningState	群集的预配状态。 有效值为 Unknown、Updateing、Provisioning、Succeeded 和 Failed。
resourceId	string	基础计算的 ARM 资源 ID

VirtualMachineImage

Object

适用于 Windows AML 计算的虚拟机映像

名称	类型	说明
id	string	虚拟机映像路径

VirtualMachineSshCredentials

Object

虚拟机的管理员凭据

名称	类型	说明
password	string	管理员帐户的密码
privateKeyData	string	私钥数据
publicKeyData	string	公钥数据
username	string	管理员帐户的用户名

VmPriority

枚举

虚拟机优先级

值	说明
Dedicated
LowPriority

VolumeDefinition

Object

描述容器的卷配置

名称	类型	默认值	说明
bind	BindOptions		装载的绑定选项
consistency	string		卷的一致性
readOnly	boolean		指示是否将卷装载为 readOnly。 默认值为 false。
source	string		装载的源。 对于绑定装载，这是主机路径。
target	string		装载的目标。 对于绑定装载，这是容器中的路径。
tmpfs	TmpfsOptions		mount 的 tmpfs 选项
type	VolumeDefinitionType	bind	卷定义的类型 卷定义的类型。 可能的值：bind、volume、tmpfs、npipe
volume	VolumeOptions		装载的卷选项

VolumeDefinitionType

枚举

卷定义的类型

值	说明
bind
npipe
tmpfs
volume

VolumeOptions

Object

描述容器的卷选项

名称	类型	说明
nocopy	boolean	指示卷是否为 nocopy