New-AzMLWorkspaceComputeInstanceObject
Create an in-memory object for ComputeInstance.
Syntax
Default (Default)
New-AzMLWorkspaceComputeInstanceObject
[-Description <String>]
[-DisableLocalAuth <Boolean>]
[-ResourceId <String>]
[-ApplicationSharingPolicy <ApplicationSharingPolicy>]
[-AssignedUserObjectId <String>]
[-AssignedUserTenantId <String>]
[-AuthorizationType <ComputeInstanceAuthorizationType>]
[-CreationScriptArgument <String>]
[-CreationScriptData <String>]
[-CreationScriptSource <String>]
[-CreationScriptTimeout <String>]
[-EnableNodePublicIP <Boolean>]
[-LastOperationName <OperationName>]
[-LastOperationStatus <OperationStatus>]
[-LastOperationTime <DateTime>]
[-LastOperationTrigger <OperationTrigger>]
[-ScheduleComputeStartStop <IComputeStartStopSchedule[]>]
[-SshSettingAdminPublicKey <String>]
[-SshSettingSshPublicAccess <SshPublicAccess>]
[-StartupScriptArgument <String>]
[-StartupScriptData <String>]
[-StartupScriptSource <String>]
[-StartupScriptTimeout <String>]
[-SubnetId <String>]
[-VMSize <String>]
[-VersionRuntime <String>]
[<CommonParameters>]
Description
Create an in-memory object for ComputeInstance.
Examples
Example 1: Create an in-memory object for ComputeInstance
New-AzMLWorkspaceComputeInstanceObject
Create an in-memory object for ComputeInstance
Parameters
-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.
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
-AssignedUserObjectId
User's AAD Object Id.
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
-AssignedUserTenantId
User's AAD Tenant Id.
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
-AuthorizationType
The Compute Instance Authorization type.
Available values are personal (default).
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
-CreationScriptArgument
Optional command line arguments passed to the script to run.
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
-CreationScriptData
The location of scripts in the mounted volume.
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
-CreationScriptSource
The storage source of the script: inline, workspace.
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
-CreationScriptTimeout
Optional time period passed to timeout command.
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
-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
-LastOperationName
Name of the last operation.
Parameter properties
Type: OperationName
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
-LastOperationStatus
Operation status.
Parameter properties
Type: OperationStatus
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
-LastOperationTime
Time of the last operation.
Parameter properties
Type: DateTime
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
-LastOperationTrigger
Trigger of operation.
Parameter properties
Type: OperationTrigger
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
-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
-ScheduleComputeStartStop
The list of compute start stop schedules to be applied.
To construct, see NOTES section for SCHEDULECOMPUTESTARTSTOP properties and create a hash table.
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
-SshSettingAdminPublicKey
Specifies the SSH rsa public key file as a string.
Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs.
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
-SshSettingSshPublicAccess
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.
Parameter properties
Type: SshPublicAccess
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
-StartupScriptArgument
Optional command line arguments passed to the script to run.
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
-StartupScriptData
The location of scripts in the mounted volume.
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
-StartupScriptSource
The storage source of the script: inline, workspace.
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
-StartupScriptTimeout
Optional time period passed to timeout command.
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
-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
-VersionRuntime
Runtime of compute instance.
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
-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
