Edit

Share via

New-AzNetworkCloudVirtualMachine

  • Reference
Module:
Az.NetworkCloud

Create a new virtual machine or update the properties of the existing virtual machine.

Syntax

New-AzNetworkCloudVirtualMachine
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -AdminUsername <String>
   -CloudServiceNetworkAttachmentAttachedNetworkId <String>
   -CloudServiceNetworkAttachmentIPAllocationMethod <VirtualMachineIPAllocationMethod>
   -CpuCore <Int64>
   -ExtendedLocationName <String>
   -ExtendedLocationType <String>
   -Location <String>
   -MemorySizeGb <Int64>
   -OSDiskSizeGb <Int64>
   -VMImage <String>
   [-BootMethod <VirtualMachineBootMethod>]
   [-CloudServiceNetworkAttachmentDefaultGateway <DefaultGateway>]
   [-CloudServiceNetworkAttachmentIpv4Address <String>]
   [-CloudServiceNetworkAttachmentIpv6Address <String>]
   [-CloudServiceNetworkAttachmentName <String>]
   [-IsolateEmulatorThread <VirtualMachineIsolateEmulatorThread>]
   [-NetworkAttachment <INetworkAttachment[]>]
   [-NetworkData <String>]
   [-OSDiskCreateOption <OSDiskCreateOption>]
   [-OSDiskDeleteOption <OSDiskDeleteOption>]
   [-PlacementHint <IVirtualMachinePlacementHint[]>]
   [-SshPublicKey <ISshPublicKey[]>]
   [-StorageProfileVolumeAttachment <String[]>]
   [-Tag <Hashtable>]
   [-UserData <String>]
   [-VMDeviceModel <VirtualMachineDeviceModelType>]
   [-VMImageRepositoryCredentialsPassword <SecureString>]
   [-VMImageRepositoryCredentialsRegistryUrl <String>]
   [-VMImageRepositoryCredentialsUsername <String>]
   [-VirtioInterface <VirtualMachineVirtioInterfaceType>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create a new virtual machine or update the properties of the existing virtual machine.

Examples

Example 1: Create virtual machine

$networkAttachment = @{
    AttachedNetworkId = "attachedNetworkID"
    IpAllocationMethod = "Dynamic"
}
$hint = @{
    HintType = "Affinity"
    SchedulingExecution = "schedulingExecution"
    Scope = "scope"
    ResourceId = "resourceId"
}
$sshPublicKey = @{
    KeyData = "ssh-rsa aaaKyfsdx= fakekey@vm"
}

$securePassword = ConvertTo-SecureString -String "****" -AsPlainText -Force

New-AzNetworkCloudVirtualMachine -Name vmName  -ResourceGroupName resourceGroup -AdminUsername adminUsername -CloudServiceNetworkAttachmentAttachedNetworkId csnAttachedNetworkId -CloudServiceNetworkAttachmentIPAllocationMethod ipAllocationMethod -CpuCore cpuCore -ExtendedLocationName extendedLocationName -ExtendedLocationType "Custom" -Location location -SubscriptionId subscriptionId -MemorySizeGb memorySizeGb -OSDiskSizeGb osDiskSizeGb -VMImage vmImage -BootMethod bootMethod -CloudServiceNetworkAttachmentDefaultGateway defaultGateway -CloudServiceNetworkAttachmentName csnAttachmentName -IsolateEmulatorThread isolateEmulatorThread -NetworkAttachment $networkAttachment -NetworkData networkData -OSDiskCreateOption osDiskCreationOption -OSDiskDeleteOption osDiskDeleteOption -PlacementHint $hint -SshPublicKey $sshPublicKey -Tag @{tags = "tags"} -UserData userData -VirtioInterface virtioInterface -VMDeviceModel vmDeviceModel -VMImageRepositoryCredentialsUsername registryUsername -VMImageRepositoryCredentialsPassword $securePassword -VMImageRepositoryCredentialsRegistryUrl registryUrl

Location Name    SystemDataCreatedAt SystemDataCreatedBy    SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy             SystemDataL
                                                                                                                                                  astModified
                                                                                                                                                  ByType
-------- ----    ------------------- -------------------    ----------------------- ------------------------ ------------------------             -----------
eastus   default 7/07/2023 21:32:03 <user>                 User                    07/07/2023 21:32:41      <identity>                           Application

This command creates a virtual machine.

Parameters

-AdminUsername

The name of the administrator to which the ssh public keys will be added into the authorized keys.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BootMethod

Selects the boot method for the virtual machine.

Type:VirtualMachineBootMethod
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CloudServiceNetworkAttachmentAttachedNetworkId

The resource ID of the associated network attached to the virtual machine.It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-CloudServiceNetworkAttachmentDefaultGateway

The indicator of whether this is the default gateway.Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.

Type:DefaultGateway
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CloudServiceNetworkAttachmentIPAllocationMethod

The IP allocation mechanism for the virtual machine.Dynamic and Static are only valid for l3Network which may also specify Disabled.Otherwise, Disabled is the only permitted value.

Type:VirtualMachineIPAllocationMethod
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-CloudServiceNetworkAttachmentIpv4Address

The IPv4 address of the virtual machine.This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.If IPAllocationMethod is:Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network.Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network.Disabled - this field will be empty.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CloudServiceNetworkAttachmentIpv6Address

The IPv6 address of the virtual machine.This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.If IPAllocationMethod is:Static - this field must contain an IPv6 address range from within the range specified in the attached network.Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network.Disabled - this field will be empty.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CloudServiceNetworkAttachmentName

The associated network's interface name.If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine.If the user doesn't specify this value, the default interface name of the network resource will be used.For a CloudServicesNetwork resource, this name will be ignored.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CpuCore

The number of CPU cores in the virtual machine.

Type:Int64
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExtendedLocationName

The resource ID of the extended location on which the resource will be created.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExtendedLocationType

The extended location type, for example, CustomLocation.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IsolateEmulatorThread

Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine.

Type:VirtualMachineIsolateEmulatorThread
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

The geo-location where the resource lives

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MemorySizeGb

The memory size of the virtual machine in GB.

Type:Int64
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of the virtual machine.

Type:String
Aliases:VirtualMachineName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NetworkAttachment

The list of network attachments to the virtual machine. To construct, see NOTES section for NETWORKATTACHMENT properties and create a hash table.

Type:INetworkAttachment[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NetworkData

The Base64 encoded cloud-init network data.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OSDiskCreateOption

The strategy for creating the OS disk.

Type:OSDiskCreateOption
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OSDiskDeleteOption

The strategy for deleting the OS disk.

Type:OSDiskDeleteOption
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OSDiskSizeGb

The size of the disk in gigabytes. Required if the createOption is Ephemeral.

Type:Int64
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PlacementHint

The scheduling hints for the virtual machine. To construct, see NOTES section for PLACEMENTHINT properties and create a hash table.

Type:IVirtualMachinePlacementHint[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SshPublicKey

The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername. To construct, see NOTES section for SSHPUBLICKEY properties and create a hash table.

Type:ISshPublicKey[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageProfileVolumeAttachment

The resource IDs of volumes that are requested to be attached to the virtual machine.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserData

The Base64 encoded cloud-init user data.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtioInterface

Field Deprecated, use virtualizationModel instead. The type of the virtio interface.

Type:VirtualMachineVirtioInterfaceType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMDeviceModel

The type of the device model to use.

Type:VirtualMachineDeviceModelType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMImage

The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VMImageRepositoryCredentialsPassword

The password or token used to access an image in the target repository.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMImageRepositoryCredentialsRegistryUrl

The URL of the authentication server used to validate the repository credentials.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMImageRepositoryCredentialsUsername

The username used to access an image in the target repository.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IVirtualMachine