Create virtual machines with the Azure PowerShell

In this tutorial, you learn all of the steps involved in setting up a virtual machine with Azure PowerShell. The tutorial also covers output queries, Azure resource reuse, and resource cleanup.

This tutorial can be completed with the interactive experience offered through Azure Cloud Shell, or you may install Azure PowerShell locally.

Use ctrl-shift-v (cmd-shift-v on macOS) to paste tutorial text into Azure Cloud Shell.

You will learn how to...

Log in

If you're using a local install of the Azure PowerShell, you need to log in before performing any other steps.

Connect-AzureRmAccount

Complete the login process by following the steps displayed in your terminal.

Create a resource group

In Azure, all resources are allocated in a resource management group. Resource groups provide logical groupings of resources that make them easier to work with as a collection. For this tutorial, all of the created resources go into a single group named TutorialResources.

New-AzureRmResourceGroup -Name TutorialResources -Location eastus
ResourceGroupName : TutorialResources
Location          : eastus
ProvisioningState : Succeeded
Tags              :
ResourceId        : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/TutorialResources

Create admin credentials for the VM

Before you can create a new virtual machine, you must create a credential object containing the username and password for the administrator account of the Windows VM.

$cred = Get-Credential -Message "Enter a username and password for the virtual machine."

Enter the username and password when prompted. The resulting credential object is passed as a parameter in the next step.

Windows PowerShell credential request.
Enter a username and password for the virtual machine.
User: tutorAdmin
Password for user tutorAdmin: *********

Create a virtual machine

Virtual machines in Azure have a large number of dependencies. The Azure PowerShell creates these resources for you based on the command-line arguments you specify. For readability, we are using PowerShell splatting to pass parameters to the Azure PowerShell cmdlets.

Create a new virtual machine running Windows.

$vmParams = @{
  ResourceGroupName = 'TutorialResources'
  Name = 'TutorialVM1'
  Location = 'eastus'
  ImageName = 'Win2016Datacenter'
  PublicIpAddressName = 'tutorialPublicIp'
  Credential = $cred
  OpenPorts = 3389
}
$newVM1 = New-AzureRmVM @vmParams

As the VM is created, you see the parameter values used and Azure resources being created. PowerShell will displace a progress bar as shown below.

 Creating Azure resources
  39% \
  [ooooooooooooooooooooooooooooooooooo                                                                 ]

  Creating TutorialVM1 virtual machine.

Once the VM is ready, we can view the results in the Azure Portal or by inspecting the $newVM1 variable.

$newVM1
ResourceGroupName : TutorialResources
Id                : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/TutorialResources/providers/Microsoft.Compute/virtualMachines/TutorialVM1
VmId              : 12345678-9abc-def0-1234-56789abcedf0
Name              : TutorialVM1
Type              : Microsoft.Compute/virtualMachines
Location          : eastus
Tags              : {}
HardwareProfile   : {VmSize}
NetworkProfile    : {NetworkInterfaces}
OSProfile         : {ComputerName, AdminUsername, WindowsConfiguration, Secrets}
ProvisioningState : Succeeded
StorageProfile    : {ImageReference, OsDisk, DataDisks}

Property values listed inside of braces are nested objects. In the next step we will show you how to view specific values in these nested objects.

Get VM information with queries

Let's get some more detailed information from the VM we just created. In this example, we verify the Name of the VM and the admin account we created.

$newVM1.OSProfile | Select-Object ComputerName,AdminUserName
ComputerName AdminUsername
------------ -------------
TutorialVM1  tutorialAdmin

We can use other Azure PowerShell commands to get specific information about the network configuration.

$newVM1 | Get-AzureRmNetworkInterface |
  Select-Object -ExpandProperty IpConfigurations |
    Select-Object Name,PrivateIpAddress

In this example we are using the PowerShell pipeline to send the $newVM1 object to the Get-AzureRmNetworkInterface cmdlet. From the resulting network interface object we are selecting the nested IpConfigurations object. From the IpConfigurations object we are selecting the Name and PrivateIpAddress properties.

Name        PrivateIpAddress
----        ----------------
TutorialVM1 192.168.1.4

