machinelearningservices.azure.com/v1api20210701

Package v1api20210701 contains API Schema definitions for the machinelearningservices v1api20210701 API group

Resource Types:

AKS

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` AKS_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` AKS_Properties	Properties: AKS properties
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

AKS_ComputeType (`string` alias)

(Appears on:AKS)

Value	Description
"AKS"

AKS_ComputeType_STATUS (`string` alias)

(Appears on:AKS_STATUS)

Value	Description
"AKS"

AKS_Properties

(Appears on:AKS)

Field	Description
`agentCount` int	AgentCount: Number of agents
`agentVmSize` string	AgentVmSize: Agent virtual machine size
`aksNetworkingConfiguration` AksNetworkingConfiguration	AksNetworkingConfiguration: AKS networking configuration for vnet
`clusterFqdn` string	ClusterFqdn: Cluster full qualified domain name
`clusterPurpose` AKS_Properties_ClusterPurpose	ClusterPurpose: Intended usage of the cluster
`loadBalancerSubnet` string	LoadBalancerSubnet: Load Balancer Subnet
`loadBalancerType` AKS_Properties_LoadBalancerType	LoadBalancerType: Load Balancer Type
`sslConfiguration` SslConfiguration	SslConfiguration: SSL configuration

AKS_Properties_ClusterPurpose (`string` alias)

(Appears on:AKS_Properties)

Value	Description
"DenseProd"
"DevTest"
"FastProd"

AKS_Properties_ClusterPurpose_STATUS (`string` alias)

(Appears on:AKS_Properties_STATUS)

Value	Description
"DenseProd"
"DevTest"
"FastProd"

AKS_Properties_LoadBalancerType (`string` alias)

(Appears on:AKS_Properties)

Value	Description
"InternalLoadBalancer"
"PublicIp"

AKS_Properties_LoadBalancerType_STATUS (`string` alias)

(Appears on:AKS_Properties_STATUS)

Value	Description
"InternalLoadBalancer"
"PublicIp"

AKS_Properties_STATUS

(Appears on:AKS_STATUS)

Field	Description
`agentCount` int	AgentCount: Number of agents
`agentVmSize` string	AgentVmSize: Agent virtual machine size
`aksNetworkingConfiguration` AksNetworkingConfiguration_STATUS	AksNetworkingConfiguration: AKS networking configuration for vnet
`clusterFqdn` string	ClusterFqdn: Cluster full qualified domain name
`clusterPurpose` AKS_Properties_ClusterPurpose_STATUS	ClusterPurpose: Intended usage of the cluster
`loadBalancerSubnet` string	LoadBalancerSubnet: Load Balancer Subnet
`loadBalancerType` AKS_Properties_LoadBalancerType_STATUS	LoadBalancerType: Load Balancer Type
`sslConfiguration` SslConfiguration_STATUS	SslConfiguration: SSL configuration
`systemServices` []SystemService_STATUS	SystemServices: System services

AKS_ProvisioningState_STATUS (`string` alias)

(Appears on:AKS_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

AKS_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` AKS_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` AKS_Properties_STATUS	Properties: AKS properties
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` AKS_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

APIVersion (`string` alias)

Value	Description
"2021-07-01"

AksNetworkingConfiguration

(Appears on:AKS_Properties)

Advance configuration for AKS networking

Field	Description
`dnsServiceIP` string	DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
`dockerBridgeCidr` string	DockerBridgeCidr: 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	ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
`subnetReference` genruntime.ResourceReference	SubnetReference: Virtual network subnet resource ID the compute nodes belong to

AksNetworkingConfiguration_STATUS

(Appears on:AKS_Properties_STATUS)

Advance configuration for AKS networking

Field	Description
`dnsServiceIP` string	DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
`dockerBridgeCidr` string	DockerBridgeCidr: 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	ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
`subnetId` string	SubnetId: Virtual network subnet resource ID the compute nodes belong to

AmlCompute

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` AmlCompute_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` AmlComputeProperties	Properties: Properties of AmlCompute
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

AmlComputeProperties

(Appears on:AmlCompute)

AML Compute properties

Field	Description
`enableNodePublicIp` bool	EnableNodePublicIp: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
`isolatedNetwork` bool	IsolatedNetwork: Network is isolated or not
`osType` AmlComputeProperties_OsType	OsType: Compute OS Type
`remoteLoginPortPublicAccess` AmlComputeProperties_RemoteLoginPortPublicAccess	RemoteLoginPortPublicAccess: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.
`scaleSettings` ScaleSettings	ScaleSettings: Scale settings for AML Compute
`subnet` ResourceId	Subnet: Virtual network subnet resource ID the compute nodes belong to.
`userAccountCredentials` UserAccountCredentials	UserAccountCredentials: Credentials for an administrator user account that will be created on each compute node.
`virtualMachineImage` VirtualMachineImage	VirtualMachineImage: Virtual Machine image for AML Compute - windows only
`vmPriority` AmlComputeProperties_VmPriority	VmPriority: Virtual Machine priority
`vmSize` string	VmSize: Virtual Machine Size

AmlComputeProperties_AllocationState_STATUS (`string` alias)

(Appears on:AmlComputeProperties_STATUS)

Value	Description
"Resizing"
"Steady"

AmlComputeProperties_OsType (`string` alias)

(Appears on:AmlComputeProperties)

Value	Description
"Linux"
"Windows"

AmlComputeProperties_OsType_STATUS (`string` alias)

(Appears on:AmlComputeProperties_STATUS)

Value	Description
"Linux"
"Windows"

AmlComputeProperties_RemoteLoginPortPublicAccess (`string` alias)

(Appears on:AmlComputeProperties)

Value	Description
"Disabled"
"Enabled"
"NotSpecified"

AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS (`string` alias)

(Appears on:AmlComputeProperties_STATUS)

Value	Description
"Disabled"
"Enabled"
"NotSpecified"

AmlComputeProperties_STATUS

(Appears on:AmlCompute_STATUS)

AML Compute properties

Field	Description
`allocationState` AmlComputeProperties_AllocationState_STATUS	AllocationState: Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.
`allocationStateTransitionTime` string	AllocationStateTransitionTime: The time at which the compute entered its current allocation state.
`currentNodeCount` int	CurrentNodeCount: The number of compute nodes currently assigned to the compute.
`enableNodePublicIp` bool	EnableNodePublicIp: Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
`errors` []ErrorResponse_STATUS	Errors: Collection of errors encountered by various compute nodes during node setup.
`isolatedNetwork` bool	IsolatedNetwork: Network is isolated or not
`nodeStateCounts` NodeStateCounts_STATUS	NodeStateCounts: Counts of various node states on the compute.
`osType` AmlComputeProperties_OsType_STATUS	OsType: Compute OS Type
`remoteLoginPortPublicAccess` AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS	RemoteLoginPortPublicAccess: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.
`scaleSettings` ScaleSettings_STATUS	ScaleSettings: Scale settings for AML Compute
`subnet` ResourceId_STATUS	Subnet: Virtual network subnet resource ID the compute nodes belong to.
`targetNodeCount` int	TargetNodeCount: The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.
`userAccountCredentials` UserAccountCredentials_STATUS	UserAccountCredentials: Credentials for an administrator user account that will be created on each compute node.
`virtualMachineImage` VirtualMachineImage_STATUS	VirtualMachineImage: Virtual Machine image for AML Compute - windows only
`vmPriority` AmlComputeProperties_VmPriority_STATUS	VmPriority: Virtual Machine priority
`vmSize` string	VmSize: Virtual Machine Size

AmlComputeProperties_VmPriority (`string` alias)

(Appears on:AmlComputeProperties)

Value	Description
"Dedicated"
"LowPriority"

AmlComputeProperties_VmPriority_STATUS (`string` alias)

(Appears on:AmlComputeProperties_STATUS)

Value	Description
"Dedicated"
"LowPriority"

AmlCompute_ComputeType (`string` alias)

(Appears on:AmlCompute)

Value	Description
"AmlCompute"

AmlCompute_ComputeType_STATUS (`string` alias)

(Appears on:AmlCompute_STATUS)

Value	Description
"AmlCompute"

AmlCompute_ProvisioningState_STATUS (`string` alias)

(Appears on:AmlCompute_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

AmlCompute_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` AmlCompute_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` AmlComputeProperties_STATUS	Properties: Properties of AmlCompute
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` AmlCompute_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

AssignedUser

(Appears on:PersonalComputeInstanceSettings)

A user that can be assigned to a compute instance.

Field	Description
`objectId` string	ObjectId: User’s AAD Object Id.
`tenantId` string	TenantId: User’s AAD Tenant Id.

AssignedUser_STATUS

(Appears on:PersonalComputeInstanceSettings_STATUS)

A user that can be assigned to a compute instance.

Field	Description
`objectId` string	ObjectId: User’s AAD Object Id.
`tenantId` string	TenantId: User’s AAD Tenant Id.

AutoPauseProperties

(Appears on:SynapseSpark_Properties)

Auto pause properties

Field	Description
`delayInMinutes` int
`enabled` bool

AutoPauseProperties_STATUS

(Appears on:SynapseSpark_Properties_STATUS)

Auto pause properties

Field	Description
`delayInMinutes` int
`enabled` bool

AutoScaleProperties

(Appears on:SynapseSpark_Properties)

Auto scale properties

Field	Description
`enabled` bool
`maxNodeCount` int
`minNodeCount` int

AutoScaleProperties_STATUS

(Appears on:SynapseSpark_Properties_STATUS)

Auto scale properties

Field	Description
`enabled` bool
`maxNodeCount` int
`minNodeCount` int

Compute

(Appears on:WorkspacesCompute_Spec)

Field	Description
`aks` AKS	AKS: Mutually exclusive with all other properties
`amlCompute` AmlCompute	AmlCompute: Mutually exclusive with all other properties
`computeInstance` ComputeInstance	ComputeInstance: Mutually exclusive with all other properties
`dataFactory` DataFactory	DataFactory: Mutually exclusive with all other properties
`dataLakeAnalytics` DataLakeAnalytics	DataLakeAnalytics: Mutually exclusive with all other properties
`databricks` Databricks	Databricks: Mutually exclusive with all other properties
`hdInsight` HDInsight	HDInsight: Mutually exclusive with all other properties
`kubernetes` Kubernetes	Kubernetes: Mutually exclusive with all other properties
`synapseSpark` SynapseSpark	SynapseSpark: Mutually exclusive with all other properties
`virtualMachine` VirtualMachine	VirtualMachine: Mutually exclusive with all other properties

ComputeInstance

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` ComputeInstance_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` ComputeInstanceProperties	Properties: Properties of ComputeInstance
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

ComputeInstanceApplication_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

Defines an Aml Instance application and its connectivity endpoint URI.

Field	Description
`displayName` string	DisplayName: Name of the ComputeInstance application.
`endpointUri` string	EndpointUri: Application’ endpoint URI.

ComputeInstanceConnectivityEndpoints_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

Defines all connectivity endpoints and properties for an ComputeInstance.

Field	Description
`privateIpAddress` string	PrivateIpAddress: Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).
`publicIpAddress` string	PublicIpAddress: Public IP Address of this ComputeInstance.

