Stop-AzureVM
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Stop-AzureVM
Shuts down an Azure virtual machine.
Syntax
Parameter Set: ByName
Stop-AzureVM [-ServiceName] <String> [-Name] <String> [[-StayProvisioned]] [[-Force]] [ <CommonParameters>]
Parameter Set: Input
Stop-AzureVM [-ServiceName] <String> [[-StayProvisioned]] [[-Force]] -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 Stop-AzureVM cmdlet requests a shutdown of a virtual machine.
Parameters
-Force
Allows the last virtual machine in a cloud service to be deallocated. This action releases the public, virtual IP address associated with the cloud service.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the virtual machine to shut down.
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 cloud service that contains the virtual machine to shut down.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-StayProvisioned
Keeps the virtual machine provisioned when it is stopped.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<PersistentVM>
Specifies a virtual machine object that identifies the virtual machine to shut down.
Aliases |
InputObject |
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 shuts down the "MyVM" virtual machine running in the "myservice1" Azure service.
C:\PS>Stop-AzureVM -ServiceName "myservice1" -Name "MyVM"
Example 2
This command shuts down the "MyVM" virtual machine running in the "myservice1" cloud service and keeps the virtual machine provisioned.
C:\PS>Stop-AzureVM -ServiceName "myservice1" -Name "MyVM" -StayProvisioned
Example 3
This command retrieves the virtual machine object for the virtual machine whose name is "MyVM". Then, it shuts down and deprovisions the virtual machine. If the virtual machine is the last one in a cloud service, the virtual machine is not shut down until you confirm this action because doing so releases the public virtual IP address associated with the cloud service.
C:\PS>Get-AzureVM -ServiceName "myservice1" -Name "MyVM" | Stop-AzureVM
Example 4
This command shuts down the "MyVM" virtual machine running in the "myservice1" cloud service even if it’s the last virtual machine in a cloud service, without prompting for confirmation.
C:\PS>Stop-AzureVM -ServiceName "myservice1" -Name "MyVM" -StayProvisioned
Related topics
Use Azure PowerShell to create and preconfigure Windows-based Virtual Machines