Stop-AzureRmVM

Stops an Azure virtual machine.

Caution

The AzureRM PowerShell module will retire on 29 February 2024. For more information, see Migrate Azure PowerShell from AzureRM to Az.

Retirement indicates that the AzureRM PowerShell module will be deprecated, subsequently ceasing to receive support. While this does not inherently mean the module will stop functioning, its use beyond 29 February 2024 will be at the user's discretion and risk, as it will no longer be maintained or updated.

Syntax

Stop-AzureRmVM
    [-Name] <String>
    [-Force]
    [-StayProvisioned]
    [-ResourceGroupName] <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzureRmVM
    [-Name] <String>
    [-Force]
    [-StayProvisioned]
    [-Id] <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzureRmVM cmdlet stops an Azure virtual machine.

Examples

Example 1: Stop a virtual machine

PS C:\> Stop-AzureRmVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"

This command stops the virtual machine named VirtualMachine07 in ResourceGroup11.

Parameters

-AsJob

Run cmdlet in the background and return a Job to track progress.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

The resource group name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The virtual machine name.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group of the virtual machine.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-StayProvisioned

The cmdlet stops all the virtual machines within the VMSS but does not deallocate them. The account is charged for the stopped virtual machines.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSComputeLongRunningOperation