Get-​Azure​VM

Retrieves information from one or more Azure virtual machines.

Syntax

Get-AzureVM
   [-ServiceName] <String>
   [[-Name] <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureVM cmdlet retrieves information about virtual machines running in Azure. It returns an object with information on a specific virtual machine, or if no virtual machine is specified, for all the virtual machines in the specified service of the current subscription.

Examples

Example 1: Retrieve information on a specified virtual machine

PS C:\> Get-AzureVM -ServiceName "ContosoService01" -Name "VirtualMachine02"

This command returns an object with information on the VirtualMachine02 virtual machine running in the ContosoService01 cloud service.

Example 2: Retrieve information on all virtual machines

PS C:\> Get-AzureVM -ServiceName "ContosoService01"

This command retrieves a list object with information on all of the virtual machines running in the ContosoService01 cloud service.

Example 3: Display a table of virtual machine statuses

PS C:\> Get-AzureVM -ServiceName "ContosoService01"  | Format-Table AutoSize -Property "Name",@{Expression={$_.InstanceUpgradeDomain};Label="UpgDom";Align="Right"},"InstanceStatus"

This command displays a table showing the virtual machines running on the ContosoService01 service, their Upgrade Domain, and the current status of each virtual machine.

Required Parameters

-ServiceName

Specifies the name of the cloud service for which to return virtual machine information.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the virtual machine for which to retrieve information. If this parameter is not provided, the cmdlet returns a list object with information about all the virtual machines in the specified service.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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