Class AmlComputeProperties


  • public final class AmlComputeProperties
    extends Object
    AML Compute properties.
    • Constructor Detail

      • AmlComputeProperties

        public AmlComputeProperties()
    • Method Detail

      • osType

        public OsType osType()
        Get the osType property: Compute OS Type.
        Returns:
        the osType value.
      • withOsType

        public AmlComputeProperties withOsType​(OsType osType)
        Set the osType property: Compute OS Type.
        Parameters:
        osType - the osType value to set.
        Returns:
        the AmlComputeProperties object itself.
      • vmSize

        public String vmSize()
        Get the vmSize property: Virtual Machine Size.
        Returns:
        the vmSize value.
      • withVmSize

        public AmlComputeProperties withVmSize​(String vmSize)
        Set the vmSize property: Virtual Machine Size.
        Parameters:
        vmSize - the vmSize value to set.
        Returns:
        the AmlComputeProperties object itself.
      • vmPriority

        public VmPriority vmPriority()
        Get the vmPriority property: Virtual Machine priority.
        Returns:
        the vmPriority value.
      • withVmPriority

        public AmlComputeProperties withVmPriority​(VmPriority vmPriority)
        Set the vmPriority property: Virtual Machine priority.
        Parameters:
        vmPriority - the vmPriority value to set.
        Returns:
        the AmlComputeProperties object itself.
      • virtualMachineImage

        public VirtualMachineImage virtualMachineImage()
        Get the virtualMachineImage property: Virtual Machine image for AML Compute - windows only.
        Returns:
        the virtualMachineImage value.
      • withVirtualMachineImage

        public AmlComputeProperties withVirtualMachineImage​(VirtualMachineImage virtualMachineImage)
        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

        public Boolean isolatedNetwork()
        Get the isolatedNetwork property: Network is isolated or not.
        Returns:
        the isolatedNetwork value.
      • withIsolatedNetwork

        public AmlComputeProperties withIsolatedNetwork​(Boolean isolatedNetwork)
        Set the isolatedNetwork property: Network is isolated or not.
        Parameters:
        isolatedNetwork - the isolatedNetwork value to set.
        Returns:
        the AmlComputeProperties object itself.
      • scaleSettings

        public ScaleSettings scaleSettings()
        Get the scaleSettings property: Scale settings for AML Compute.
        Returns:
        the scaleSettings value.
      • withScaleSettings

        public AmlComputeProperties withScaleSettings​(ScaleSettings scaleSettings)
        Set the scaleSettings property: Scale settings for AML Compute.
        Parameters:
        scaleSettings - the scaleSettings value to set.
        Returns:
        the AmlComputeProperties object itself.
      • userAccountCredentials

        public UserAccountCredentials 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

        public ResourceId subnet()
        Get the subnet property: Virtual network subnet resource ID the compute nodes belong to.
        Returns:
        the subnet value.
      • withSubnet

        public AmlComputeProperties withSubnet​(ResourceId subnet)
        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

        public RemoteLoginPortPublicAccess remoteLoginPortPublicAccess()
        Get the remoteLoginPortPublicAccess property: Close remote Login Access Port 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: Close remote Login Access Port 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

        public AllocationState allocationState()
        Get the allocationState property: Allocation state. 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

        public OffsetDateTime allocationStateTransitionTime()
        Get the allocationStateTransitionTime property: Allocation state transition time. The time at which the compute entered its current allocation state.
        Returns:
        the allocationStateTransitionTime value.
      • errors

        public List<com.azure.core.management.exception.ManagementError> errors()
        Get the errors property: Errors. Collection of errors encountered by various compute nodes during node setup.
        Returns:
        the errors value.
      • currentNodeCount

        public Integer currentNodeCount()
        Get the currentNodeCount property: Current node count. The number of compute nodes currently assigned to the compute.
        Returns:
        the currentNodeCount value.
      • targetNodeCount

        public Integer targetNodeCount()
        Get the targetNodeCount property: Target node count. 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

        public NodeStateCounts nodeStateCounts()
        Get the nodeStateCounts property: Counts of various node states on the compute.
        Returns:
        the nodeStateCounts value.
      • enableNodePublicIp

        public Boolean enableNodePublicIp()
        Get the enableNodePublicIp property: Enable node public IP. 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

        public AmlComputeProperties withEnableNodePublicIp​(Boolean enableNodePublicIp)
        Set the enableNodePublicIp property: Enable node public IP. 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

        public Map<String,​Object> propertyBag()
        Get the propertyBag property: A property bag containing additional properties.
        Returns:
        the propertyBag value.
      • withPropertyBag

        public AmlComputeProperties withPropertyBag​(Map<String,​Object> propertyBag)
        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.