To confirm that the VM is running, we need to connect via Remote Desktop. For that, we need to know the Public IP address.

$publicIp = Get-AzureRmPublicIpAddress -Name tutorialPublicIp -ResourceGroupName TutorialResources

$publicIp | Select-Object Name,IpAddress,@{label='FQDN';expression={$_.DnsSettings.Fqdn}}

In this example, we use the Get-AzureRmPublicIpAddress and store the results in the $publicIp variable. From this variable we are selecting properties and using an expression to retrieve the nested Fqdn property.

Name             IpAddress           FQDN
----             ---------           ----
tutorialPublicIp <PUBLIC_IP_ADDRESS> tutorialvm1-8a0999.eastus.cloudapp.azure.com

From your local machine you can run the following command to connect to the VM over Remote Desktop.

mstsc.exe /v <PUBLIC_IP_ADDRESS>

For more information about querying for object properties, see Querying for Azure resources.

Creating a new VM on the existing subnet

The second VM uses the existing subnet.

$vm2Params = @{
  ResourceGroupName = 'TutorialResources'
  Name = 'TutorialVM2'
  ImageName = 'Win2016Datacenter'
  VirtualNetworkName = 'TutorialVM1'
  SubnetName = 'TutorialVM1'
  PublicIpAddressName = 'tutorialPublicIp2'
  Credential = $cred
  OpenPorts = 3389
}
$newVM2 = New-AzureRmVM @vm2Params

$newVM2
ResourceGroupName        : TutorialResources
Id                       : /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/TutorialResources/providers/Microsoft.Compute/virtualMachines/TutorialVM2
VmId                     : 12345678-9abc-def0-1234-56789abcedf1
Name                     : TutorialVM2
Type                     : Microsoft.Compute/virtualMachines
Location                 : eastus
Tags                     : {}
HardwareProfile          : {VmSize}
NetworkProfile           : {NetworkInterfaces}
OSProfile                : {ComputerName, AdminUsername, WindowsConfiguration, Secrets}
ProvisioningState        : Succeeded
StorageProfile           : {ImageReference, OsDisk, DataDisks}
FullyQualifiedDomainName : tutorialvm2-dfa5af.eastus.cloudapp.azure.com

You can skip a few steps to get the public IP address of the new VM since it's returned in the FullyQualifiedDomainName property of the $newVM2 object. Use the following command to connect using Remote Desktop.

mstsc.exe /v $newVM2.FullyQualifiedDomainName

Cleanup

Now that the tutorial is complete, it's time to clean up the created resources. You can delete individual resources with the Remove-AzureRmResource command, but the safest way to remove all resources in a resource group is delete the group using the Remove-AzureRmResourceGroup command.

$job = Remove-AzureRmResourceGroup -Name TutorialResources -Force -AsJob

$job
Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Long Running... AzureLongRun... Running       True            localhost            Remove-AzureRmResource...

This command deletes the resources created during the tutorial, and is guaranteed to deallocate them in the correct order. The -AsJob parameter keeps PowerShell from blocking while the deletion takes place. To wait until the deletion is complete, use the following command:

Wait-Job -Id $job.Id

With cleanup completed, the tutorial is finished. Continue on for a summary of everything you learned and links to resources that will help you with your next steps.

Congratulations!

Congratulations! You learned how to create VMs with new or existing resources, used expressions and other Azure PowerShell commands to to capture data to be stored in shell variables, and looked at some of the resources that get created for Azure VMs.

Where you go from here depends on how you plan to use Azure PowerShell. There are a variety of materials that go further in depth on the features covered in this tutorial.

In-depth Azure PowerShell documentation

You might want to take time to explore the complete Azure PowerShell documentation set.

For more information about the commands used in this tutorial, see the following articles.

There are also articles that go deeper into the features that were shown in the tutorial.

Sample scripts

If you want to get started right away with specific tasks, look at some sample scripts.

Feedback

If you'd like to give feedback, suggestions, or ask questions, there are a number of ways for you to get in touch.

We hope that you enjoy using the Azure PowerShell!

You learned how to...

Contributors

  • Sean Wheeler
  • TaraMeyer