Share via


ComputeInstance Class

Definition

An Azure Machine Learning compute instance.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ComputeInstanceTypeConverter))]
public class ComputeInstance : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IComputeInstance, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ComputeInstanceTypeConverter))>]
type ComputeInstance = class
    interface IComputeInstance
    interface IJsonSerializable
    interface ICompute
    interface IComputeInstanceSchema
    interface IValidates
Public Class ComputeInstance
Implements IComputeInstance, IValidates
Inheritance
ComputeInstance
Attributes
Implements

Constructors

ComputeInstance()

Creates an new ComputeInstance instance.

Properties

Application

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.

AssignedUserObjectId

User’s AAD Object Id.

AssignedUserTenantId

User’s AAD Tenant Id.

AuthorizationType

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

ConnectivityEndpoint

Describes all connectivity endpoints available for this ComputeInstance.

ConnectivityEndpointPrivateIPAddress

Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).

ConnectivityEndpointPublicIPAddress

Public IP Address of this ComputeInstance.

Container

Describes informations of containers on this ComputeInstance.

CreatedBy

Describes information on user who created this ComputeInstance.

CreatedByUserId

Uniquely identifies the user within his/her organization.

CreatedByUserName

Name of the user.

CreatedByUserOrgId

Uniquely identifies user' Azure Active Directory organization.

CreatedOn

The time at which the compute was created.

CreationScriptArgument

Optional command line arguments passed to the script to run.

CreationScriptData

The location of scripts in the mounted volume.

CreationScriptSource

The storage source of the script: workspace.

CreationScriptTimeout

Optional time period passed to timeout command.

CustomService

List of Custom Services added to the compute.

DataDisk

Describes informations of dataDisks on this ComputeInstance.

DataMount

Describes informations of dataMounts on this ComputeInstance.

Description

The description of the Machine Learning compute.

DisableLocalAuth

Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

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.

Error

Collection of errors encountered on this ComputeInstance.

IsAttachedCompute

Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

LastOperation

The last operation on ComputeInstance.

LastOperationName

Name of the last operation.

LastOperationStatus

Operation status.

LastOperationTime

Time of the last operation.

LastOperationTrigger

Trigger of operation.

Location

Location for the underlying compute

ModifiedOn

The time at which the compute was last modified.

OSImageMetadata

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

OSImageMetadataCurrentImageVersion

Specifies the current operating system image version this compute instance is running on.

OSImageMetadataIsLatestOsimageVersion

Specifies whether this compute instance is running on the latest operating system image.

OSImageMetadataLatestImageVersion

Specifies the latest available operating system image version.

PersonalComputeInstanceSetting

Settings for a personal compute instance.

PersonalComputeInstanceSettingAssignedUser

A user explicitly assigned to a personal compute instance.

PropertiesSetupScriptsScripts

Customized setup scripts

Property

Properties of ComputeInstance

ProvisioningError

Errors during provisioning

ProvisioningState

The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

ResourceId

ARM resource id of the underlying compute

Schedule

The list of schedules to be applied on the computes.

ScheduleComputeStartStop

The list of compute start stop schedules to be applied.

ScriptCreationScript

Script that's run only once during provision of the compute.

ScriptStartupScript

Script that's run every time the machine starts.

SetupScript

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

SshSetting

Specifies policy and settings for SSH access.

SshSettingAdminPublicKey

Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs.

SshSettingAdminUserName

Describes the admin user name.

SshSettingSshPort

Describes the port for connecting through SSH.

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.

StartupScriptArgument

Optional command line arguments passed to the script to run.

StartupScriptData

The location of scripts in the mounted volume.

StartupScriptSource

The storage source of the script: workspace.

StartupScriptTimeout

Optional time period passed to timeout command.

State

The current state of this ComputeInstance.

Subnet

Virtual network subnet resource ID the compute nodes belong to.

SubnetId

The ID of the resource

Type

The type of compute

Version

ComputeInstance version.

VersionRuntime

Runtime of compute instance.

VMSize

Virtual Machine Size

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ComputeInstance.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ComputeInstance.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IComputeInstance.

FromJsonString(String)

Creates a new instance of ComputeInstance, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ComputeInstance into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to