Restart-AzWebApp
Restarts an Azure Web App.
Syntax
S1
Restart-AzWebApp
[-ResourceGroupName] <String>
[-Name] <String>
[-SoftRestart]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
S2
Restart-AzWebApp
[-WebApp] <PSSite>
[-SoftRestart]
[-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.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
WebApp Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
S1
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
Resource Group Name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
S1
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WebApp
WebApp Object
Parameter properties
Type: PSSite
Default value: None Supports wildcards: False DontShow: False
Parameter sets
S2
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
