Edit

Share via

Restart-AzureRmWebApp

  • Reference
Module:
AzureRM.Websites

Restarts an Azure Web App.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Restart-AzureRmWebApp
       [-ResourceGroupName] <String>
       [-Name] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]
Restart-AzureRmWebApp
       [-WebApp] <PSSite>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]

Description

The Restart-AzureRmWebApp cmdlet stops and then starts an Azure Web App. If the Web App is in a stopped state, use the Start-AzureRmWebApp cmdlet.

Examples

Example 1: Restart a Web App

PS C:\>Restart-AzureRmWebApp -ResourceGroupName "Default-Web-WestUS" -Name "ContosoSite"

This command stops the Azure Web App named ContosoSite that belongs to the resource group named Default-Web-WestUS and then restarts it.

Parameters

-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

-Name

WebApp Name

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

-ResourceGroupName

Resource Group Name

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

-WebApp

WebApp Object

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

Inputs

String

Site

Parameters: WebApp (ByValue)

Outputs

Site