New-AzMLWorkspaceAmlComputeObject
Create an in-memory object for AmlCompute.
Syntax
Default (Default)
New-AzMLWorkspaceAmlComputeObject
[-Description <String>]
[-DisableLocalAuth <Boolean>]
[-ResourceId <String>]
[-EnableNodePublicIP <Boolean>]
[-IsolatedNetwork <Boolean>]
[-OSType <OSType>]
[-PropertyBag <IAny>]
[-RemoteLoginPortPublicAccess <RemoteLoginPortPublicAccess>]
[-ScaleMaxNodeCount <Int32>]
[-ScaleMinNodeCount <Int32>]
[-ScaleNodeIdleTimeBeforeScaleDown <TimeSpan>]
[-SubnetId <String>]
[-AdminUserName <String>]
[-AdminUserPassword <String>]
[-AdminUserSshPublicKey <String>]
[-VMPriority <VMPriority>]
[-VMSize <String>]
[-VirtualMachineImageId <String>]
[<CommonParameters>]
Description
Create an in-memory object for AmlCompute.
Examples
Example 1: Create an in-memory object for AmlCompute
New-AzMLWorkspaceAmlComputeObject
Create an in-memory object for AmlCompute
Parameters
-AdminUserName
Name of the administrator user account which can be used to SSH to nodes.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-AdminUserPassword
Password of the administrator user account.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
SSH public key of the administrator user account.
Type: String
Default value: None
Supports wildcards: False
DontShow: False
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Description
The description of the Machine Learning compute.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DisableLocalAuth
Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
Parameter properties
Type: Boolean
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-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.
Parameter properties
Type: Boolean
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-IsolatedNetwork
Network is isolated or not.
Parameter properties
Type: Boolean
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-OSType
Compute OS Type.
Parameter properties
Type: OSType
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-PropertyBag
A property bag containing additional properties.
Parameter properties
Type: IAny
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-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.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ResourceId
ARM resource id of the underlying compute.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ScaleMaxNodeCount
Max number of nodes to use.
Parameter properties
Type: Int32
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ScaleMinNodeCount
Min number of nodes to use.
Parameter properties
Type: Int32
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ScaleNodeIdleTimeBeforeScaleDown
Node Idle Time before scaling down amlCompute.
This string needs to be in the RFC Format.
Parameter properties
Type: TimeSpan
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SubnetId
The ID of the resource.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-VirtualMachineImageId
Virtual Machine image path.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-VMPriority
Virtual Machine priority.
Parameter properties
Type: VMPriority
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-VMSize
Virtual Machine Size.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs