machinelearningservices.azure.com/v1beta20210701
machinelearningservices.azure.com/v1beta20210701
Package v1beta20210701 contains API Schema definitions for the machinelearningservices v1beta20210701 API group
AKSProperties
(Appears on:Compute_AKS)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AKSProperties
Field | Description |
---|---|
agentCount int |
AgentCount: Number of agents |
agentVmSize string |
AgentVmSize: Agent virtual machine size |
aksNetworkingConfiguration AksNetworkingConfiguration |
AksNetworkingConfiguration: Advance configuration for AKS networking |
clusterFqdn string |
ClusterFqdn: Cluster full qualified domain name |
clusterPurpose AKSPropertiesClusterPurpose |
ClusterPurpose: Intended usage of the cluster. |
loadBalancerSubnet string |
LoadBalancerSubnet: Load Balancer Subnet |
loadBalancerType AKSPropertiesLoadBalancerType |
LoadBalancerType: Load Balancer Type. |
sslConfiguration SslConfiguration |
SslConfiguration: The ssl configuration for scoring |
AKSPropertiesARM
(Appears on:Compute_AKSARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AKSProperties
Field | Description |
---|---|
agentCount int |
AgentCount: Number of agents |
agentVmSize string |
AgentVmSize: Agent virtual machine size |
aksNetworkingConfiguration AksNetworkingConfigurationARM |
AksNetworkingConfiguration: Advance configuration for AKS networking |
clusterFqdn string |
ClusterFqdn: Cluster full qualified domain name |
clusterPurpose AKSPropertiesClusterPurpose |
ClusterPurpose: Intended usage of the cluster. |
loadBalancerSubnet string |
LoadBalancerSubnet: Load Balancer Subnet |
loadBalancerType AKSPropertiesLoadBalancerType |
LoadBalancerType: Load Balancer Type. |
sslConfiguration SslConfigurationARM |
SslConfiguration: The ssl configuration for scoring |
AKSPropertiesClusterPurpose
(string
alias)
(Appears on:AKSProperties, AKSPropertiesARM)
Value | Description |
---|---|
"DenseProd" |
|
"DevTest" |
|
"FastProd" |
AKSPropertiesLoadBalancerType
(string
alias)
(Appears on:AKSProperties, AKSPropertiesARM)
Value | Description |
---|---|
"InternalLoadBalancer" |
|
"PublicIp" |
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-07-01" |
AksNetworkingConfiguration
(Appears on:AKSProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AksNetworkingConfiguration
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 |
AksNetworkingConfigurationARM
(Appears on:AKSPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AksNetworkingConfiguration
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 |
AmlComputeProperties
(Appears on:Compute_AmlCompute)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AmlComputeProperties
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 AmlComputePropertiesOsType |
OsType: Compute OS Type. |
remoteLoginPortPublicAccess AmlComputePropertiesRemoteLoginPortPublicAccess |
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: Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. |
userAccountCredentials UserAccountCredentials |
UserAccountCredentials: Settings for user account that gets created on each on the nodes of a compute. |
virtualMachineImage VirtualMachineImage |
VirtualMachineImage: Virtual Machine image for Windows AML Compute |
vmPriority AmlComputePropertiesVmPriority |
VmPriority: Virtual Machine priority. |
vmSize string |
VmSize: Virtual Machine Size |
AmlComputePropertiesARM
(Appears on:Compute_AmlComputeARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AmlComputeProperties
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 AmlComputePropertiesOsType |
OsType: Compute OS Type. |
remoteLoginPortPublicAccess AmlComputePropertiesRemoteLoginPortPublicAccess |
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 ScaleSettingsARM |
ScaleSettings: scale settings for AML Compute |
subnet ResourceIdARM |
Subnet: Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. |
userAccountCredentials UserAccountCredentialsARM |
UserAccountCredentials: Settings for user account that gets created on each on the nodes of a compute. |
virtualMachineImage VirtualMachineImageARM |
VirtualMachineImage: Virtual Machine image for Windows AML Compute |
vmPriority AmlComputePropertiesVmPriority |
VmPriority: Virtual Machine priority. |
vmSize string |
VmSize: Virtual Machine Size |
AmlComputePropertiesOsType
(string
alias)
(Appears on:AmlComputeProperties, AmlComputePropertiesARM)
Value | Description |
---|---|
"Linux" |
|
"Windows" |
AmlComputePropertiesRemoteLoginPortPublicAccess
(string
alias)
(Appears on:AmlComputeProperties, AmlComputePropertiesARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"NotSpecified" |
AmlComputePropertiesVmPriority
(string
alias)
(Appears on:AmlComputeProperties, AmlComputePropertiesARM)
Value | Description |
---|---|
"Dedicated" |
|
"LowPriority" |
AssignedUser
(Appears on:PersonalComputeInstanceSettings)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AssignedUser
Field | Description |
---|---|
objectId string |
ObjectId: User’s AAD Object Id. |
tenantId string |
TenantId: User’s AAD Tenant Id. |
AssignedUserARM
(Appears on:PersonalComputeInstanceSettingsARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AssignedUser
Field | Description |
---|---|
objectId string |
ObjectId: User’s AAD Object Id. |
tenantId string |
TenantId: User’s AAD Tenant Id. |
AutoPauseProperties
(Appears on:SynapseSparkProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AutoPauseProperties
Field | Description |
---|---|
delayInMinutes int |
|
enabled bool |
AutoPausePropertiesARM
(Appears on:SynapseSparkPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AutoPauseProperties
Field | Description |
---|---|
delayInMinutes int |
|
enabled bool |
AutoScaleProperties
(Appears on:SynapseSparkProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AutoScaleProperties
Field | Description |
---|---|
enabled bool |
|
maxNodeCount int |
|
minNodeCount int |
AutoScalePropertiesARM
(Appears on:SynapseSparkPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/AutoScaleProperties
Field | Description |
---|---|
enabled bool |
|
maxNodeCount int |
|
minNodeCount int |
Compute
(Appears on:WorkspacesComputes_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/Compute
Field | Description |
---|---|
aks Compute_AKS |
AKS: Mutually exclusive with all other properties |
amlCompute Compute_AmlCompute |
AmlCompute: Mutually exclusive with all other properties |
computeInstance Compute_ComputeInstance |
ComputeInstance: Mutually exclusive with all other properties |
dataFactory Compute_DataFactory |
DataFactory: Mutually exclusive with all other properties |
dataLakeAnalytics Compute_DataLakeAnalytics |
DataLakeAnalytics: Mutually exclusive with all other properties |
databricks Compute_Databricks |
Databricks: Mutually exclusive with all other properties |
hdInsight Compute_HDInsight |
HDInsight: Mutually exclusive with all other properties |
synapseSpark Compute_SynapseSpark |
SynapseSpark: Mutually exclusive with all other properties |
virtualMachine Compute_VirtualMachine |
VirtualMachine: Mutually exclusive with all other properties |
ComputeAKSComputeType
(string
alias)
(Appears on:Compute_AKS, Compute_AKSARM)
Value | Description |
---|---|
"AKS" |
ComputeARM
(Appears on:WorkspacesComputes_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/Compute
Field | Description |
---|---|
aks Compute_AKSARM |
AKS: Mutually exclusive with all other properties |
amlCompute Compute_AmlComputeARM |
AmlCompute: Mutually exclusive with all other properties |
computeInstance Compute_ComputeInstanceARM |
ComputeInstance: Mutually exclusive with all other properties |
dataFactory Compute_DataFactoryARM |
DataFactory: Mutually exclusive with all other properties |
dataLakeAnalytics Compute_DataLakeAnalyticsARM |
DataLakeAnalytics: Mutually exclusive with all other properties |
databricks Compute_DatabricksARM |
Databricks: Mutually exclusive with all other properties |
hdInsight Compute_HDInsightARM |
HDInsight: Mutually exclusive with all other properties |
synapseSpark Compute_SynapseSparkARM |
SynapseSpark: Mutually exclusive with all other properties |
virtualMachine Compute_VirtualMachineARM |
VirtualMachine: Mutually exclusive with all other properties |
ComputeAmlComputeComputeType
(string
alias)
(Appears on:Compute_AmlCompute, Compute_AmlComputeARM)
Value | Description |
---|---|
"AmlCompute" |
ComputeComputeInstanceComputeType
(string
alias)
(Appears on:Compute_ComputeInstance, Compute_ComputeInstanceARM)
Value | Description |
---|---|
"ComputeInstance" |
ComputeDataFactoryComputeType
(string
alias)
(Appears on:Compute_DataFactory, Compute_DataFactoryARM)
Value | Description |
---|---|
"DataFactory" |
ComputeDataLakeAnalyticsComputeType
(string
alias)
(Appears on:Compute_DataLakeAnalytics, Compute_DataLakeAnalyticsARM)
Value | Description |
---|---|
"DataLakeAnalytics" |
ComputeDatabricksComputeType
(string
alias)
(Appears on:Compute_Databricks, Compute_DatabricksARM)
Value | Description |
---|---|
"Databricks" |
ComputeHDInsightComputeType
(string
alias)
(Appears on:Compute_HDInsight, Compute_HDInsightARM)
Value | Description |
---|---|
"HDInsight" |
ComputeInstanceProperties
(Appears on:Compute_ComputeInstance)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ComputeInstanceProperties
Field | Description |
---|---|
applicationSharingPolicy ComputeInstancePropertiesApplicationSharingPolicy |
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 ComputeInstancePropertiesComputeInstanceAuthorizationType |
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: Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. |
vmSize string |
VmSize: Virtual Machine Size |
ComputeInstancePropertiesARM
(Appears on:Compute_ComputeInstanceARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ComputeInstanceProperties
Field | Description |
---|---|
applicationSharingPolicy ComputeInstancePropertiesApplicationSharingPolicy |
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 ComputeInstancePropertiesComputeInstanceAuthorizationType |
ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default). |
personalComputeInstanceSettings PersonalComputeInstanceSettingsARM |
PersonalComputeInstanceSettings: Settings for a personal compute instance. |
setupScripts SetupScriptsARM |
SetupScripts: Details of customized scripts to execute for setting up the cluster. |
sshSettings ComputeInstanceSshSettingsARM |
SshSettings: Specifies policy and settings for SSH access. |
subnet ResourceIdARM |
Subnet: Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. |
vmSize string |
VmSize: Virtual Machine Size |
ComputeInstancePropertiesApplicationSharingPolicy
(string
alias)
(Appears on:ComputeInstanceProperties, ComputeInstancePropertiesARM)
Value | Description |
---|---|
"Personal" |
|
"Shared" |
ComputeInstancePropertiesComputeInstanceAuthorizationType
(string
alias)
(Appears on:ComputeInstanceProperties, ComputeInstancePropertiesARM)
Value | Description |
---|---|
"personal" |
ComputeInstanceSshSettings
(Appears on:ComputeInstanceProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ComputeInstanceSshSettings
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 ComputeInstanceSshSettingsSshPublicAccess |
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. |
ComputeInstanceSshSettingsARM
(Appears on:ComputeInstancePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ComputeInstanceSshSettings
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 ComputeInstanceSshSettingsSshPublicAccess |
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. |
ComputeInstanceSshSettingsSshPublicAccess
(string
alias)
(Appears on:ComputeInstanceSshSettings, ComputeInstanceSshSettingsARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ComputeResource_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}p> |
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” |
ComputeResource_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_StatusARM |
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_StatusARM |
Properties: Compute properties |
sku Sku_StatusARM |
Sku: The sku of the workspace. |
systemData SystemData_StatusARM |
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” |
ComputeStatusProvisioningState
(string
alias)
(Appears on:Compute_Status, Compute_StatusARM)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Unknown" |
|
"Updating" |
ComputeSynapseSparkComputeType
(string
alias)
(Appears on:Compute_SynapseSpark, Compute_SynapseSparkARM)
Value | Description |
---|---|
"SynapseSpark" |
ComputeType_Status
(string
alias)
(Appears on:Compute_Status, Compute_StatusARM)
Value | Description |
---|---|
"AKS" |
|
"AmlCompute" |
|
"ComputeInstance" |
|
"DataFactory" |
|
"DataLakeAnalytics" |
|
"Databricks" |
|
"HDInsight" |
|
"Kubernetes" |
|
"SynapseSpark" |
|
"VirtualMachine" |
ComputeVirtualMachineComputeType
(string
alias)
(Appears on:Compute_VirtualMachine, Compute_VirtualMachineARM)
Value | Description |
---|---|
"VirtualMachine" |
Compute_AKS
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeAKSComputeType |
|
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 AKSProperties |
Properties: AKS properties |
resourceReference genruntime.ResourceReference |
ResourceReference: ARM resource id of the underlying compute |
Compute_AKSARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeAKSComputeType |
|
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 AKSPropertiesARM |
Properties: AKS properties |
resourceId string |
Compute_AmlCompute
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeAmlComputeComputeType |
|
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: AML Compute properties |
resourceReference genruntime.ResourceReference |
ResourceReference: ARM resource id of the underlying compute |
Compute_AmlComputeARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeAmlComputeComputeType |
|
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 AmlComputePropertiesARM |
Properties: AML Compute properties |
resourceId string |
Compute_ComputeInstance
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeComputeInstanceComputeType |
|
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: Compute Instance properties |
resourceReference genruntime.ResourceReference |
ResourceReference: ARM resource id of the underlying compute |
Compute_ComputeInstanceARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeComputeInstanceComputeType |
|
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 ComputeInstancePropertiesARM |
Properties: Compute Instance properties |
resourceId string |
Compute_DataFactory
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeDataFactoryComputeType |
|
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 |
Compute_DataFactoryARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeDataFactoryComputeType |
|
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. |
resourceId string |
Compute_DataLakeAnalytics
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeDataLakeAnalyticsComputeType |
|
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 DataLakeAnalyticsProperties |
|
resourceReference genruntime.ResourceReference |
ResourceReference: ARM resource id of the underlying compute |
Compute_DataLakeAnalyticsARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeDataLakeAnalyticsComputeType |
|
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 DataLakeAnalyticsPropertiesARM |
|
resourceId string |
Compute_Databricks
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeDatabricksComputeType |
|
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 |
Compute_DatabricksARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeDatabricksComputeType |
|
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 DatabricksPropertiesARM |
Properties: Properties of Databricks |
resourceId string |
Compute_HDInsight
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeHDInsightComputeType |
|
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 |
Compute_HDInsightARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeHDInsightComputeType |
|
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 HDInsightPropertiesARM |
Properties: HDInsight compute properties |
resourceId string |
Compute_Status
(Appears on:ComputeResource_Status)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType 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 ComputeStatusProvisioningState |
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_StatusARM
(Appears on:ComputeResource_StatusARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType 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_StatusARM |
ProvisioningErrors: Errors during provisioning |
provisioningState ComputeStatusProvisioningState |
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_SynapseSpark
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeSynapseSparkComputeType |
|
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 SynapseSparkProperties |
|
resourceReference genruntime.ResourceReference |
ResourceReference: ARM resource id of the underlying compute |
Compute_SynapseSparkARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeSynapseSparkComputeType |
|
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 SynapseSparkPropertiesARM |
|
resourceId string |
Compute_VirtualMachine
(Appears on:Compute)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeVirtualMachineComputeType |
|
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 VirtualMachineProperties |
|
resourceReference genruntime.ResourceReference |
ResourceReference: ARM resource id of the underlying compute |
Compute_VirtualMachineARM
(Appears on:ComputeARM)
Field | Description |
---|---|
computeLocation string |
ComputeLocation: Location for the underlying compute |
computeType ComputeVirtualMachineComputeType |
|
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 VirtualMachinePropertiesARM |
|
resourceId string |
CosmosDbSettings
(Appears on:ServiceManagedResourcesSettings)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/CosmosDbSettings
Field | Description |
---|---|
collectionsThroughput int |
CollectionsThroughput: The throughput of the collections in cosmosdb database |
CosmosDbSettingsARM
(Appears on:ServiceManagedResourcesSettingsARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/CosmosDbSettings
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 |
CosmosDbSettings_StatusARM
(Appears on:ServiceManagedResourcesSettings_StatusARM)
Field | Description |
---|---|
collectionsThroughput int |
CollectionsThroughput: The throughput of the collections in cosmosdb database |
DataLakeAnalyticsProperties
(Appears on:Compute_DataLakeAnalytics)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/DataLakeAnalyticsProperties
Field | Description |
---|---|
dataLakeStoreAccountName string |
DataLakeStoreAccountName: DataLake Store Account Name |
DataLakeAnalyticsPropertiesARM
(Appears on:Compute_DataLakeAnalyticsARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/DataLakeAnalyticsProperties
Field | Description |
---|---|
dataLakeStoreAccountName string |
DataLakeStoreAccountName: DataLake Store Account Name |
DatabricksProperties
(Appears on:Compute_Databricks)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/DatabricksProperties
Field | Description |
---|---|
databricksAccessToken string |
DatabricksAccessToken: Databricks access token |
workspaceUrl string |
WorkspaceUrl: Workspace Url |
DatabricksPropertiesARM
(Appears on:Compute_DatabricksARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/DatabricksProperties
Field | Description |
---|---|
databricksAccessToken string |
DatabricksAccessToken: Databricks access token |
workspaceUrl string |
WorkspaceUrl: Workspace Url |
EncryptionProperty
(Appears on:Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/EncryptionProperty
Field | Description |
---|---|
identity IdentityForCmk |
Identity: Identity that will be used to access key vault for encryption at rest |
keyVaultProperties KeyVaultProperties |
|
status EncryptionPropertyStatus |
Status: Indicates whether or not the encryption is enabled for the workspace. |
EncryptionPropertyARM
(Appears on:Workspaces_Spec_PropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/EncryptionProperty
Field | Description |
---|---|
identity IdentityForCmkARM |
Identity: Identity that will be used to access key vault for encryption at rest |
keyVaultProperties KeyVaultPropertiesARM |
|
status EncryptionPropertyStatus |
Status: Indicates whether or not the encryption is enabled for the workspace. |
EncryptionPropertyStatus
(string
alias)
(Appears on:EncryptionProperty, EncryptionPropertyARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EncryptionPropertyStatusStatus
(string
alias)
(Appears on:EncryptionProperty_Status, EncryptionProperty_StatusARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
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 EncryptionPropertyStatusStatus |
Status: Indicates whether or not the encryption is enabled for the workspace. |
EncryptionProperty_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
identity IdentityForCmk_StatusARM |
Identity: The identity that will be used to access the key vault for encryption at rest. |
keyVaultProperties KeyVaultProperties_StatusARM |
KeyVaultProperties: Customer Key vault properties. |
status EncryptionPropertyStatusStatus |
Status: Indicates whether or not the encryption is enabled for the workspace. |
ErrorAdditionalInfo_Status
(Appears on:ErrorDetail_Status, ErrorDetail_Status_Unrolled)
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. |
ErrorAdditionalInfo_StatusARM
(Appears on:ErrorDetail_StatusARM, ErrorDetail_Status_UnrolledARM)
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)
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_StatusARM
(Appears on:ErrorResponse_StatusARM)
Field | Description |
---|---|
additionalInfo []ErrorAdditionalInfo_StatusARM |
AdditionalInfo: The error additional info. |
code string |
Code: The error code. |
details []ErrorDetail_Status_UnrolledARM |
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. |
ErrorDetail_Status_UnrolledARM
(Appears on:ErrorDetail_StatusARM)
Field | Description |
---|---|
additionalInfo []ErrorAdditionalInfo_StatusARM |
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:Compute_Status)
Field | Description |
---|---|
error ErrorDetail_Status |
Error: The error object. |
ErrorResponse_StatusARM
(Appears on:Compute_StatusARM)
Field | Description |
---|---|
error ErrorDetail_StatusARM |
Error: The error object. |
HDInsightProperties
(Appears on:Compute_HDInsight)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/HDInsightProperties
Field | Description |
---|---|
address string |
Address: Public IP address of the master node of the cluster. |
administratorAccount VirtualMachineSshCredentials |
AdministratorAccount: Admin credentials for virtual machine |
sshPort int |
SshPort: Port open for ssh connections on the master node of the cluster. |
HDInsightPropertiesARM
(Appears on:Compute_HDInsightARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/HDInsightProperties
Field | Description |
---|---|
address string |
Address: Public IP address of the master node of the cluster. |
administratorAccount VirtualMachineSshCredentialsARM |
AdministratorAccount: Admin credentials for virtual machine |
sshPort int |
SshPort: Port open for ssh connections on the master node of the cluster. |
Identity
(Appears on:WorkspacesComputes_Spec, Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: The identity type. |
userAssignedIdentities map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
UserAssignedIdentities: dictionary containing all the user assigned identities, with resourceId of the UAI as key. |
IdentityARM
(Appears on:WorkspacesComputes_SpecARM, Workspaces_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: The identity type. |
userAssignedIdentities map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
UserAssignedIdentities: dictionary containing all the user assigned identities, with resourceId of the UAI as key. |
IdentityForCmk
(Appears on:EncryptionProperty)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/IdentityForCmk
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault |
IdentityForCmkARM
(Appears on:EncryptionPropertyARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/IdentityForCmk
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)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault |
IdentityForCmk_StatusARM
(Appears on:EncryptionProperty_StatusARM)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault |
IdentityStatusType
(string
alias)
(Appears on:Identity_Status, Identity_StatusARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
IdentityType
(string
alias)
(Appears on:Identity, IdentityARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
Identity_Status
(Appears on:ComputeResource_Status, PrivateEndpointConnection_Status_SubResourceEmbedded, Workspace_Status)
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of resource identity. |
tenantId string |
TenantId: The tenant ID of resource. |
type IdentityStatusType |
Type: The identity type. |
userAssignedIdentities map[string]./api/machinelearningservices/v1beta20210701.UserAssignedIdentity_Status |
UserAssignedIdentities: The user assigned identities associated with the resource. |
Identity_StatusARM
(Appears on:ComputeResource_StatusARM, PrivateEndpointConnection_Status_SubResourceEmbeddedARM, Workspace_StatusARM)
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of resource identity. |
tenantId string |
TenantId: The tenant ID of resource. |
type IdentityStatusType |
Type: The identity type. |
userAssignedIdentities map[string]./api/machinelearningservices/v1beta20210701.UserAssignedIdentity_StatusARM |
UserAssignedIdentities: The user assigned identities associated with the resource. |
KeyVaultProperties
(Appears on:EncryptionProperty)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/KeyVaultProperties
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. |
KeyVaultPropertiesARM
(Appears on:EncryptionPropertyARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/KeyVaultProperties
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. |
KeyVaultProperties_StatusARM
(Appears on:EncryptionProperty_StatusARM)
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. |
NotebookPreparationError_Status
(Appears on:NotebookResourceInfo_Status)
Field | Description |
---|---|
errorMessage string |
|
statusCode int |
NotebookPreparationError_StatusARM
(Appears on:NotebookResourceInfo_StatusARM)
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 |
NotebookResourceInfo_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
fqdn string |
|
notebookPreparationError NotebookPreparationError_StatusARM |
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)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/PersonalComputeInstanceSettings
Field | Description |
---|---|
assignedUser AssignedUser |
AssignedUser: A user that can be assigned to a compute instance. |
PersonalComputeInstanceSettingsARM
(Appears on:ComputeInstancePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/PersonalComputeInstanceSettings
Field | Description |
---|---|
assignedUser AssignedUserARM |
AssignedUser: A user that can be assigned to a compute instance. |
PrivateEndpointConnection_Status_SubResourceEmbedded
(Appears on:Workspace_Status)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_Status |
Identity: The identity of the resource. |
sku Sku_Status |
Sku: The sku of the workspace. |
systemData SystemData_Status |
SystemData: System data |
PrivateEndpointConnection_Status_SubResourceEmbeddedARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_StatusARM |
Identity: The identity of the resource. |
sku Sku_StatusARM |
Sku: The sku of the workspace. |
systemData SystemData_StatusARM |
SystemData: System data |
PrivateEndpointServiceConnectionStatus_Status
(string
alias)
(Appears on:SharedPrivateLinkResourceProperty_StatusARM, SharedPrivateLinkResource_Status)
Value | Description |
---|---|
"Approved" |
|
"Disconnected" |
|
"Pending" |
|
"Rejected" |
|
"Timeout" |
ResourceId
(Appears on:AmlComputeProperties, ComputeInstanceProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ResourceId
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: The ID of the resource |
ResourceIdARM
(Appears on:AmlComputePropertiesARM, ComputeInstancePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ResourceId
Field | Description |
---|---|
id string |
ScaleSettings
(Appears on:AmlComputeProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ScaleSettings
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. |
ScaleSettingsARM
(Appears on:AmlComputePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ScaleSettings
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)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ScriptReference
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. |
ScriptReferenceARM
(Appears on:ScriptsToExecuteARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ScriptReference
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)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ScriptsToExecute
Field | Description |
---|---|
creationScript ScriptReference |
CreationScript: Script reference |
startupScript ScriptReference |
StartupScript: Script reference |
ScriptsToExecuteARM
(Appears on:SetupScriptsARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ScriptsToExecute
Field | Description |
---|---|
creationScript ScriptReferenceARM |
CreationScript: Script reference |
startupScript ScriptReferenceARM |
StartupScript: Script reference |
ServiceManagedResourcesSettings
(Appears on:Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ServiceManagedResourcesSettings
Field | Description |
---|---|
cosmosDb CosmosDbSettings |
ServiceManagedResourcesSettingsARM
(Appears on:Workspaces_Spec_PropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/ServiceManagedResourcesSettings
Field | Description |
---|---|
cosmosDb CosmosDbSettingsARM |
ServiceManagedResourcesSettings_Status
(Appears on:Workspace_Status)
Field | Description |
---|---|
cosmosDb CosmosDbSettings_Status |
CosmosDb: The settings for the service managed cosmosdb account. |
ServiceManagedResourcesSettings_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
cosmosDb CosmosDbSettings_StatusARM |
CosmosDb: The settings for the service managed cosmosdb account. |
SetupScripts
(Appears on:ComputeInstanceProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SetupScripts
Field | Description |
---|---|
scripts ScriptsToExecute |
Scripts: Customized setup scripts |
SetupScriptsARM
(Appears on:ComputeInstancePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SetupScripts
Field | Description |
---|---|
scripts ScriptsToExecuteARM |
Scripts: Customized setup scripts |
SharedPrivateLinkResourcePropertyARM
(Appears on:Workspaces_Spec_Properties_SharedPrivateLinkResourcesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SharedPrivateLinkResourceProperty
Field | Description |
---|---|
groupId string |
GroupId: The private link resource group id. |
privateLinkResourceId string |
|
requestMessage string |
RequestMessage: Request message. |
status SharedPrivateLinkResourcePropertyStatus |
Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
SharedPrivateLinkResourcePropertyStatus
(string
alias)
(Appears on:SharedPrivateLinkResourcePropertyARM, Workspaces_Spec_Properties_SharedPrivateLinkResources)
Value | Description |
---|---|
"Approved" |
|
"Disconnected" |
|
"Pending" |
|
"Rejected" |
|
"Timeout" |
SharedPrivateLinkResourceProperty_StatusARM
(Appears on:SharedPrivateLinkResource_StatusARM)
Field | Description |
---|---|
groupId string |
GroupId: The private link resource group id. |
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. |
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. |
SharedPrivateLinkResource_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
name string |
Name: Unique name of the private link. |
properties SharedPrivateLinkResourceProperty_StatusARM |
Properties: Resource properties. |
Sku
(Appears on:WorkspacesComputes_Spec, Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/Sku
Field | Description |
---|---|
name string |
Name: Name of the sku |
tier string |
Tier: Tier of the sku like Basic or Enterprise |
SkuARM
(Appears on:WorkspacesComputes_SpecARM, Workspaces_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/Sku
Field | Description |
---|---|
name string |
Name: Name of the sku |
tier string |
Tier: Tier of the sku like Basic or Enterprise |
Sku_Status
(Appears on:ComputeResource_Status, PrivateEndpointConnection_Status_SubResourceEmbedded, Workspace_Status)
Field | Description |
---|---|
name string |
Name: Name of the sku |
tier string |
Tier: Tier of the sku like Basic or Enterprise |
Sku_StatusARM
(Appears on:ComputeResource_StatusARM, PrivateEndpointConnection_Status_SubResourceEmbeddedARM, Workspace_StatusARM)
Field | Description |
---|---|
name string |
Name: Name of the sku |
tier string |
Tier: Tier of the sku like Basic or Enterprise |
SslConfiguration
(Appears on:AKSProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SslConfiguration
Field | Description |
---|---|
cert string |
Cert: Cert data |
cname string |
Cname: CNAME of the cert |
key string |
Key: Key data |
leafDomainLabel string |
LeafDomainLabel: Leaf domain label of public endpoint |
overwriteExistingDomain bool |
OverwriteExistingDomain: Indicates whether to overwrite existing domain label. |
status SslConfigurationStatus |
Status: Enable or disable ssl for scoring. |
SslConfigurationARM
(Appears on:AKSPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SslConfiguration
Field | Description |
---|---|
cert string |
Cert: Cert data |
cname string |
Cname: CNAME of the cert |
key string |
Key: Key data |
leafDomainLabel string |
LeafDomainLabel: Leaf domain label of public endpoint |
overwriteExistingDomain bool |
OverwriteExistingDomain: Indicates whether to overwrite existing domain label. |
status SslConfigurationStatus |
Status: Enable or disable ssl for scoring. |
SslConfigurationStatus
(string
alias)
(Appears on:SslConfiguration, SslConfigurationARM)
Value | Description |
---|---|
"Auto" |
|
"Disabled" |
|
"Enabled" |
SynapseSparkProperties
(Appears on:Compute_SynapseSpark)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SynapseSparkProperties
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. |
SynapseSparkPropertiesARM
(Appears on:Compute_SynapseSparkARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SynapseSparkProperties
Field | Description |
---|---|
autoPauseProperties AutoPausePropertiesARM |
AutoPauseProperties: Auto pause properties |
autoScaleProperties AutoScalePropertiesARM |
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. |
SystemData
(Appears on:WorkspacesComputes_Spec, Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SystemData
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataCreatedByType |
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 SystemDataLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemDataARM
(Appears on:WorkspacesComputes_SpecARM, Workspaces_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/SystemData
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataCreatedByType |
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 SystemDataLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemDataCreatedByType
(string
alias)
(Appears on:SystemData, SystemDataARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataLastModifiedByType
(string
alias)
(Appears on:SystemData, SystemDataARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataStatusCreatedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemDataStatusLastModifiedByType
(string
alias)
(Appears on:SystemData_Status, SystemData_StatusARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_Status
(Appears on:ComputeResource_Status, PrivateEndpointConnection_Status_SubResourceEmbedded, Workspace_Status)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
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 SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
SystemData_StatusARM
(Appears on:ComputeResource_StatusARM, PrivateEndpointConnection_Status_SubResourceEmbeddedARM, Workspace_StatusARM)
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemDataStatusCreatedByType |
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 SystemDataStatusLastModifiedByType |
LastModifiedByType: The type of identity that last modified the resource. |
UserAccountCredentials
(Appears on:AmlComputeProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/UserAccountCredentials
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. |
UserAccountCredentialsARM
(Appears on:AmlComputePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/UserAccountCredentials
Field | Description |
---|---|
adminUserName string |
AdminUserName: Name of the administrator user account which can be used to SSH to nodes. |
adminUserPassword string |
AdminUserPassword: Password of the administrator user account. |
adminUserSshPublicKey string |
AdminUserSshPublicKey: SSH public key of the administrator user account. |
UserAssignedIdentity_Status
(Appears on:Identity_Status)
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. |
UserAssignedIdentity_StatusARM
(Appears on:Identity_StatusARM)
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. |
VirtualMachineImage
(Appears on:AmlComputeProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/VirtualMachineImage
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Virtual Machine image path |
VirtualMachineImageARM
(Appears on:AmlComputePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/VirtualMachineImage
Field | Description |
---|---|
id string |
VirtualMachineProperties
(Appears on:Compute_VirtualMachine)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/VirtualMachineProperties
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 |
VirtualMachinePropertiesARM
(Appears on:Compute_VirtualMachineARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/VirtualMachineProperties
Field | Description |
---|---|
address string |
Address: Public IP address of the virtual machine. |
administratorAccount VirtualMachineSshCredentialsARM |
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 |
VirtualMachineSshCredentials
(Appears on:HDInsightProperties, VirtualMachineProperties)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/VirtualMachineSshCredentials
Field | Description |
---|---|
password genruntime.SecretReference |
Password: Password of admin account |
privateKeyData string |
PrivateKeyData: Private key data |
publicKeyData string |
PublicKeyData: Public key data |
username string |
Username: Username of admin account |
VirtualMachineSshCredentialsARM
(Appears on:HDInsightPropertiesARM, VirtualMachinePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/VirtualMachineSshCredentials
Field | Description |
---|---|
password string |
Password: Password of admin account |
privateKeyData string |
PrivateKeyData: Private key data |
publicKeyData string |
PublicKeyData: Public key data |
username string |
Username: Username of admin account |
Workspace
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/resourceDefinitions/workspaces
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||
spec Workspaces_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||
status Workspace_Status |
WorkspaceConnectionPropsARM
(Appears on:WorkspacesConnections_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/definitions/WorkspaceConnectionProps
Field | Description |
---|---|
authType string |
AuthType: Authorization type of the workspace connection. |
category string |
Category: Category of the workspace connection. |
target string |
Target: Target of the workspace connection. |
value string |
Value: Value details of the workspace connection. |
valueFormat WorkspaceConnectionPropsValueFormat |
ValueFormat: format for the workspace connection value. |
WorkspaceConnectionPropsStatusValueFormat
(string
alias)
(Appears on:WorkspaceConnectionProps_StatusARM, WorkspaceConnection_Status)
Value | Description |
---|---|
"JSON" |
WorkspaceConnectionPropsValueFormat
(string
alias)
(Appears on:WorkspaceConnectionPropsARM, WorkspacesConnections_Spec)
Value | Description |
---|---|
"JSON" |
WorkspaceConnectionProps_StatusARM
(Appears on:WorkspaceConnection_StatusARM)
Field | Description |
---|---|
authType string |
AuthType: Authorization type of the workspace connection. |
category string |
Category: Category of the workspace connection. |
target string |
Target: Target of the workspace connection. |
value string |
Value: Value details of the workspace connection. |
valueFormat WorkspaceConnectionPropsStatusValueFormat |
ValueFormat: format for the workspace connection value |
WorkspaceConnection_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 WorkspaceConnectionPropsStatusValueFormat |
ValueFormat: format for the workspace connection value |
WorkspaceConnection_StatusARM
Field | Description |
---|---|
id string |
Id: ResourceId of the workspace connection. |
name string |
Name: Friendly name of the workspace connection. |
properties WorkspaceConnectionProps_StatusARM |
Properties: Properties of workspace connection. |
type string |
Type: Resource type of workspace connection. |
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:Workspaces_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
secrets WorkspaceOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
WorkspacePropertiesStatusProvisioningState
(string
alias)
(Appears on:WorkspaceProperties_StatusARM, Workspace_Status)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Unknown" |
|
"Updating" |
WorkspacePropertiesStatusPublicNetworkAccess
(string
alias)
(Appears on:WorkspaceProperties_StatusARM, Workspace_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
WorkspaceProperties_StatusARM
(Appears on:Workspace_StatusARM)
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 |
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_StatusARM |
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 |
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 |
mlFlowTrackingUri string |
MlFlowTrackingUri: The URI associated with this workspace that machine learning flow must point at to set up tracking. |
notebookInfo NotebookResourceInfo_StatusARM |
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_SubResourceEmbeddedARM |
PrivateEndpointConnections: The list of private endpoint connections in the workspace. |
privateLinkCount int |
PrivateLinkCount: Count of private connections in the workspace |
provisioningState WorkspacePropertiesStatusProvisioningState |
ProvisioningState: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. |
publicNetworkAccess WorkspacePropertiesStatusPublicNetworkAccess |
PublicNetworkAccess: Whether requests from Public Network are allowed. |
serviceManagedResourcesSettings ServiceManagedResourcesSettings_StatusARM |
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_StatusARM |
SharedPrivateLinkResources: The list of shared private link resources in this 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. |
tenantId string |
TenantId: The tenant id associated with this workspace. |
workspaceId string |
WorkspaceId: The immutable id associated with this workspace. |
Workspace_Status
(Appears on: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}p> |
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_SubResourceEmbedded |
PrivateEndpointConnections: The list of private endpoint connections in the workspace. |
privateLinkCount int |
PrivateLinkCount: Count of private connections in the workspace |
provisioningState WorkspacePropertiesStatusProvisioningState |
ProvisioningState: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. |
publicNetworkAccess WorkspacePropertiesStatusPublicNetworkAccess |
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_StatusARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_StatusARM |
Identity: The identity of the resource. |
location string |
Location: Specifies the location of the resource. |
name string |
Name: The name of the resource |
properties WorkspaceProperties_StatusARM |
Properties: The properties of the machine learning workspace. |
sku Sku_StatusARM |
Sku: The sku of the workspace. |
systemData SystemData_StatusARM |
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
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/resourceDefinitions/workspaces_computes
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec WorkspacesComputes_Spec |
|
||||||||||||||||
status ComputeResource_Status |
WorkspacesComputes_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: Identity for the resource. |
location string |
Location: Specifies the location of the resource. |
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: Machine Learning compute object. |
sku Sku |
Sku: Sku of the resource |
systemData SystemData |
SystemData: Metadata pertaining to creation and last modification of the resource. |
tags map[string]string |
Tags: Contains resource tags defined as key/value pairs. |
WorkspacesComputes_SpecARM
Field | Description |
---|---|
identity IdentityARM |
Identity: Identity for the resource. |
location string |
Location: Specifies the location of the resource. |
name string |
Name: Name of the Azure Machine Learning compute. |
properties ComputeARM |
Properties: Machine Learning compute object. |
sku SkuARM |
Sku: Sku of the resource |
systemData SystemDataARM |
SystemData: Metadata pertaining to creation and last modification of the resource. |
tags map[string]string |
Tags: Contains resource tags defined as key/value pairs. |
WorkspacesConnection
Generated from: https://schema.management.azure.com/schemas/2021-07-01/Microsoft.MachineLearningServices.json#/resourceDefinitions/workspaces_connections
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||
spec WorkspacesConnections_Spec |
|
||||||||||||||||||
status WorkspaceConnection_Status |
WorkspacesConnections_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. |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
target string |
Target: Target of the workspace connection. |
value string |
Value: Value details of the workspace connection. |
valueFormat WorkspaceConnectionPropsValueFormat |
ValueFormat: format for the workspace connection value. |
WorkspacesConnections_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: Friendly name of the workspace connection |
properties WorkspaceConnectionPropsARM |
Properties: Workspace Connection specific properties. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
WorkspacesSpecPropertiesPublicNetworkAccess
(string
alias)
(Appears on:Workspaces_Spec, Workspaces_Spec_PropertiesARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Workspaces_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 |
|
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: Identity for 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 WorkspacesSpecPropertiesPublicNetworkAccess |
PublicNetworkAccess: Whether requests from Public Network are allowed. |
serviceManagedResourcesSettings ServiceManagedResourcesSettings |
|
sharedPrivateLinkResources []Workspaces_Spec_Properties_SharedPrivateLinkResources |
SharedPrivateLinkResources: The list of shared private link resources in this workspace. |
sku Sku |
Sku: Sku of the resource |
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: Metadata pertaining to creation and last modification of the resource. |
tags map[string]string |
Tags: Contains resource tags defined as key/value pairs. |
Workspaces_SpecARM
Field | Description |
---|---|
identity IdentityARM |
Identity: Identity for the resource. |
location string |
Location: Specifies the location of the resource. |
name string |
Name: Name of Azure Machine Learning workspace. |
properties Workspaces_Spec_PropertiesARM |
Properties: The properties of a machine learning workspace. |
sku SkuARM |
Sku: Sku of the resource |
systemData SystemDataARM |
SystemData: Metadata pertaining to creation and last modification of the resource. |
tags map[string]string |
Tags: Contains resource tags defined as key/value pairs. |
Workspaces_Spec_PropertiesARM
(Appears on:Workspaces_SpecARM)
Field | Description |
---|---|
allowPublicAccessWhenBehindVnet bool |
AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet. |
applicationInsights string |
|
containerRegistry string |
|
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 EncryptionPropertyARM |
|
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 |
imageBuildCompute string |
ImageBuildCompute: The compute name for image build |
keyVault string |
|
primaryUserAssignedIdentity string |
|
publicNetworkAccess WorkspacesSpecPropertiesPublicNetworkAccess |
PublicNetworkAccess: Whether requests from Public Network are allowed. |
serviceManagedResourcesSettings ServiceManagedResourcesSettingsARM |
|
sharedPrivateLinkResources []Workspaces_Spec_Properties_SharedPrivateLinkResourcesARM |
SharedPrivateLinkResources: The list of shared private link resources in this workspace. |
storageAccount string |
Workspaces_Spec_Properties_SharedPrivateLinkResources
(Appears on:Workspaces_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 SharedPrivateLinkResourcePropertyStatus |
Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
Workspaces_Spec_Properties_SharedPrivateLinkResourcesARM
(Appears on:Workspaces_Spec_PropertiesARM)
Field | Description |
---|---|
name string |
Name: Unique name of the private link. |
properties SharedPrivateLinkResourcePropertyARM |
Properties: Properties of a shared private link resource. |