LabVirtualMachineCreationParameter Class

Package:
com.azure.resourcemanager.devtestlabs.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-devtestlabs:1.2.0
  • java.lang.Object
    • com.azure.resourcemanager.devtestlabs.models.LabVirtualMachineCreationParameter

Implements

JsonSerializable<LabVirtualMachineCreationParameter>

public final class LabVirtualMachineCreationParameter
implements JsonSerializable<LabVirtualMachineCreationParameter>

Properties for creating a virtual machine.

Constructor Summary

Constructor Description
LabVirtualMachineCreationParameter()

Creates an instance of LabVirtualMachineCreationParameter class.

Method Summary

Modifier and Type Method and Description
Boolean allowClaim()

Get the allowClaim property: Indicates whether another user can take ownership of the virtual machine.
List<ArtifactInstallProperties> artifacts()

Get the artifacts property: The artifacts to be installed on the virtual machine.
BulkCreationParameters bulkCreationParameters()

Get the bulkCreationParameters property: The number of virtual machine instances to create.
OffsetDateTime createdDate()

Get the createdDate property: The creation date of the virtual machine.
String customImageId()

Get the customImageId property: The custom image identifier of the virtual machine.
List<DataDiskProperties> dataDiskParameters()

Get the dataDiskParameters property: New or existing data disks to attach to the virtual machine after creation.
Boolean disallowPublicIpAddress()

Get the disallowPublicIpAddress property: Indicates whether the virtual machine is to be created without a public IP address.
String environmentId()

Get the environmentId property: The resource ID of the environment that contains this virtual machine, if any.
OffsetDateTime expirationDate()

Get the expirationDate property: The expiration date for VM.
static LabVirtualMachineCreationParameter fromJson(JsonReader jsonReader)

Reads an instance of LabVirtualMachineCreationParameter from the JsonReader.
GalleryImageReference galleryImageReference()

Get the galleryImageReference property: The Microsoft Azure Marketplace image reference of the virtual machine.
Boolean isAuthenticationWithSshKey()

Get the isAuthenticationWithSshKey property: Indicates whether this virtual machine uses an SSH key for authentication.
String labSubnetName()

Get the labSubnetName property: The lab subnet name of the virtual machine.
String labVirtualNetworkId()

Get the labVirtualNetworkId property: The lab virtual network identifier of the virtual machine.
String location()

Get the location property: The location of the new virtual machine or environment.
String name()

Get the name property: The name of the virtual machine or environment.
NetworkInterfaceProperties networkInterface()

Get the networkInterface property: The network interface properties.
String notes()

Get the notes property: The notes of the virtual machine.
String ownerObjectId()

Get the ownerObjectId property: The object identifier of the owner of the virtual machine.
String ownerUserPrincipalName()

Get the ownerUserPrincipalName property: The user principal name of the virtual machine owner.
String password()

Get the password property: The password of the virtual machine administrator.
String planId()

Get the planId property: The id of the plan associated with the virtual machine image.
List<ScheduleCreationParameter> scheduleParameters()

Get the scheduleParameters property: Virtual Machine schedules to be created.
String size()

Get the size property: The size of the virtual machine.
String sshKey()

Get the sshKey property: The SSH key of the virtual machine administrator.
String storageType()

