Share via


Stop-AzureVM

Stop-AzureVM

Stops an Azure virtual machine.

Syntax

Parameter Set: Default
Stop-AzureVM [-ResourceGroupName] <String> [-Name] <String> [-Force] [-Profile <AzureProfile> ] [-StayProvisioned] [ <CommonParameters>]

Detailed Description

The Stop-AzureVM cmdlet stops an Azure virtual machine.

Parameters

-Force

Forces the command to run without asking for user confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the virtual machine to stop.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-Profile<AzureProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ResourceGroupName<String>

Specifies the name of a resource group.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

Accept Wildcard Characters?

false

-StayProvisioned

Indicates that this cmdlet uses the stay provisioned setting.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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: Stop a virtual machine

This command stops the virtual machine named VirtualMachine07 in ResourceGroup11.

Stop-AzureVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"

Get-AzureVM

New-AzureVM

Remove-AzureVM

Restart-AzureVM

Start-AzureVM

Update-AzureVM