Restart-AzureVM
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Restart-AzureVM
Restarts an Azure virtual machine.
Syntax
Parameter Set: ByName
Restart-AzureVM [-ServiceName] <String> [-Name] <String> [ <CommonParameters>]
Parameter Set: Input
Restart-AzureVM [-ServiceName] <String> -VM <PersistentVM> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The Restart-AzureVM cmdlet requests a reboot of a virtual machine.
Parameters
-Name<String>
Specifies the name of the virtual machine to restart.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies the name of the Azure service that contains the virtual machine to restart.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VM<PersistentVM>
A virtual machine object that identifies the virtual machine to restart.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This command restarts the "MyVM" virtual machine running in the "myservice1" Azure service.
C:\PS>Restart-AzureVM -ServiceName "myservice1" –Name "MyVM"
Example 2
This command retrieves the virtual machine object for the virtual machine whose name is "MyVM" and then restarts it.
C:\PS>Get-AzureVM -ServiceName "myservice1" -Name "MyVM" | Restart-AzureVM