Get the storageType property: Storage type to use for virtual machine (i.e.
Map<String,String> tags()

Get the tags property: The tags of the resource.
JsonWriter toJson(JsonWriter jsonWriter)
String username()

Get the username property: The user name of the virtual machine.
LabVirtualMachineCreationParameter withAllowClaim(Boolean allowClaim)

Set the allowClaim property: Indicates whether another user can take ownership of the virtual machine.
LabVirtualMachineCreationParameter withArtifacts(List<ArtifactInstallProperties> artifacts)

Set the artifacts property: The artifacts to be installed on the virtual machine.
LabVirtualMachineCreationParameter withBulkCreationParameters(BulkCreationParameters bulkCreationParameters)

Set the bulkCreationParameters property: The number of virtual machine instances to create.
LabVirtualMachineCreationParameter withCreatedDate(OffsetDateTime createdDate)

Set the createdDate property: The creation date of the virtual machine.
LabVirtualMachineCreationParameter withCustomImageId(String customImageId)

Set the customImageId property: The custom image identifier of the virtual machine.
LabVirtualMachineCreationParameter withDataDiskParameters(List<DataDiskProperties> dataDiskParameters)

Set the dataDiskParameters property: New or existing data disks to attach to the virtual machine after creation.
LabVirtualMachineCreationParameter withDisallowPublicIpAddress(Boolean disallowPublicIpAddress)

Set the disallowPublicIpAddress property: Indicates whether the virtual machine is to be created without a public IP address.
LabVirtualMachineCreationParameter withEnvironmentId(String environmentId)

Set the environmentId property: The resource ID of the environment that contains this virtual machine, if any.
LabVirtualMachineCreationParameter withExpirationDate(OffsetDateTime expirationDate)

Set the expirationDate property: The expiration date for VM.
LabVirtualMachineCreationParameter withGalleryImageReference(GalleryImageReference galleryImageReference)

Set the galleryImageReference property: The Microsoft Azure Marketplace image reference of the virtual machine.
LabVirtualMachineCreationParameter withIsAuthenticationWithSshKey(Boolean isAuthenticationWithSshKey)

Set the isAuthenticationWithSshKey property: Indicates whether this virtual machine uses an SSH key for authentication.
LabVirtualMachineCreationParameter withLabSubnetName(String labSubnetName)

Set the labSubnetName property: The lab subnet name of the virtual machine.
LabVirtualMachineCreationParameter withLabVirtualNetworkId(String labVirtualNetworkId)

Set the labVirtualNetworkId property: The lab virtual network identifier of the virtual machine.
LabVirtualMachineCreationParameter withLocation(String location)

Set the location property: The location of the new virtual machine or environment.
LabVirtualMachineCreationParameter withName(String name)

Set the name property: The name of the virtual machine or environment.
LabVirtualMachineCreationParameter withNetworkInterface(NetworkInterfaceProperties networkInterface)

Set the networkInterface property: The network interface properties.
LabVirtualMachineCreationParameter withNotes(String notes)

Set the notes property: The notes of the virtual machine.
LabVirtualMachineCreationParameter withOwnerObjectId(String ownerObjectId)

Set the ownerObjectId property: The object identifier of the owner of the virtual machine.
LabVirtualMachineCreationParameter withOwnerUserPrincipalName(String ownerUserPrincipalName)

Set the ownerUserPrincipalName property: The user principal name of the virtual machine owner.
LabVirtualMachineCreationParameter withPassword(String password)

Set the password property: The password of the virtual machine administrator.
LabVirtualMachineCreationParameter withPlanId(String planId)

Set the planId property: The id of the plan associated with the virtual machine image.
LabVirtualMachineCreationParameter withScheduleParameters(List<ScheduleCreationParameter> scheduleParameters)

Set the scheduleParameters property: Virtual Machine schedules to be created.
LabVirtualMachineCreationParameter withSize(String size)

Set the size property: The size of the virtual machine.
LabVirtualMachineCreationParameter withSshKey(String sshKey)

Set the sshKey property: The SSH key of the virtual machine administrator.
LabVirtualMachineCreationParameter withStorageType(String storageType)

Set the storageType property: Storage type to use for virtual machine (i.e.
LabVirtualMachineCreationParameter withTags(Map<String,String> tags)

Set the tags property: The tags of the resource.
LabVirtualMachineCreationParameter withUsername(String username)

Set the username property: The user name of the virtual machine.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LabVirtualMachineCreationParameter

public LabVirtualMachineCreationParameter()

Creates an instance of LabVirtualMachineCreationParameter class.

Method Details

allowClaim

public Boolean allowClaim()

Get the allowClaim property: Indicates whether another user can take ownership of the virtual machine.

Returns:

the allowClaim value.

artifacts

public List<ArtifactInstallProperties> artifacts()

Get the artifacts property: The artifacts to be installed on the virtual machine.

Returns:

the artifacts value.

bulkCreationParameters

public BulkCreationParameters bulkCreationParameters()

Get the bulkCreationParameters property: The number of virtual machine instances to create.

Returns:

the bulkCreationParameters value.

createdDate

public OffsetDateTime createdDate()

Get the createdDate property: The creation date of the virtual machine.

Returns:

the createdDate value.

customImageId

public String customImageId()

Get the customImageId property: The custom image identifier of the virtual machine.

Returns:

the customImageId value.

dataDiskParameters

public List<DataDiskProperties> dataDiskParameters()

Get the dataDiskParameters property: New or existing data disks to attach to the virtual machine after creation.

Returns:

the dataDiskParameters value.

disallowPublicIpAddress

public Boolean disallowPublicIpAddress()

Get the disallowPublicIpAddress property: Indicates whether the virtual machine is to be created without a public IP address.

Returns:

the disallowPublicIpAddress value.

environmentId

public String environmentId()

Get the environmentId property: The resource ID of the environment that contains this virtual machine, if any.

Returns:

the environmentId value.

expirationDate

public OffsetDateTime expirationDate()

Get the expirationDate property: The expiration date for VM.

Returns:

the expirationDate value.

fromJson

public static LabVirtualMachineCreationParameter fromJson(JsonReader jsonReader)

Reads an instance of LabVirtualMachineCreationParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LabVirtualMachineCreationParameter 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 LabVirtualMachineCreationParameter.

galleryImageReference

public GalleryImageReference galleryImageReference()

Get the galleryImageReference property: The Microsoft Azure Marketplace image reference of the virtual machine.

Returns:

the galleryImageReference value.

isAuthenticationWithSshKey

public Boolean isAuthenticationWithSshKey()

Get the isAuthenticationWithSshKey property: Indicates whether this virtual machine uses an SSH key for authentication.

Returns:

the isAuthenticationWithSshKey value.

labSubnetName

public String labSubnetName()

Get the labSubnetName property: The lab subnet name of the virtual machine.

Returns:

the labSubnetName value.

labVirtualNetworkId

public String labVirtualNetworkId()

Get the labVirtualNetworkId property: The lab virtual network identifier of the virtual machine.

Returns:

the labVirtualNetworkId value.

location

public String location()

Get the location property: The location of the new virtual machine or environment.

Returns:

the location value.

name

public String name()

Get the name property: The name of the virtual machine or environment.

Returns:

the name value.

networkInterface

public NetworkInterfaceProperties networkInterface()

Get the networkInterface property: The network interface properties.

Returns:

the networkInterface value.

notes

public String notes()

Get the notes property: The notes of the virtual machine.

Returns:

the notes value.

ownerObjectId

public String ownerObjectId()

Get the ownerObjectId property: The object identifier of the owner of the virtual machine.

Returns:

the ownerObjectId value.

ownerUserPrincipalName

public String ownerUserPrincipalName()

Get the ownerUserPrincipalName property: The user principal name of the virtual machine owner.

Returns:

the ownerUserPrincipalName value.

password

public String password()

Get the password property: The password of the virtual machine administrator.

Returns:

the password value.

planId

public String planId()

Get the planId property: The id of the plan associated with the virtual machine image.

Returns:

the planId value.

scheduleParameters

public List<ScheduleCreationParameter> scheduleParameters()

Get the scheduleParameters property: Virtual Machine schedules to be created.

Returns:

the scheduleParameters value.

size

public String size()

Get the size property: The size of the virtual machine.

Returns:

the size value.

sshKey

public String sshKey()

Get the sshKey property: The SSH key of the virtual machine administrator.

Returns:

the sshKey value.

storageType

public String storageType()

Get the storageType property: Storage type to use for virtual machine (i.e. Standard, Premium).

Returns:

the storageType value.

tags

public Map<String,String> tags()

Get the tags property: The tags of the resource.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

username

public String username()

Get the username property: The user name of the virtual machine.

Returns:

the username value.

withAllowClaim

public LabVirtualMachineCreationParameter withAllowClaim(Boolean allowClaim)

Set the allowClaim property: Indicates whether another user can take ownership of the virtual machine.

Parameters:

allowClaim - the allowClaim value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withArtifacts

public LabVirtualMachineCreationParameter withArtifacts(List<ArtifactInstallProperties> artifacts)

Set the artifacts property: The artifacts to be installed on the virtual machine.

Parameters:

artifacts - the artifacts value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withBulkCreationParameters

public LabVirtualMachineCreationParameter withBulkCreationParameters(BulkCreationParameters bulkCreationParameters)

Set the bulkCreationParameters property: The number of virtual machine instances to create.

Parameters:

bulkCreationParameters - the bulkCreationParameters value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withCreatedDate

public LabVirtualMachineCreationParameter withCreatedDate(OffsetDateTime createdDate)

Set the createdDate property: The creation date of the virtual machine.

Parameters:

createdDate - the createdDate value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withCustomImageId

public LabVirtualMachineCreationParameter withCustomImageId(String customImageId)

Set the customImageId property: The custom image identifier of the virtual machine.

Parameters:

customImageId - the customImageId value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withDataDiskParameters

public LabVirtualMachineCreationParameter withDataDiskParameters(List<DataDiskProperties> dataDiskParameters)

Set the dataDiskParameters property: New or existing data disks to attach to the virtual machine after creation.

Parameters:

dataDiskParameters - the dataDiskParameters value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withDisallowPublicIpAddress

public LabVirtualMachineCreationParameter withDisallowPublicIpAddress(Boolean disallowPublicIpAddress)

Set the disallowPublicIpAddress property: Indicates whether the virtual machine is to be created without a public IP address.

Parameters:

disallowPublicIpAddress - the disallowPublicIpAddress value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withEnvironmentId

public LabVirtualMachineCreationParameter withEnvironmentId(String environmentId)

Set the environmentId property: The resource ID of the environment that contains this virtual machine, if any.

Parameters:

environmentId - the environmentId value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withExpirationDate

public LabVirtualMachineCreationParameter withExpirationDate(OffsetDateTime expirationDate)

Set the expirationDate property: The expiration date for VM.

Parameters:

expirationDate - the expirationDate value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withGalleryImageReference

public LabVirtualMachineCreationParameter withGalleryImageReference(GalleryImageReference galleryImageReference)

Set the galleryImageReference property: The Microsoft Azure Marketplace image reference of the virtual machine.

Parameters:

galleryImageReference - the galleryImageReference value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withIsAuthenticationWithSshKey

public LabVirtualMachineCreationParameter withIsAuthenticationWithSshKey(Boolean isAuthenticationWithSshKey)

Set the isAuthenticationWithSshKey property: Indicates whether this virtual machine uses an SSH key for authentication.

Parameters:

isAuthenticationWithSshKey - the isAuthenticationWithSshKey value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withLabSubnetName

public LabVirtualMachineCreationParameter withLabSubnetName(String labSubnetName)

Set the labSubnetName property: The lab subnet name of the virtual machine.

Parameters:

labSubnetName - the labSubnetName value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withLabVirtualNetworkId

public LabVirtualMachineCreationParameter withLabVirtualNetworkId(String labVirtualNetworkId)

Set the labVirtualNetworkId property: The lab virtual network identifier of the virtual machine.

Parameters:

labVirtualNetworkId - the labVirtualNetworkId value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withLocation

public LabVirtualMachineCreationParameter withLocation(String location)

Set the location property: The location of the new virtual machine or environment.

Parameters:

location - the location value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withName

public LabVirtualMachineCreationParameter withName(String name)

Set the name property: The name of the virtual machine or environment.

Parameters:

name - the name value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withNetworkInterface

public LabVirtualMachineCreationParameter withNetworkInterface(NetworkInterfaceProperties networkInterface)

Set the networkInterface property: The network interface properties.

Parameters:

networkInterface - the networkInterface value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withNotes

public LabVirtualMachineCreationParameter withNotes(String notes)

Set the notes property: The notes of the virtual machine.

Parameters:

notes - the notes value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withOwnerObjectId

public LabVirtualMachineCreationParameter withOwnerObjectId(String ownerObjectId)

Set the ownerObjectId property: The object identifier of the owner of the virtual machine.

Parameters:

ownerObjectId - the ownerObjectId value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withOwnerUserPrincipalName

public LabVirtualMachineCreationParameter withOwnerUserPrincipalName(String ownerUserPrincipalName)

Set the ownerUserPrincipalName property: The user principal name of the virtual machine owner.

Parameters:

ownerUserPrincipalName - the ownerUserPrincipalName value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withPassword

public LabVirtualMachineCreationParameter withPassword(String password)

Set the password property: The password of the virtual machine administrator.

Parameters:

password - the password value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withPlanId

public LabVirtualMachineCreationParameter withPlanId(String planId)

Set the planId property: The id of the plan associated with the virtual machine image.

Parameters:

planId - the planId value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withScheduleParameters

public LabVirtualMachineCreationParameter withScheduleParameters(List<ScheduleCreationParameter> scheduleParameters)

Set the scheduleParameters property: Virtual Machine schedules to be created.

Parameters:

scheduleParameters - the scheduleParameters value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withSize

public LabVirtualMachineCreationParameter withSize(String size)

Set the size property: The size of the virtual machine.

Parameters:

size - the size value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withSshKey

public LabVirtualMachineCreationParameter withSshKey(String sshKey)

Set the sshKey property: The SSH key of the virtual machine administrator.

Parameters:

sshKey - the sshKey value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withStorageType

public LabVirtualMachineCreationParameter withStorageType(String storageType)

Set the storageType property: Storage type to use for virtual machine (i.e. Standard, Premium).

Parameters:

storageType - the storageType value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withTags

public LabVirtualMachineCreationParameter withTags(Map<String,String> tags)

Set the tags property: The tags of the resource.

Parameters:

tags - the tags value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

withUsername

public LabVirtualMachineCreationParameter withUsername(String username)

Set the username property: The user name of the virtual machine.

Parameters:

username - the username value to set.

Returns:

the LabVirtualMachineCreationParameter object itself.

Applies to