Get-AzureVM

NAME Get-AzureVM



SYNOPSIS

Retrieves information from one or more Azure virtual machines.





SYNTAX

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

<String>] [<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.





PARAMETERS

-Profile <AzureSMProfile>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ServiceName <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

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.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









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

machine.



RELATED LINKS

New-AzureVM

New-AzureVMConfig

Remove-AzureVM

Restart-AzureVM

Restart-AzureVM

Stop-AzureVM

Update-AzureVM