ComputeInstanceCreatedBy_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

Describes information on user who created this ComputeInstance.

Field	Description
`userId` string	UserId: Uniquely identifies the user within his/her organization.
`userName` string	UserName: Name of the user.
`userOrgId` string	UserOrgId: Uniquely identifies user’ Azure Active Directory organization.

ComputeInstanceLastOperation_OperationName_STATUS (`string` alias)

(Appears on:ComputeInstanceLastOperation_STATUS)

Value	Description
"Create"
"Delete"
"Reimage"
"Restart"
"Start"
"Stop"

ComputeInstanceLastOperation_OperationStatus_STATUS (`string` alias)

(Appears on:ComputeInstanceLastOperation_STATUS)

Value	Description
"CreateFailed"
"DeleteFailed"
"InProgress"
"ReimageFailed"
"RestartFailed"
"StartFailed"
"StopFailed"
"Succeeded"

ComputeInstanceLastOperation_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

The last operation on ComputeInstance.

Field	Description
`operationName` ComputeInstanceLastOperation_OperationName_STATUS	OperationName: Name of the last operation.
`operationStatus` ComputeInstanceLastOperation_OperationStatus_STATUS	OperationStatus: Operation status.
`operationTime` string	OperationTime: Time of the last operation.

ComputeInstanceProperties

(Appears on:ComputeInstance)

Compute Instance properties

Field	Description
`applicationSharingPolicy` ComputeInstanceProperties_ApplicationSharingPolicy	ApplicationSharingPolicy: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.
`computeInstanceAuthorizationType` ComputeInstanceProperties_ComputeInstanceAuthorizationType	ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default).
`personalComputeInstanceSettings` PersonalComputeInstanceSettings	PersonalComputeInstanceSettings: Settings for a personal compute instance.
`setupScripts` SetupScripts	SetupScripts: Details of customized scripts to execute for setting up the cluster.
`sshSettings` ComputeInstanceSshSettings	SshSettings: Specifies policy and settings for SSH access.
`subnet` ResourceId	Subnet: Virtual network subnet resource ID the compute nodes belong to.
`vmSize` string	VmSize: Virtual Machine Size

ComputeInstanceProperties_ApplicationSharingPolicy (`string` alias)

(Appears on:ComputeInstanceProperties)

Value	Description
"Personal"
"Shared"

ComputeInstanceProperties_ApplicationSharingPolicy_STATUS (`string` alias)

(Appears on:ComputeInstanceProperties_STATUS)

Value	Description
"Personal"
"Shared"

ComputeInstanceProperties_ComputeInstanceAuthorizationType (`string` alias)

(Appears on:ComputeInstanceProperties)

Value	Description
"personal"

ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS (`string` alias)

(Appears on:ComputeInstanceProperties_STATUS)

Value	Description
"personal"

ComputeInstanceProperties_STATUS

(Appears on:ComputeInstance_STATUS)

Compute Instance properties

