Class AmlComputeProperties
java.lang.Object
com.azure.resourcemanager.machinelearning.models.AmlComputeProperties
- All Implemented Interfaces:
com.azure.json.JsonSerializable<AmlComputeProperties>
public final class AmlComputeProperties
extends Object
implements com.azure.json.JsonSerializable<AmlComputeProperties>
AML Compute properties.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the allocationState property: Allocation state of the compute.Get the allocationStateTransitionTime property: The time at which the compute entered its current allocation state.Get the currentNodeCount property: The number of compute nodes currently assigned to the compute.Get the enableNodePublicIp property: Enable or disable node public IP address provisioning.List<com.azure.core.management.exception.ManagementError>errors()Get the errors property: Collection of errors encountered by various compute nodes during node setup.static AmlComputePropertiesfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of AmlComputeProperties from the JsonReader.Get the isolatedNetwork property: Network is isolated or not.Get the nodeStateCounts property: Counts of various node states on the compute.osType()Get the osType property: Compute OS Type.Get the propertyBag property: A property bag containing additional properties.Get the remoteLoginPortPublicAccess property: State of the public SSH port.Get the scaleSettings property: Scale settings for AML Compute.subnet()Get the subnet property: Virtual network subnet resource ID the compute nodes belong to.Get the targetNodeCount property: The target number of compute nodes for the compute.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) Get the userAccountCredentials property: Credentials for an administrator user account that will be created on each compute node.voidvalidate()Validates the instance.Get the virtualMachineImage property: Virtual Machine image for AML Compute - windows only.Get the vmPriority property: Virtual Machine priority.vmSize()Get the vmSize property: Virtual Machine Size.withEnableNodePublicIp(Boolean enableNodePublicIp) Set the enableNodePublicIp property: Enable or disable node public IP address provisioning.withIsolatedNetwork(Boolean isolatedNetwork) Set the isolatedNetwork property: Network is isolated or not.withOsType(OsType osType) Set the osType property: Compute OS Type.withPropertyBag(Object propertyBag) Set the propertyBag property: A property bag containing additional properties.withRemoteLoginPortPublicAccess(RemoteLoginPortPublicAccess remoteLoginPortPublicAccess) Set the remoteLoginPortPublicAccess property: State of the public SSH port.withScaleSettings(ScaleSettings scaleSettings) Set the scaleSettings property: Scale settings for AML Compute.withSubnet(ResourceId subnet) Set the subnet property: Virtual network subnet resource ID the compute nodes belong to.withUserAccountCredentials(UserAccountCredentials userAccountCredentials) Set the userAccountCredentials property: Credentials for an administrator user account that will be created on each compute node.withVirtualMachineImage(VirtualMachineImage virtualMachineImage) Set the virtualMachineImage property: Virtual Machine image for AML Compute - windows only.withVmPriority(VmPriority vmPriority) Set the vmPriority property: Virtual Machine priority.withVmSize(String vmSize) Set the vmSize property: Virtual Machine Size.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
AmlComputeProperties
public AmlComputeProperties()Creates an instance of AmlComputeProperties class.
-
-
Method Details
-
osType
Get the osType property: Compute OS Type.- Returns:
- the osType value.
-
withOsType
Set the osType property: Compute OS Type.- Parameters:
osType- the osType value to set.- Returns:
- the AmlComputeProperties object itself.
-
vmSize
Get the vmSize property: Virtual Machine Size.- Returns:
- the vmSize value.
-
withVmSize
Set the vmSize property: Virtual Machine Size.- Parameters:
vmSize- the vmSize value to set.- Returns:
- the AmlComputeProperties object itself.
-
vmPriority
Get the vmPriority property: Virtual Machine priority.- Returns:
- the vmPriority value.
-
withVmPriority
Set the vmPriority property: Virtual Machine priority.- Parameters:
vmPriority- the vmPriority value to set.- Returns:
- the AmlComputeProperties object itself.
-
virtualMachineImage
Get the virtualMachineImage property: Virtual Machine image for AML Compute - windows only.- Returns:
- the virtualMachineImage value.
-
withVirtualMachineImage
Set the virtualMachineImage property: Virtual Machine image for AML Compute - windows only.- Parameters:
virtualMachineImage- the virtualMachineImage value to set.- Returns:
- the AmlComputeProperties object itself.
-
isolatedNetwork
Get the isolatedNetwork property: Network is isolated or not.- Returns:
- the isolatedNetwork value.
-
withIsolatedNetwork
Set the isolatedNetwork property: Network is isolated or not.- Parameters:
isolatedNetwork- the isolatedNetwork value to set.- Returns:
- the AmlComputeProperties object itself.
-
scaleSettings
Get the scaleSettings property: Scale settings for AML Compute.- Returns:
- the scaleSettings value.
-
withScaleSettings
Set the scaleSettings property: Scale settings for AML Compute.- Parameters:
scaleSettings- the scaleSettings value to set.- Returns:
- the AmlComputeProperties object itself.
-
userAccountCredentials
Get the userAccountCredentials property: Credentials for an administrator user account that will be created on each compute node.- Returns:
- the userAccountCredentials value.
-
withUserAccountCredentials
public AmlComputeProperties withUserAccountCredentials(UserAccountCredentials userAccountCredentials) Set the userAccountCredentials property: Credentials for an administrator user account that will be created on each compute node.- Parameters:
userAccountCredentials- the userAccountCredentials value to set.- Returns:
- the AmlComputeProperties object itself.
-
subnet
Get the subnet property: Virtual network subnet resource ID the compute nodes belong to.- Returns:
- the subnet value.
-
withSubnet
Set the subnet property: Virtual network subnet resource ID the compute nodes belong to.- Parameters:
subnet- the subnet value to set.- Returns:
- the AmlComputeProperties object itself.
-
remoteLoginPortPublicAccess
Get the remoteLoginPortPublicAccess property: 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.- Returns:
- the remoteLoginPortPublicAccess value.
-
withRemoteLoginPortPublicAccess
public AmlComputeProperties withRemoteLoginPortPublicAccess(RemoteLoginPortPublicAccess remoteLoginPortPublicAccess) Set the remoteLoginPortPublicAccess property: 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.- Parameters:
remoteLoginPortPublicAccess- the remoteLoginPortPublicAccess value to set.- Returns:
- the AmlComputeProperties object itself.
-
allocationState
Get the allocationState property: Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.- Returns:
- the allocationState value.
-
allocationStateTransitionTime
Get the allocationStateTransitionTime property: The time at which the compute entered its current allocation state.- Returns:
- the allocationStateTransitionTime value.
-
errors
Get the errors property: Collection of errors encountered by various compute nodes during node setup.- Returns:
- the errors value.
-
currentNodeCount
Get the currentNodeCount property: The number of compute nodes currently assigned to the compute.- Returns:
- the currentNodeCount value.
-
targetNodeCount
Get the targetNodeCount property: The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.- Returns:
- the targetNodeCount value.
-
nodeStateCounts
Get the nodeStateCounts property: Counts of various node states on the compute.- Returns:
- the nodeStateCounts value.
-
enableNodePublicIp
Get the enableNodePublicIp property: 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.- Returns:
- the enableNodePublicIp value.
-
withEnableNodePublicIp
Set the enableNodePublicIp property: 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.- Parameters:
enableNodePublicIp- the enableNodePublicIp value to set.- Returns:
- the AmlComputeProperties object itself.
-
propertyBag
Get the propertyBag property: A property bag containing additional properties.- Returns:
- the propertyBag value.
-
withPropertyBag
Set the propertyBag property: A property bag containing additional properties.- Parameters:
propertyBag- the propertyBag value to set.- Returns:
- the AmlComputeProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<AmlComputeProperties>- Throws:
IOException
-
fromJson
public static AmlComputeProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of AmlComputeProperties from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of AmlComputeProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IOException- If an error occurs while reading the AmlComputeProperties.
-