Edit

Share via

Restart-AzWebApp

  • Reference
Module:
Az.Websites

Restarts an Azure Web App.

Syntax

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

Description

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

Examples

Example 1: Restart a Web App

Restart-AzWebApp -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:AzContext, 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

-SoftRestart

Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

PSSite

Outputs

PSSite