Field	Description
`applicationSharingPolicy` ComputeInstanceProperties_ApplicationSharingPolicy_STATUS	ApplicationSharingPolicy: Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.
`applications` []ComputeInstanceApplication_STATUS	Applications: Describes available applications and their endpoints on this ComputeInstance.
`computeInstanceAuthorizationType` ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS	ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default).
`connectivityEndpoints` ComputeInstanceConnectivityEndpoints_STATUS	ConnectivityEndpoints: Describes all connectivity endpoints available for this ComputeInstance.
`createdBy` ComputeInstanceCreatedBy_STATUS	CreatedBy: Describes information on user who created this ComputeInstance.
`errors` []ErrorResponse_STATUS	Errors: Collection of errors encountered on this ComputeInstance.
`lastOperation` ComputeInstanceLastOperation_STATUS	LastOperation: The last operation on ComputeInstance.
`personalComputeInstanceSettings` PersonalComputeInstanceSettings_STATUS	PersonalComputeInstanceSettings: Settings for a personal compute instance.
`setupScripts` SetupScripts_STATUS	SetupScripts: Details of customized scripts to execute for setting up the cluster.
`sshSettings` ComputeInstanceSshSettings_STATUS	SshSettings: Specifies policy and settings for SSH access.
`state` ComputeInstanceState_STATUS	State: The current state of this ComputeInstance.
`subnet` ResourceId_STATUS	Subnet: Virtual network subnet resource ID the compute nodes belong to.
`vmSize` string	VmSize: Virtual Machine Size

ComputeInstanceSshSettings

(Appears on:ComputeInstanceProperties)

Specifies policy and settings for SSH access.

Field	Description
`adminPublicKey` string	AdminPublicKey: Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.
`sshPublicAccess` ComputeInstanceSshSettings_SshPublicAccess	SshPublicAccess: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.

ComputeInstanceSshSettings_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

Specifies policy and settings for SSH access.

Field	Description
`adminPublicKey` string	AdminPublicKey: 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	AdminUserName: Describes the admin user name.
`sshPort` int	SshPort: Describes the port for connecting through SSH.
`sshPublicAccess` ComputeInstanceSshSettings_SshPublicAccess_STATUS	SshPublicAccess: State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.

ComputeInstanceSshSettings_SshPublicAccess (`string` alias)

(Appears on:ComputeInstanceSshSettings)

Value	Description
"Disabled"
"Enabled"

ComputeInstanceSshSettings_SshPublicAccess_STATUS (`string` alias)

(Appears on:ComputeInstanceSshSettings_STATUS)

Value	Description
"Disabled"
"Enabled"

ComputeInstanceState_STATUS (`string` alias)

(Appears on:ComputeInstanceProperties_STATUS)

Current state of an ComputeInstance.

Value	Description
"CreateFailed"
"Creating"
"Deleting"
"JobRunning"
"Restarting"
"Running"
"SettingUp"
"SetupFailed"
"Starting"
"Stopped"
"Stopping"
"Unknown"
"Unusable"
"UserSettingUp"
"UserSetupFailed"

ComputeInstance_ComputeType (`string` alias)

(Appears on:ComputeInstance)

Value	Description
"ComputeInstance"

ComputeInstance_ComputeType_STATUS (`string` alias)

(Appears on:ComputeInstance_STATUS)

Value	Description
"ComputeInstance"

ComputeInstance_ProvisioningState_STATUS (`string` alias)

