Stop-AzureVM

Module:
Azure
Shuts down an Azure virtual machine.

Syntax

Stop-AzureVM
    [-ServiceName] <String>
    [-Name] <String[]>
    [-StayProvisioned]
    [-Force]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]
Stop-AzureVM
    [-ServiceName] <String>
    [-StayProvisioned]
    [-Force]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [-Profile <AzureSMProfile>]
    -VM <IPersistentVM[]>
    [<CommonParameters>]

Description

The Stop-AzureVM cmdlet shuts down a virtual machine.

Examples

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.

Required Parameters

-Name

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 Roleshttp://msdn.microsoft.com/en-us/library/azure/dn469421.aspx operation (http://msdn.microsoft.com/en-us/library/azure/dn469421.aspx), instead of the Shutdown Rolehttp://msdn.microsoft.com/en-us/library/azure/jj157195.aspx operation (http://msdn.microsoft.com/en-us/library/azure/jj157195.aspx).

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServiceName

Specifies the name of the Azure service that contains the virtual machine to shut down.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VM

Specifies a virtual machine object that identifies the virtual machine to shut down.

Type:IPersistentVM[]
Aliases:InputObject
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Force

Specifies whether to allow the deallocation of the last virtual machine in a deployment.

Type:SwitchParameter
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Profile

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

Type:AzureSMProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-StayProvisioned

Specifies that this cmdlet keeps the virtual machine provisioned.

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