ComputeInstanceProperties interface

Package:

@azure/arm-machinelearning

Compute Instance properties

Properties

applications	Describes available applications and their endpoints on this ComputeInstance.
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.
autologgerSettings	Specifies settings for autologger.
computeInstanceAuthorizationType	The Compute Instance Authorization type. Available values are personal (default).
connectivityEndpoints	Describes all connectivity endpoints available for this ComputeInstance.
containers	Describes informations of containers on this ComputeInstance.
createdBy	Describes information on user who created this ComputeInstance.
customServices	List of Custom Services added to the compute.
dataDisks	Describes informations of dataDisks on this ComputeInstance.
dataMounts	Describes informations of dataMounts on this ComputeInstance.
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.
enableOSPatching	Enable Auto OS Patching. Possible values are: true, false.
enableRootAccess	Enable root access. Possible values are: true, false.
enableSSO	Enable SSO (single sign on). Possible values are: true, false.
errors	Collection of errors encountered on this ComputeInstance.
idleTimeBeforeShutdown	Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days.
lastOperation	The last operation on ComputeInstance.
osImageMetadata	Returns metadata about the operating system image for this compute instance.
personalComputeInstanceSettings	Settings for a personal compute instance.
releaseQuotaOnStop	Release quota if compute instance stopped. Possible values are: true - release quota if compute instance stopped. false - don't release quota when compute instance stopped.
schedules	The list of schedules to be applied on the computes.
setupScripts	Details of customized scripts to execute for setting up the cluster.
sshSettings	Specifies policy and settings for SSH access.
state	The current state of this ComputeInstance.
subnet	Virtual network subnet resource ID the compute nodes belong to.
versions	ComputeInstance version.
vmSize	Virtual Machine Size

Property Details

applications

Describes available applications and their endpoints on this ComputeInstance.

applications?: ComputeInstanceApplication[]

Property Value

ComputeInstanceApplication[]

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.

applicationSharingPolicy?: string

Property Value

string

autologgerSettings

Specifies settings for autologger.

autologgerSettings?: ComputeInstanceAutologgerSettings

Property Value

ComputeInstanceAutologgerSettings

computeInstanceAuthorizationType

The Compute Instance Authorization type. Available values are personal (default).

computeInstanceAuthorizationType?: string

Property Value

string

connectivityEndpoints

Describes all connectivity endpoints available for this ComputeInstance.

connectivityEndpoints?: ComputeInstanceConnectivityEndpoints

Property Value

ComputeInstanceConnectivityEndpoints

containers

Describes informations of containers on this ComputeInstance.

containers?: ComputeInstanceContainer[]

Property Value

ComputeInstanceContainer[]

createdBy

Describes information on user who created this ComputeInstance.

createdBy?: ComputeInstanceCreatedBy

Property Value

ComputeInstanceCreatedBy

customServices

List of Custom Services added to the compute.

customServices?: CustomService[]

Property Value

CustomService[]

dataDisks

Describes informations of dataDisks on this ComputeInstance.

dataDisks?: ComputeInstanceDataDisk[]

Property Value

ComputeInstanceDataDisk[]

dataMounts

Describes informations of dataMounts on this ComputeInstance.

dataMounts?: ComputeInstanceDataMount[]

Property Value

ComputeInstanceDataMount[]

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.

enableNodePublicIp?: boolean

Property Value

boolean

enableOSPatching

Enable Auto OS Patching. Possible values are: true, false.

enableOSPatching?: boolean

Property Value

boolean

enableRootAccess

Enable root access. Possible values are: true, false.

enableRootAccess?: boolean

Property Value

boolean

enableSSO

Enable SSO (single sign on). Possible values are: true, false.

enableSSO?: boolean

Property Value

boolean

errors

Collection of errors encountered on this ComputeInstance.

errors?: ErrorResponse[]

Property Value

ErrorResponse[]

idleTimeBeforeShutdown

Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days.

idleTimeBeforeShutdown?: string

Property Value

string

lastOperation

The last operation on ComputeInstance.

lastOperation?: ComputeInstanceLastOperation

Property Value

ComputeInstanceLastOperation

osImageMetadata

Returns metadata about the operating system image for this compute instance.

osImageMetadata?: ImageMetadata

Property Value

ImageMetadata

personalComputeInstanceSettings

Settings for a personal compute instance.

personalComputeInstanceSettings?: PersonalComputeInstanceSettings

Property Value

PersonalComputeInstanceSettings

releaseQuotaOnStop

Release quota if compute instance stopped. Possible values are: true - release quota if compute instance stopped. false - don't release quota when compute instance stopped.

releaseQuotaOnStop?: boolean

Property Value

boolean

schedules

The list of schedules to be applied on the computes.

schedules?: ComputeSchedules

Property Value

ComputeSchedules

setupScripts

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

setupScripts?: SetupScripts

Property Value

SetupScripts

sshSettings

Specifies policy and settings for SSH access.

sshSettings?: ComputeInstanceSshSettings

Property Value

ComputeInstanceSshSettings

state

The current state of this ComputeInstance.

state?: string

Property Value

string

subnet

Virtual network subnet resource ID the compute nodes belong to.

subnet?: ResourceId

Property Value

ResourceId

versions

ComputeInstance version.

versions?: ComputeInstanceVersion

Property Value

ComputeInstanceVersion

vmSize

Virtual Machine Size

vmSize?: string

Property Value

string