(Appears on:ComputeInstance_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

ComputeInstance_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` ComputeInstance_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` ComputeInstanceProperties_STATUS	Properties: Properties of ComputeInstance
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` ComputeInstance_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

Compute_STATUS

(Appears on:WorkspacesCompute_STATUS)

Field	Description
`aks` AKS_STATUS	AKS: Mutually exclusive with all other properties
`amlCompute` AmlCompute_STATUS	AmlCompute: Mutually exclusive with all other properties
`computeInstance` ComputeInstance_STATUS	ComputeInstance: Mutually exclusive with all other properties
`dataFactory` DataFactory_STATUS	DataFactory: Mutually exclusive with all other properties
`dataLakeAnalytics` DataLakeAnalytics_STATUS	DataLakeAnalytics: Mutually exclusive with all other properties
`databricks` Databricks_STATUS	Databricks: Mutually exclusive with all other properties
`hdInsight` HDInsight_STATUS	HDInsight: Mutually exclusive with all other properties
`kubernetes` Kubernetes_STATUS	Kubernetes: Mutually exclusive with all other properties
`synapseSpark` SynapseSpark_STATUS	SynapseSpark: Mutually exclusive with all other properties
`virtualMachine` VirtualMachine_STATUS	VirtualMachine: Mutually exclusive with all other properties

CosmosDbSettings

(Appears on:ServiceManagedResourcesSettings)

Field	Description
`collectionsThroughput` int	CollectionsThroughput: The throughput of the collections in cosmosdb database

CosmosDbSettings_STATUS

(Appears on:ServiceManagedResourcesSettings_STATUS)

Field	Description
`collectionsThroughput` int	CollectionsThroughput: The throughput of the collections in cosmosdb database

DataFactory

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` DataFactory_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

DataFactory_ComputeType (`string` alias)

(Appears on:DataFactory)

Value	Description
"DataFactory"

DataFactory_ComputeType_STATUS (`string` alias)

(Appears on:DataFactory_STATUS)

Value	Description
"DataFactory"

DataFactory_ProvisioningState_STATUS (`string` alias)

(Appears on:DataFactory_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

DataFactory_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` DataFactory_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` DataFactory_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

DataLakeAnalytics

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` DataLakeAnalytics_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` DataLakeAnalytics_Properties
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

DataLakeAnalytics_ComputeType (`string` alias)

(Appears on:DataLakeAnalytics)

Value	Description
"DataLakeAnalytics"

DataLakeAnalytics_ComputeType_STATUS (`string` alias)

(Appears on:DataLakeAnalytics_STATUS)

Value	Description
"DataLakeAnalytics"

DataLakeAnalytics_Properties

(Appears on:DataLakeAnalytics)

Field	Description
`dataLakeStoreAccountName` string	DataLakeStoreAccountName: DataLake Store Account Name

DataLakeAnalytics_Properties_STATUS

(Appears on:DataLakeAnalytics_STATUS)

Field	Description
`dataLakeStoreAccountName` string	DataLakeStoreAccountName: DataLake Store Account Name

DataLakeAnalytics_ProvisioningState_STATUS (`string` alias)

(Appears on:DataLakeAnalytics_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

DataLakeAnalytics_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` DataLakeAnalytics_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` DataLakeAnalytics_Properties_STATUS
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` DataLakeAnalytics_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

Databricks

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` Databricks_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` DatabricksProperties	Properties: Properties of Databricks
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

DatabricksProperties

(Appears on:Databricks)

Properties of Databricks

Field	Description
`databricksAccessToken` genruntime.SecretReference	DatabricksAccessToken: Databricks access token
`workspaceUrl` string	WorkspaceUrl: Workspace Url

DatabricksProperties_STATUS

(Appears on:Databricks_STATUS)

Properties of Databricks

Field	Description
`workspaceUrl` string	WorkspaceUrl: Workspace Url

Databricks_ComputeType (`string` alias)

(Appears on:Databricks)

Value	Description
"Databricks"

Databricks_ComputeType_STATUS (`string` alias)

(Appears on:Databricks_STATUS)

Value	Description
"Databricks"

Databricks_ProvisioningState_STATUS (`string` alias)

(Appears on:Databricks_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

Databricks_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` Databricks_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` DatabricksProperties_STATUS	Properties: Properties of Databricks
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` Databricks_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

EncryptionProperty

(Appears on:Workspace_Spec)

Field	Description
`identity` IdentityForCmk	Identity: The identity that will be used to access the key vault for encryption at rest.
`keyVaultProperties` KeyVaultProperties	KeyVaultProperties: Customer Key vault properties.

EncryptionProperty_STATUS

(Appears on:Workspace_STATUS)

Field	Description
`identity` IdentityForCmk_STATUS	Identity: The identity that will be used to access the key vault for encryption at rest.
`keyVaultProperties` KeyVaultProperties_STATUS	KeyVaultProperties: Customer Key vault properties.
`status` EncryptionProperty_Status_STATUS	Status: Indicates whether or not the encryption is enabled for the workspace.

EncryptionProperty_Status_STATUS (`string` alias)

(Appears on:EncryptionProperty_STATUS)

Value	Description
"Disabled"
"Enabled"

ErrorAdditionalInfo_STATUS

(Appears on:ErrorDetail_STATUS, ErrorDetail_STATUS_Unrolled)

The resource management error additional info.

Field	Description
`info` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Info: The additional info.
`type` string	Type: The additional info type.

ErrorDetail_STATUS

(Appears on:ErrorResponse_STATUS)

The error detail.

Field	Description
`additionalInfo` []ErrorAdditionalInfo_STATUS	AdditionalInfo: The error additional info.
`code` string	Code: The error code.
`details` []ErrorDetail_STATUS_Unrolled	Details: The error details.
`message` string	Message: The error message.
`target` string	Target: The error target.

ErrorDetail_STATUS_Unrolled

(Appears on:ErrorDetail_STATUS)

Field	Description
`additionalInfo` []ErrorAdditionalInfo_STATUS	AdditionalInfo: The error additional info.
`code` string	Code: The error code.
`message` string	Message: The error message.
`target` string	Target: The error target.

ErrorResponse_STATUS

(Appears on:AKS_STATUS, AmlComputeProperties_STATUS, AmlCompute_STATUS, ComputeInstanceProperties_STATUS, ComputeInstance_STATUS, DataFactory_STATUS, DataLakeAnalytics_STATUS, Databricks_STATUS, HDInsight_STATUS, Kubernetes_STATUS, SynapseSpark_STATUS, VirtualMachine_STATUS)

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Field	Description
`error` ErrorDetail_STATUS	Error: The error object.

HDInsight

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` HDInsight_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` HDInsightProperties	Properties: HDInsight compute properties
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

HDInsightProperties

(Appears on:HDInsight)

HDInsight compute properties

Field	Description
`address` string	Address: Public IP address of the master node of the cluster.
`administratorAccount` VirtualMachineSshCredentials	AdministratorAccount: Admin credentials for master node of the cluster
`sshPort` int	SshPort: Port open for ssh connections on the master node of the cluster.

HDInsightProperties_STATUS

(Appears on:HDInsight_STATUS)

HDInsight compute properties

Field	Description
`address` string	Address: Public IP address of the master node of the cluster.
`administratorAccount` VirtualMachineSshCredentials_STATUS	AdministratorAccount: Admin credentials for master node of the cluster
`sshPort` int	SshPort: Port open for ssh connections on the master node of the cluster.

HDInsight_ComputeType (`string` alias)

(Appears on:HDInsight)

Value	Description
"HDInsight"

HDInsight_ComputeType_STATUS (`string` alias)

(Appears on:HDInsight_STATUS)

Value	Description
"HDInsight"

HDInsight_ProvisioningState_STATUS (`string` alias)

(Appears on:HDInsight_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

HDInsight_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` HDInsight_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` HDInsightProperties_STATUS	Properties: HDInsight compute properties
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` HDInsight_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

Identity

(Appears on:Workspace_Spec, WorkspacesCompute_Spec)

Identity for the resource.

Field	Description
`type` Identity_Type	Type: The identity type.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: The user assigned identities associated with the resource.

IdentityForCmk

(Appears on:EncryptionProperty)

Identity that will be used to access key vault for encryption at rest

Field	Description
`userAssignedIdentity` string	UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault

IdentityForCmk_STATUS

(Appears on:EncryptionProperty_STATUS)

Identity that will be used to access key vault for encryption at rest

Field	Description
`userAssignedIdentity` string	UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault

Identity_STATUS

(Appears on:Workspace_STATUS, WorkspacesCompute_STATUS)

Identity for the resource.

Field	Description
`principalId` string	PrincipalId: The principal ID of resource identity.
`tenantId` string	TenantId: The tenant ID of resource.
`type` Identity_Type_STATUS	Type: The identity type.
`userAssignedIdentities` map[string]./api/machinelearningservices/v1api20210701.UserAssignedIdentity_STATUS	UserAssignedIdentities: The user assigned identities associated with the resource.

Identity_Type (`string` alias)

(Appears on:Identity)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"

Identity_Type_STATUS (`string` alias)

(Appears on:Identity_STATUS)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"

InstanceTypeSchema

(Appears on:KubernetesProperties)

Instance type schema.

Field	Description
`nodeSelector` map[string]string	NodeSelector: Node Selector
`resources` InstanceTypeSchema_Resources	Resources: Resource requests/limits for this instance type

InstanceTypeSchema_Resources

(Appears on:InstanceTypeSchema)

Field	Description
`limits` map[string]string	Limits: Resource limits for this instance type
`requests` map[string]string	Requests: Resource requests for this instance type

InstanceTypeSchema_Resources_STATUS

(Appears on:InstanceTypeSchema_STATUS)

Field	Description
`limits` map[string]string	Limits: Resource limits for this instance type
`requests` map[string]string	Requests: Resource requests for this instance type

InstanceTypeSchema_STATUS

(Appears on:KubernetesProperties_STATUS)

Instance type schema.

Field	Description
`nodeSelector` map[string]string	NodeSelector: Node Selector
`resources` InstanceTypeSchema_Resources_STATUS	Resources: Resource requests/limits for this instance type

KeyVaultProperties

(Appears on:EncryptionProperty)

Field	Description
`identityClientId` string	IdentityClientId: For future use - The client id of the identity which will be used to access key vault.
`keyIdentifier` string	KeyIdentifier: Key vault uri to access the encryption key.
`keyVaultArmId` string	KeyVaultArmId: The ArmId of the keyVault where the customer owned encryption key is present.

KeyVaultProperties_STATUS

(Appears on:EncryptionProperty_STATUS)

Field	Description
`identityClientId` string	IdentityClientId: For future use - The client id of the identity which will be used to access key vault.
`keyIdentifier` string	KeyIdentifier: Key vault uri to access the encryption key.
`keyVaultArmId` string	KeyVaultArmId: The ArmId of the keyVault where the customer owned encryption key is present.

Kubernetes

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` Kubernetes_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` KubernetesProperties	Properties: Properties of Kubernetes
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

KubernetesProperties

(Appears on:Kubernetes)

Kubernetes properties

Field	Description
`defaultInstanceType` string	DefaultInstanceType: Default instance type
`extensionInstanceReleaseTrain` string	ExtensionInstanceReleaseTrain: Extension instance release train.
`extensionPrincipalId` string	ExtensionPrincipalId: Extension principal-id.
`instanceTypes` map[string]./api/machinelearningservices/v1api20210701.InstanceTypeSchema	InstanceTypes: Instance Type Schema
`namespace` string	Namespace: Compute namespace
`relayConnectionString` genruntime.SecretReference	RelayConnectionString: Relay connection string.
`serviceBusConnectionString` genruntime.SecretReference	ServiceBusConnectionString: ServiceBus connection string.
`vcName` string	VcName: VC name.

KubernetesProperties_STATUS

(Appears on:Kubernetes_STATUS)

Kubernetes properties

Field	Description
`defaultInstanceType` string	DefaultInstanceType: Default instance type
`extensionInstanceReleaseTrain` string	ExtensionInstanceReleaseTrain: Extension instance release train.
`extensionPrincipalId` string	ExtensionPrincipalId: Extension principal-id.
`instanceTypes` map[string]./api/machinelearningservices/v1api20210701.InstanceTypeSchema_STATUS	InstanceTypes: Instance Type Schema
`namespace` string	Namespace: Compute namespace
`vcName` string	VcName: VC name.

Kubernetes_ComputeType (`string` alias)

(Appears on:Kubernetes)

Value	Description
"Kubernetes"

Kubernetes_ComputeType_STATUS (`string` alias)

(Appears on:Kubernetes_STATUS)

Value	Description
"Kubernetes"

Kubernetes_ProvisioningState_STATUS (`string` alias)

(Appears on:Kubernetes_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

Kubernetes_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` Kubernetes_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` KubernetesProperties_STATUS	Properties: Properties of Kubernetes
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` Kubernetes_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

NodeStateCounts_STATUS

(Appears on:AmlComputeProperties_STATUS)

Counts of various compute node states on the amlCompute.

Field	Description
`idleNodeCount` int	IdleNodeCount: Number of compute nodes in idle state.
`leavingNodeCount` int	LeavingNodeCount: Number of compute nodes which are leaving the amlCompute.
`preemptedNodeCount` int	PreemptedNodeCount: Number of compute nodes which are in preempted state.
`preparingNodeCount` int	PreparingNodeCount: Number of compute nodes which are being prepared.
`runningNodeCount` int	RunningNodeCount: Number of compute nodes which are running jobs.
`unusableNodeCount` int	UnusableNodeCount: Number of compute nodes which are in unusable state.

NotebookPreparationError_STATUS

(Appears on:NotebookResourceInfo_STATUS)

Field	Description
`errorMessage` string
`statusCode` int

NotebookResourceInfo_STATUS

(Appears on:Workspace_STATUS)

Field	Description
`fqdn` string
`notebookPreparationError` NotebookPreparationError_STATUS	NotebookPreparationError: The error that occurs when preparing notebook.
`resourceId` string	ResourceId: the data plane resourceId that used to initialize notebook component

PersonalComputeInstanceSettings

(Appears on:ComputeInstanceProperties)

Settings for a personal compute instance.

Field	Description
`assignedUser` AssignedUser	AssignedUser: A user explicitly assigned to a personal compute instance.

PersonalComputeInstanceSettings_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

Settings for a personal compute instance.

Field	Description
`assignedUser` AssignedUser_STATUS	AssignedUser: A user explicitly assigned to a personal compute instance.

PrivateEndpointConnection_STATUS

(Appears on:Workspace_STATUS)

The Private Endpoint Connection resource.

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

PrivateEndpointServiceConnectionStatus (`string` alias)

(Appears on:SharedPrivateLinkResource)

The private endpoint connection status.

Value	Description
"Approved"
"Disconnected"
"Pending"
"Rejected"
"Timeout"

PrivateEndpointServiceConnectionStatus_STATUS (`string` alias)

(Appears on:SharedPrivateLinkResource_STATUS)

The private endpoint connection status.

Value	Description
"Approved"
"Disconnected"
"Pending"
"Rejected"
"Timeout"

ResourceId

(Appears on:AmlComputeProperties, ComputeInstanceProperties)

Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

Field	Description
`reference` genruntime.ResourceReference	Reference: The ID of the resource

ResourceId_STATUS

(Appears on:AmlComputeProperties_STATUS, ComputeInstanceProperties_STATUS)

Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

Field	Description
`id` string	Id: The ID of the resource

ScaleSettings

(Appears on:AmlComputeProperties)

scale settings for AML Compute

Field	Description
`maxNodeCount` int	MaxNodeCount: Max number of nodes to use
`minNodeCount` int	MinNodeCount: Min number of nodes to use
`nodeIdleTimeBeforeScaleDown` string	NodeIdleTimeBeforeScaleDown: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

ScaleSettings_STATUS

(Appears on:AmlComputeProperties_STATUS)

scale settings for AML Compute

Field	Description
`maxNodeCount` int	MaxNodeCount: Max number of nodes to use
`minNodeCount` int	MinNodeCount: Min number of nodes to use
`nodeIdleTimeBeforeScaleDown` string	NodeIdleTimeBeforeScaleDown: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

ScriptReference

(Appears on:ScriptsToExecute)

Script reference

Field	Description
`scriptArguments` string	ScriptArguments: Optional command line arguments passed to the script to run.
`scriptData` string	ScriptData: The location of scripts in the mounted volume.
`scriptSource` string	ScriptSource: The storage source of the script: inline, workspace.
`timeout` string	Timeout: Optional time period passed to timeout command.

ScriptReference_STATUS

(Appears on:ScriptsToExecute_STATUS)

Script reference

Field	Description
`scriptArguments` string	ScriptArguments: Optional command line arguments passed to the script to run.
`scriptData` string	ScriptData: The location of scripts in the mounted volume.
`scriptSource` string	ScriptSource: The storage source of the script: inline, workspace.
`timeout` string	Timeout: Optional time period passed to timeout command.

ScriptsToExecute

(Appears on:SetupScripts)

Customized setup scripts

Field	Description
`creationScript` ScriptReference	CreationScript: Script that’s run only once during provision of the compute.
`startupScript` ScriptReference	StartupScript: Script that’s run every time the machine starts.

ScriptsToExecute_STATUS

(Appears on:SetupScripts_STATUS)

Customized setup scripts

Field	Description
`creationScript` ScriptReference_STATUS	CreationScript: Script that’s run only once during provision of the compute.
`startupScript` ScriptReference_STATUS	StartupScript: Script that’s run every time the machine starts.

ServiceManagedResourcesSettings

(Appears on:Workspace_Spec)

Field	Description
`cosmosDb` CosmosDbSettings	CosmosDb: The settings for the service managed cosmosdb account.

ServiceManagedResourcesSettings_STATUS

(Appears on:Workspace_STATUS)

Field	Description
`cosmosDb` CosmosDbSettings_STATUS	CosmosDb: The settings for the service managed cosmosdb account.

SetupScripts

(Appears on:ComputeInstanceProperties)

Details of customized scripts to execute for setting up the cluster.

Field	Description
`scripts` ScriptsToExecute	Scripts: Customized setup scripts

SetupScripts_STATUS

(Appears on:ComputeInstanceProperties_STATUS)

Details of customized scripts to execute for setting up the cluster.

Field	Description
`scripts` ScriptsToExecute_STATUS	Scripts: Customized setup scripts

SharedPrivateLinkResource

(Appears on:Workspace_Spec)

Field	Description
`groupId` string	GroupId: The private link resource group id.
`name` string	Name: Unique name of the private link.
`privateLinkResourceReference` genruntime.ResourceReference	PrivateLinkResourceReference: The resource id that private link links to.
`requestMessage` string	RequestMessage: Request message.
`status` PrivateEndpointServiceConnectionStatus	Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

SharedPrivateLinkResource_STATUS

(Appears on:Workspace_STATUS)

Field	Description
`groupId` string	GroupId: The private link resource group id.
`name` string	Name: Unique name of the private link.
`privateLinkResourceId` string	PrivateLinkResourceId: The resource id that private link links to.
`requestMessage` string	RequestMessage: Request message.
`status` PrivateEndpointServiceConnectionStatus_STATUS	Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

Sku

(Appears on:Workspace_Spec, WorkspacesCompute_Spec)

Sku of the resource

Field	Description
`name` string	Name: Name of the sku
`tier` string	Tier: Tier of the sku like Basic or Enterprise

Sku_STATUS

(Appears on:Workspace_STATUS, WorkspacesCompute_STATUS)

Sku of the resource

Field	Description
`name` string	Name: Name of the sku
`tier` string	Tier: Tier of the sku like Basic or Enterprise

SslConfiguration

(Appears on:AKS_Properties)

The ssl configuration for scoring

Field	Description
`cert` genruntime.SecretReference	Cert: Cert data
`cname` string	Cname: CNAME of the cert
`key` genruntime.SecretReference	Key: Key data
`leafDomainLabel` string	LeafDomainLabel: Leaf domain label of public endpoint
`overwriteExistingDomain` bool	OverwriteExistingDomain: Indicates whether to overwrite existing domain label.
`status` SslConfiguration_Status	Status: Enable or disable ssl for scoring

SslConfiguration_STATUS

(Appears on:AKS_Properties_STATUS)

The ssl configuration for scoring

Field	Description
`cname` string	Cname: CNAME of the cert
`leafDomainLabel` string	LeafDomainLabel: Leaf domain label of public endpoint
`overwriteExistingDomain` bool	OverwriteExistingDomain: Indicates whether to overwrite existing domain label.
`status` SslConfiguration_Status_STATUS	Status: Enable or disable ssl for scoring

SslConfiguration_Status (`string` alias)

(Appears on:SslConfiguration)

Value	Description
"Auto"
"Disabled"
"Enabled"

SslConfiguration_Status_STATUS (`string` alias)

(Appears on:SslConfiguration_STATUS)

Value	Description
"Auto"
"Disabled"
"Enabled"

SynapseSpark

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` SynapseSpark_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` SynapseSpark_Properties
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

SynapseSpark_ComputeType (`string` alias)

(Appears on:SynapseSpark)

Value	Description
"SynapseSpark"

SynapseSpark_ComputeType_STATUS (`string` alias)

(Appears on:SynapseSpark_STATUS)

Value	Description
"SynapseSpark"

SynapseSpark_Properties

(Appears on:SynapseSpark)

Field	Description
`autoPauseProperties` AutoPauseProperties	AutoPauseProperties: Auto pause properties.
`autoScaleProperties` AutoScaleProperties	AutoScaleProperties: Auto scale properties.
`nodeCount` int	NodeCount: The number of compute nodes currently assigned to the compute.
`nodeSize` string	NodeSize: Node size.
`nodeSizeFamily` string	NodeSizeFamily: Node size family.
`poolName` string	PoolName: Pool name.
`resourceGroup` string	ResourceGroup: Name of the resource group in which workspace is located.
`sparkVersion` string	SparkVersion: Spark version.
`subscriptionId` string	SubscriptionId: Azure subscription identifier.
`workspaceName` string	WorkspaceName: Name of Azure Machine Learning workspace.

SynapseSpark_Properties_STATUS

(Appears on:SynapseSpark_STATUS)

Field	Description
`autoPauseProperties` AutoPauseProperties_STATUS	AutoPauseProperties: Auto pause properties.
`autoScaleProperties` AutoScaleProperties_STATUS	AutoScaleProperties: Auto scale properties.
`nodeCount` int	NodeCount: The number of compute nodes currently assigned to the compute.
`nodeSize` string	NodeSize: Node size.
`nodeSizeFamily` string	NodeSizeFamily: Node size family.
`poolName` string	PoolName: Pool name.
`resourceGroup` string	ResourceGroup: Name of the resource group in which workspace is located.
`sparkVersion` string	SparkVersion: Spark version.
`subscriptionId` string	SubscriptionId: Azure subscription identifier.
`workspaceName` string	WorkspaceName: Name of Azure Machine Learning workspace.

SynapseSpark_ProvisioningState_STATUS (`string` alias)

(Appears on:SynapseSpark_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

SynapseSpark_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` SynapseSpark_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` SynapseSpark_Properties_STATUS
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` SynapseSpark_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

SystemData

(Appears on:Workspace_Spec, WorkspacesCompute_Spec)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType	LastModifiedByType: The type of identity that last modified the resource.

SystemData_CreatedByType (`string` alias)

(Appears on:SystemData)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType (`string` alias)

(Appears on:SystemData)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:Workspace_STATUS, WorkspacesCompute_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

SystemService_STATUS

(Appears on:AKS_Properties_STATUS)

A system service running on a compute.

Field	Description
`publicIpAddress` string	PublicIpAddress: Public IP address
`systemServiceType` string	SystemServiceType: The type of this system service.
`version` string	Version: The version for this type.

UserAccountCredentials

(Appears on:AmlComputeProperties)

Settings for user account that gets created on each on the nodes of a compute.

Field	Description
`adminUserName` string	AdminUserName: Name of the administrator user account which can be used to SSH to nodes.
`adminUserPassword` genruntime.SecretReference	AdminUserPassword: Password of the administrator user account.
`adminUserSshPublicKey` genruntime.SecretReference	AdminUserSshPublicKey: SSH public key of the administrator user account.

UserAccountCredentials_STATUS

(Appears on:AmlComputeProperties_STATUS)

Settings for user account that gets created on each on the nodes of a compute.

Field	Description
`adminUserName` string	AdminUserName: Name of the administrator user account which can be used to SSH to nodes.

UserAssignedIdentityDetails

(Appears on:Identity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserAssignedIdentity_STATUS

(Appears on:Identity_STATUS)

User Assigned Identity

Field	Description
`clientId` string	ClientId: The clientId(aka appId) of the user assigned identity.
`principalId` string	PrincipalId: The principal ID of the user assigned identity.
`tenantId` string	TenantId: The tenant ID of the user assigned identity.

VirtualMachine

(Appears on:Compute)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` VirtualMachine_ComputeType	ComputeType: The type of compute
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`properties` VirtualMachine_Properties
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource id of the underlying compute

VirtualMachineImage

(Appears on:AmlComputeProperties)

Virtual Machine image for Windows AML Compute

Field	Description
`reference` genruntime.ResourceReference	Reference: Virtual Machine image path

VirtualMachineImage_STATUS

(Appears on:AmlComputeProperties_STATUS)

Virtual Machine image for Windows AML Compute

Field	Description
`id` string	Id: Virtual Machine image path

VirtualMachineSshCredentials

(Appears on:HDInsightProperties, VirtualMachine_Properties)

Admin credentials for virtual machine

Field	Description
`password` genruntime.SecretReference	Password: Password of admin account
`privateKeyData` genruntime.SecretReference	PrivateKeyData: Private key data
`publicKeyData` genruntime.SecretReference	PublicKeyData: Public key data
`username` string	Username: Username of admin account

VirtualMachineSshCredentials_STATUS

(Appears on:HDInsightProperties_STATUS, VirtualMachine_Properties_STATUS)

Admin credentials for virtual machine

Field	Description
`username` string	Username: Username of admin account

VirtualMachine_ComputeType (`string` alias)

(Appears on:VirtualMachine)

Value	Description
"VirtualMachine"

VirtualMachine_ComputeType_STATUS (`string` alias)

(Appears on:VirtualMachine_STATUS)

Value	Description
"VirtualMachine"

VirtualMachine_Properties

(Appears on:VirtualMachine)

Field	Description
`address` string	Address: Public IP address of the virtual machine.
`administratorAccount` VirtualMachineSshCredentials	AdministratorAccount: Admin credentials for virtual machine
`isNotebookInstanceCompute` bool	IsNotebookInstanceCompute: Indicates whether this compute will be used for running notebooks.
`sshPort` int	SshPort: Port open for ssh connections.
`virtualMachineSize` string	VirtualMachineSize: Virtual Machine size

VirtualMachine_Properties_STATUS

(Appears on:VirtualMachine_STATUS)

Field	Description
`address` string	Address: Public IP address of the virtual machine.
`administratorAccount` VirtualMachineSshCredentials_STATUS	AdministratorAccount: Admin credentials for virtual machine
`isNotebookInstanceCompute` bool	IsNotebookInstanceCompute: Indicates whether this compute will be used for running notebooks.
`sshPort` int	SshPort: Port open for ssh connections.
`virtualMachineSize` string	VirtualMachineSize: Virtual Machine size

VirtualMachine_ProvisioningState_STATUS (`string` alias)

(Appears on:VirtualMachine_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

VirtualMachine_STATUS

(Appears on:Compute_STATUS)

Field	Description
`computeLocation` string	ComputeLocation: Location for the underlying compute
`computeType` VirtualMachine_ComputeType_STATUS	ComputeType: The type of compute
`createdOn` string	CreatedOn: The time at which the compute was created.
`description` string	Description: The description of the Machine Learning compute.
`disableLocalAuth` bool	DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
`isAttachedCompute` bool	IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
`modifiedOn` string	ModifiedOn: The time at which the compute was last modified.
`properties` VirtualMachine_Properties_STATUS
`provisioningErrors` []ErrorResponse_STATUS	ProvisioningErrors: Errors during provisioning
`provisioningState` VirtualMachine_ProvisioningState_STATUS	ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
`resourceId` string	ResourceId: ARM resource id of the underlying compute

Workspace

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Workspace_Spec

`allowPublicAccessWhenBehindVnet` bool	AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.
`applicationInsightsReference` genruntime.ResourceReference	ApplicationInsightsReference: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`containerRegistryReference` genruntime.ResourceReference	ContainerRegistryReference: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created
`description` string	Description: The description of this workspace.
`discoveryUrl` string	DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services
`encryption` EncryptionProperty	Encryption: The encryption settings of Azure ML workspace.
`friendlyName` string	FriendlyName: The friendly name for this workspace. This name in mutable
`hbiWorkspace` bool	HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
`identity` Identity	Identity: The identity of the resource.
`imageBuildCompute` string	ImageBuildCompute: The compute name for image build
`keyVaultReference` genruntime.ResourceReference	KeyVaultReference: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
`location` string	Location: Specifies the location of the resource.
`operatorSpec` WorkspaceOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`primaryUserAssignedIdentityReference` genruntime.ResourceReference	PrimaryUserAssignedIdentityReference: The user assigned identity resource id that represents the workspace identity.
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess	PublicNetworkAccess: Whether requests from Public Network are allowed.
`serviceManagedResourcesSettings` ServiceManagedResourcesSettings	ServiceManagedResourcesSettings: The service managed resource settings.
`sharedPrivateLinkResources` []SharedPrivateLinkResource	SharedPrivateLinkResources: The list of shared private link resources in this workspace.
`sku` Sku	Sku: The sku of the workspace.
`storageAccountReference` genruntime.ResourceReference	StorageAccountReference: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
`systemData` SystemData	SystemData: System data
`tags` map[string]string	Tags: Contains resource tags defined as key/value pairs.

status
Workspace_STATUS

WorkspaceConnectionProps_ValueFormat (`string` alias)

(Appears on:WorkspacesConnection_Spec)

Value	Description
"JSON"

WorkspaceConnectionProps_ValueFormat_STATUS (`string` alias)

(Appears on:WorkspacesConnection_STATUS)

Value	Description
"JSON"

WorkspaceOperatorSecrets

(Appears on:WorkspaceOperatorSpec)

Field	Description
`appInsightsInstrumentationKey` genruntime.SecretDestination	AppInsightsInstrumentationKey: indicates where the AppInsightsInstrumentationKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`containerRegistryPassword` genruntime.SecretDestination	ContainerRegistryPassword: indicates where the ContainerRegistryPassword secret should be placed. If omitted, the secret will not be retrieved from Azure.
`containerRegistryPassword2` genruntime.SecretDestination	ContainerRegistryPassword2: indicates where the ContainerRegistryPassword2 secret should be placed. If omitted, the secret will not be retrieved from Azure.
`containerRegistryUserName` genruntime.SecretDestination	ContainerRegistryUserName: indicates where the ContainerRegistryUserName secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryNotebookAccessKey` genruntime.SecretDestination	PrimaryNotebookAccessKey: indicates where the PrimaryNotebookAccessKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryNotebookAccessKey` genruntime.SecretDestination	SecondaryNotebookAccessKey: indicates where the SecondaryNotebookAccessKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`userStorageKey` genruntime.SecretDestination	UserStorageKey: indicates where the UserStorageKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

WorkspaceOperatorSpec

(Appears on:Workspace_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).
`secrets` WorkspaceOperatorSecrets	Secrets: configures where to place Azure generated secrets.

WorkspaceProperties_ProvisioningState_STATUS (`string` alias)

(Appears on:Workspace_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Unknown"
"Updating"

WorkspaceProperties_PublicNetworkAccess (`string` alias)

(Appears on:Workspace_Spec)

Value	Description
"Disabled"
"Enabled"

WorkspaceProperties_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:Workspace_STATUS)

Value	Description
"Disabled"
"Enabled"

Workspace_STATUS

(Appears on:Workspace)

An object that represents a machine learning workspace.

Field	Description
`allowPublicAccessWhenBehindVnet` bool	AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.
`applicationInsights` string	ApplicationInsights: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`containerRegistry` string	ContainerRegistry: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created
`description` string	Description: The description of this workspace.
`discoveryUrl` string	DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services
`encryption` EncryptionProperty_STATUS	Encryption: The encryption settings of Azure ML workspace.
`friendlyName` string	FriendlyName: The friendly name for this workspace. This name in mutable
`hbiWorkspace` bool	HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` Identity_STATUS	Identity: The identity of the resource.
`imageBuildCompute` string	ImageBuildCompute: The compute name for image build
`keyVault` string	KeyVault: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
`location` string	Location: Specifies the location of the resource.
`mlFlowTrackingUri` string	MlFlowTrackingUri: The URI associated with this workspace that machine learning flow must point at to set up tracking.
`name` string	Name: The name of the resource
`notebookInfo` NotebookResourceInfo_STATUS	NotebookInfo: The notebook info of Azure ML workspace.
`primaryUserAssignedIdentity` string	PrimaryUserAssignedIdentity: The user assigned identity resource id that represents the workspace identity.
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: The list of private endpoint connections in the workspace.
`privateLinkCount` int	PrivateLinkCount: Count of private connections in the workspace
`provisioningState` WorkspaceProperties_ProvisioningState_STATUS	ProvisioningState: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Whether requests from Public Network are allowed.
`serviceManagedResourcesSettings` ServiceManagedResourcesSettings_STATUS	ServiceManagedResourcesSettings: The service managed resource settings.
`serviceProvisionedResourceGroup` string	ServiceProvisionedResourceGroup: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace
`sharedPrivateLinkResources` []SharedPrivateLinkResource_STATUS	SharedPrivateLinkResources: The list of shared private link resources in this workspace.
`sku` Sku_STATUS	Sku: The sku of the workspace.
`storageAccount` string	StorageAccount: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
`storageHnsEnabled` bool	StorageHnsEnabled: If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
`systemData` SystemData_STATUS	SystemData: System data
`tags` map[string]string	Tags: Contains resource tags defined as key/value pairs.
`tenantId` string	TenantId: The tenant id associated with this workspace.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`workspaceId` string	WorkspaceId: The immutable id associated with this workspace.

Workspace_Spec

(Appears on:Workspace)

Field	Description
`allowPublicAccessWhenBehindVnet` bool	AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.
`applicationInsightsReference` genruntime.ResourceReference	ApplicationInsightsReference: ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`containerRegistryReference` genruntime.ResourceReference	ContainerRegistryReference: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created
`description` string	Description: The description of this workspace.
`discoveryUrl` string	DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services
`encryption` EncryptionProperty	Encryption: The encryption settings of Azure ML workspace.
`friendlyName` string	FriendlyName: The friendly name for this workspace. This name in mutable
`hbiWorkspace` bool	HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
`identity` Identity	Identity: The identity of the resource.
`imageBuildCompute` string	ImageBuildCompute: The compute name for image build
`keyVaultReference` genruntime.ResourceReference	KeyVaultReference: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
`location` string	Location: Specifies the location of the resource.
`operatorSpec` WorkspaceOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`primaryUserAssignedIdentityReference` genruntime.ResourceReference	PrimaryUserAssignedIdentityReference: The user assigned identity resource id that represents the workspace identity.
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess	PublicNetworkAccess: Whether requests from Public Network are allowed.
`serviceManagedResourcesSettings` ServiceManagedResourcesSettings	ServiceManagedResourcesSettings: The service managed resource settings.
`sharedPrivateLinkResources` []SharedPrivateLinkResource	SharedPrivateLinkResources: The list of shared private link resources in this workspace.
`sku` Sku	Sku: The sku of the workspace.
`storageAccountReference` genruntime.ResourceReference	StorageAccountReference: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
`systemData` SystemData	SystemData: System data
`tags` map[string]string	Tags: Contains resource tags defined as key/value pairs.

WorkspacesCompute

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
WorkspacesCompute_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`identity` Identity	Identity: The identity of the resource.
`location` string	Location: Specifies the location of the resource.
`operatorSpec` WorkspacesComputeOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource
`properties` Compute	Properties: Compute properties
`sku` Sku	Sku: The sku of the workspace.
`systemData` SystemData	SystemData: System data
`tags` map[string]string	Tags: Contains resource tags defined as key/value pairs.

status
WorkspacesCompute_STATUS

WorkspacesComputeOperatorSpec

(Appears on:WorkspacesCompute_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

WorkspacesCompute_STATUS

(Appears on:WorkspacesCompute)

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` Identity_STATUS	Identity: The identity of the resource.
`location` string	Location: Specifies the location of the resource.
`name` string	Name: The name of the resource
`properties` Compute_STATUS	Properties: Compute properties
`sku` Sku_STATUS	Sku: The sku of the workspace.
`systemData` SystemData_STATUS	SystemData: System data
`tags` map[string]string	Tags: Contains resource tags defined as key/value pairs.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

WorkspacesCompute_Spec

(Appears on:WorkspacesCompute)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`identity` Identity	Identity: The identity of the resource.
`location` string	Location: Specifies the location of the resource.
`operatorSpec` WorkspacesComputeOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource
`properties` Compute	Properties: Compute properties
`sku` Sku	Sku: The sku of the workspace.
`systemData` SystemData	SystemData: System data
`tags` map[string]string	Tags: Contains resource tags defined as key/value pairs.

WorkspacesConnection

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
WorkspacesConnection_Spec

`authType` string	AuthType: Authorization type of the workspace connection.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`category` string	Category: Category of the workspace connection.
`operatorSpec` WorkspacesConnectionOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource
`target` string	Target: Target of the workspace connection.
`value` string	Value: Value details of the workspace connection.
`valueFormat` WorkspaceConnectionProps_ValueFormat	ValueFormat: format for the workspace connection value

status
WorkspacesConnection_STATUS

WorkspacesConnectionOperatorSpec

(Appears on:WorkspacesConnection_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

WorkspacesConnection_STATUS

(Appears on:WorkspacesConnection)

Field	Description
`authType` string	AuthType: Authorization type of the workspace connection.
`category` string	Category: Category of the workspace connection.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`id` string	Id: ResourceId of the workspace connection.
`name` string	Name: Friendly name of the workspace connection.
`target` string	Target: Target of the workspace connection.
`type` string	Type: Resource type of workspace connection.
`value` string	Value: Value details of the workspace connection.
`valueFormat` WorkspaceConnectionProps_ValueFormat_STATUS	ValueFormat: format for the workspace connection value

WorkspacesConnection_Spec

(Appears on:WorkspacesConnection)

Field	Description
`authType` string	AuthType: Authorization type of the workspace connection.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`category` string	Category: Category of the workspace connection.
`operatorSpec` WorkspacesConnectionOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource
`target` string	Target: Target of the workspace connection.
`value` string	Value: Value details of the workspace connection.
`valueFormat` WorkspaceConnectionProps_ValueFormat	ValueFormat: format for the workspace connection value

machinelearningservices.azure.com/v1api20210701