< Back
Stop-AzureRmVM
Post
NAME Stop-AzureRmVM
SYNOPSIS
Stops an Azure virtual machine.
SYNTAX
Stop-AzureRmVM [-Id] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] [-StayProvisioned] [-Confirm]
[-WhatIf] [<CommonParameters>]
Stop-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] [-StayProvisioned]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmVM cmdlet stops an Azure virtual machine.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background and return a Job to track progress.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
The virtual machine name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group of the virtual machine.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StayProvisioned [<SwitchParameter>]
The cmdlet stops all the virtual machines within the VMSS but does not deallocate them. The account is charged for the stopped virtual
machines.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation
NOTES
Example 1: Stop a virtual machine
PS C:\\> Stop-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"
This command stops the virtual machine named VirtualMachine07 in ResourceGroup11.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... -azurermvm
Get-AzureRmVmssDiskEncryption
New-AzureRmVMConfig
Remove-AzureRmVM
Restart-AzureRmVM
Restart-AzureRmVM
Update-AzureRmVmss
SYNOPSIS
Stops an Azure virtual machine.
SYNTAX
Stop-AzureRmVM [-Id] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] [-StayProvisioned] [-Confirm]
[-WhatIf] [<CommonParameters>]
Stop-AzureRmVM [-ResourceGroupName] <String> [-Name] <String> [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] [-StayProvisioned]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmVM cmdlet stops an Azure virtual machine.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background and return a Job to track progress.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
The virtual machine name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group of the virtual machine.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StayProvisioned [<SwitchParameter>]
The cmdlet stops all the virtual machines within the VMSS but does not deallocate them. The account is charged for the stopped virtual
machines.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSComputeLongRunningOperation
NOTES
Example 1: Stop a virtual machine
PS C:\\> Stop-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"
This command stops the virtual machine named VirtualMachine07 in ResourceGroup11.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... -azurermvm
Get-AzureRmVmssDiskEncryption
New-AzureRmVMConfig
Remove-AzureRmVM
Restart-AzureRmVM
Restart-AzureRmVM
Update-AzureRmVmss