< Back
Stop-AzureVM
Post
NAME Stop-AzureVM
SYNOPSIS
Shuts down an Azure virtual machine.
SYNTAX
Stop-AzureVM [-ServiceName] <String> [-Name] <String[]> [[-StayProvisioned]] [[-Force]] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Stop-AzureVM [-ServiceName] <String> [[-StayProvisioned]] [[-Force]] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -VM <IPersistentVM[]> [<CommonParameters>]
DESCRIPTION
The Stop-AzureVM cmdlet shuts down a virtual machine.
PARAMETERS
-Name <String[]>
Specifies the name of the virtual machine to shut down.
Use the wildcard character to stop multiple virtual machines asynchronously. With a wildcard character, this cmdlet calls the Shutdown Roles
operation (http://msdn.microsoft.com/en-us/library ... 69421.aspx), instead of the Shutdown Role operation
(http://msdn.microsoft.com/en-us/library ... 57195.aspx).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StayProvisioned [<SwitchParameter>]
Specifies that this cmdlet keeps the virtual machine provisioned.
Required? false
Position? 2
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Specifies whether to allow the deallocation of the last virtual machine in a deployment.
Required? false
Position? 3
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ServiceName <String>
Specifies the name of the Azure service that contains the virtual machine to shut down.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-VM <IPersistentVM[]>
Specifies a virtual machine object that identifies the virtual machine to shut down.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- Example 1: Shut down a virtual machine --------------------------
PS C:\\>Stop-AzureVM -ServiceName "ContosoService01" -Name "MyVM"
This command shuts down a virtual machine that the specified service contains.
-------------------------- Example 2: Shut down a virtual machine by using a virtual machine object --------------------------
PS C:\\>Get-AzureVM -ServiceName "ContosoService01" -Name "MyVM" | Stop-AzureVM
This command shuts down a virtual machine that the specified service contains, by using the virtual machine object that Get-AzureVM returns.
-------------------------- Example 3: Shut down a VM and keep the VM provisioned --------------------------
PS C:\\>Stop-AzureVM -ServiceName "ContosoService01" -Name "MyVM" -StayProvisioned
This command shuts down a virtual machine that the specified service contains, and keeps it provisioned.
-------------------------- Example 4: Shut down a VM and allow deallocation of the last VM in the deployment --------------------------
PS C:\\>Stop-AzureVM -ServiceName "ContosoService01" -Name "MyVM" -Force
This command shuts down a virtual machine that the specified service contains and allows deallocation of the last virtual machine in the deployment.
-------------------------- Example 5: Shut down multiple VMs --------------------------
PS C:\\>Stop-AzureVM -ServiceName "PSTestService" -Name "*" -Force
This command shuts down multiple virtual machines that the specified service contains.
RELATED LINKS
Get-AzureVM
New-AzureVM
Restart-AzureVM
Restart-AzureVM
SYNOPSIS
Shuts down an Azure virtual machine.
SYNTAX
Stop-AzureVM [-ServiceName] <String> [-Name] <String[]> [[-StayProvisioned]] [[-Force]] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Stop-AzureVM [-ServiceName] <String> [[-StayProvisioned]] [[-Force]] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -VM <IPersistentVM[]> [<CommonParameters>]
DESCRIPTION
The Stop-AzureVM cmdlet shuts down a virtual machine.
PARAMETERS
-Name <String[]>
Specifies the name of the virtual machine to shut down.
Use the wildcard character to stop multiple virtual machines asynchronously. With a wildcard character, this cmdlet calls the Shutdown Roles
operation (http://msdn.microsoft.com/en-us/library ... 69421.aspx), instead of the Shutdown Role operation
(http://msdn.microsoft.com/en-us/library ... 57195.aspx).
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StayProvisioned [<SwitchParameter>]
Specifies that this cmdlet keeps the virtual machine provisioned.
Required? false
Position? 2
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Specifies whether to allow the deallocation of the last virtual machine in a deployment.
Required? false
Position? 3
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ServiceName <String>
Specifies the name of the Azure service that contains the virtual machine to shut down.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-VM <IPersistentVM[]>
Specifies a virtual machine object that identifies the virtual machine to shut down.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- Example 1: Shut down a virtual machine --------------------------
PS C:\\>Stop-AzureVM -ServiceName "ContosoService01" -Name "MyVM"
This command shuts down a virtual machine that the specified service contains.
-------------------------- Example 2: Shut down a virtual machine by using a virtual machine object --------------------------
PS C:\\>Get-AzureVM -ServiceName "ContosoService01" -Name "MyVM" | Stop-AzureVM
This command shuts down a virtual machine that the specified service contains, by using the virtual machine object that Get-AzureVM returns.
-------------------------- Example 3: Shut down a VM and keep the VM provisioned --------------------------
PS C:\\>Stop-AzureVM -ServiceName "ContosoService01" -Name "MyVM" -StayProvisioned
This command shuts down a virtual machine that the specified service contains, and keeps it provisioned.
-------------------------- Example 4: Shut down a VM and allow deallocation of the last VM in the deployment --------------------------
PS C:\\>Stop-AzureVM -ServiceName "ContosoService01" -Name "MyVM" -Force
This command shuts down a virtual machine that the specified service contains and allows deallocation of the last virtual machine in the deployment.
-------------------------- Example 5: Shut down multiple VMs --------------------------
PS C:\\>Stop-AzureVM -ServiceName "PSTestService" -Name "*" -Force
This command shuts down multiple virtual machines that the specified service contains.
RELATED LINKS
Get-AzureVM
New-AzureVM
Restart-AzureVM
Restart-AzureVM