ComputeInstanceProperties interface
Compute Instance properties
Properties
applications | Describes available applications and their endpoints on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
application |
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. |
compute |
The Compute Instance Authorization type. Available values are personal (default). |
connectivity |
Describes all connectivity endpoints available for this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
containers | Describes informations of containers on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
created |
Describes information on user who created this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
custom |
List of Custom Services added to the compute. |
data |
Describes informations of dataDisks on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
data |
Describes informations of dataMounts on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
enable |
Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. |
errors | Collection of errors encountered on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
last |
The last operation on ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
os |
Returns metadata about the operating system image for this compute instance. NOTE: This property will not be serialized. It can only be populated by the server. |
personal |
Settings for a personal compute instance. |
schedules | The list of schedules to be applied on the computes. |
setup |
Details of customized scripts to execute for setting up the cluster. |
ssh |
Specifies policy and settings for SSH access. |
state | The current state of this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server. |
subnet | Virtual network subnet resource ID the compute nodes belong to. |
versions | ComputeInstance version. NOTE: This property will not be serialized. It can only be populated by the server. |
vm |
Virtual Machine Size |
Property Details
applications
Describes available applications and their endpoints on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
applications?: ComputeInstanceApplication[]
Property Value
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
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. NOTE: This property will not be serialized. It can only be populated by the server.
connectivityEndpoints?: ComputeInstanceConnectivityEndpoints
Property Value
containers
Describes informations of containers on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
containers?: ComputeInstanceContainer[]
Property Value
createdBy
Describes information on user who created this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
createdBy?: ComputeInstanceCreatedBy
Property Value
customServices
List of Custom Services added to the compute.
customServices?: CustomService[]
Property Value
dataDisks
Describes informations of dataDisks on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
dataDisks?: ComputeInstanceDataDisk[]
Property Value
dataMounts
Describes informations of dataMounts on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
dataMounts?: ComputeInstanceDataMount[]
Property Value
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
errors
Collection of errors encountered on this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
errors?: ErrorResponse[]
Property Value
lastOperation
The last operation on ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
lastOperation?: ComputeInstanceLastOperation
Property Value
osImageMetadata
Returns metadata about the operating system image for this compute instance. NOTE: This property will not be serialized. It can only be populated by the server.
osImageMetadata?: ImageMetadata
Property Value
personalComputeInstanceSettings
Settings for a personal compute instance.
personalComputeInstanceSettings?: PersonalComputeInstanceSettings
Property Value
schedules
The list of schedules to be applied on the computes.
schedules?: ComputeSchedules
Property Value
setupScripts
Details of customized scripts to execute for setting up the cluster.
setupScripts?: SetupScripts
Property Value
sshSettings
Specifies policy and settings for SSH access.
sshSettings?: ComputeInstanceSshSettings
Property Value
state
The current state of this ComputeInstance. NOTE: This property will not be serialized. It can only be populated by the server.
state?: string
Property Value
string
subnet
Virtual network subnet resource ID the compute nodes belong to.
subnet?: ResourceId
Property Value
versions
ComputeInstance version. NOTE: This property will not be serialized. It can only be populated by the server.
versions?: ComputeInstanceVersion
Property Value
vmSize
Virtual Machine Size
vmSize?: string
Property Value
string