Edit

Share via

Restart-AzureVM

  • Reference
Module:
Azure

Restarts an Azure virtual machine.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Restart-AzureVM
       [-Name] <String>
       [-ServiceName] <String>
       [-Profile <AzureSMProfile>]
       [-InformationAction <ActionPreference>]
       [-InformationVariable <String>]
       [<CommonParameters>]
Restart-AzureVM
       [-Name] <String>
       [-Redeploy]
       [-ServiceName] <String>
       [-Profile <AzureSMProfile>]
       [-InformationAction <ActionPreference>]
       [-InformationVariable <String>]
       [<CommonParameters>]
Restart-AzureVM
       [-Name] <String>
       [-InitiateMaintenance]
       [-ServiceName] <String>
       [-Profile <AzureSMProfile>]
       [-InformationAction <ActionPreference>]
       [-InformationVariable <String>]
       [<CommonParameters>]
Restart-AzureVM
       -VM <PersistentVM>
       [-ServiceName] <String>
       [-Profile <AzureSMProfile>]
       [-InformationAction <ActionPreference>]
       [-InformationVariable <String>]
       [<CommonParameters>]
Restart-AzureVM
       -VM <PersistentVM>
       [-Redeploy]
       [-ServiceName] <String>
       [-Profile <AzureSMProfile>]
       [-InformationAction <ActionPreference>]
       [-InformationVariable <String>]
       [<CommonParameters>]
Restart-AzureVM
       -VM <PersistentVM>
       [-InitiateMaintenance]
       [-ServiceName] <String>
       [-Profile <AzureSMProfile>]
       [-InformationAction <ActionPreference>]
       [-InformationVariable <String>]
       [<CommonParameters>]

Description

The Restart-AzureVM cmdlet requests a restart of an Azure virtual machine.

Examples

Example 1: Restart a virtual machine

PS C:\> Restart-AzureVM -ServiceName "MyService01" -Name "MyVM"

This command restarts the VirtualMachine27 virtual machine running in the Azure service named Service01.

Example 2: Restart a virtual machine by using a virtual machine object

PS C:\> Get-AzureVM -ServiceName "MyService01" -Name "VirtualMachine27" | Restart-AzureVM

This command retrieves the virtual machine object for the virtual machine named MyVM and then restarts it.

Parameters

-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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Specifies an information variable.

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

-InitiateMaintenance

Initiate Maintenance on the Virtual Machine

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

-Name

Specifies the name of the virtual machine to restart.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Redeploy

Indicates that the cmdlet redeploys the virtual machine.

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

-ServiceName

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

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

-VM

Specifies a virtual machine object that identifies the virtual machine to restart.

Type:PersistentVM
Aliases:InputObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False