Set-AzureRmAppServicePlan

Sets an Azure App Service plan.

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

Set-AzureRmAppServicePlan
   [[-AdminSiteName] <String>]
   [[-Tier] <String>]
   [[-NumberofWorkers] <Int32>]
   [[-WorkerSize] <String>]
   [-PerSiteScaling <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzureRmAppServicePlan
   [-AsJob]
   [-AppServicePlan] <PSAppServicePlan>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzureRmAppServicePlan cmdlet sets an Azure App Service plan.

Examples

1: Modify an App Service plan

PS C:\>Set-AzureRmAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -PerSiteScaling $true

This command sets the PerSiteScaling option to true on the App Service plan named ContosoASP that belongs to the resource group named Default-Web-WestUS.

Parameters

-AdminSiteName

Admin Site Name

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

-AppServicePlan

App Service Plan Object

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

-AsJob

Run cmdlet in the background

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

-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

App Service Plan Name

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

-NumberofWorkers

Number Of Workers

Type:Int32
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PerSiteScaling

Per Site Scaling Boolean

Type:Boolean
Position:Named
Default value:False
Required:False
Accept pipeline input:False
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

-Tier

Tier

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

-WorkerSize

Worker Size

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

Inputs

AppServicePlan

Parameters: AppServicePlan (ByValue)

Outputs

AppServicePlan