New-AzAppServicePlan

Module:: Az.Websites Module

Creates an Azure App Service plan in a given Geo location.

Syntax

S1

New-AzAppServicePlan
    [-Location] <String>
    [[-Tier] <String>]
    [[-NumberofWorkers] <Int32>]
    [[-WorkerSize] <String>]
    [[-AseName] <String>]
    [[-AseResourceGroupName] <String>]
    [[-AseResourceId] <String>]
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-PerSiteScaling <Boolean>]
    [-AsyncScalingEnabled <Boolean>]
    [-HyperV]
    [-AsJob]
    [-Tag <Hashtable>]
    [-Linux]
    [-ManagedInstance]
    [-AssignIdentity <Boolean>]
    [-UserAssignedIdentityId <String[]>]
    [-DefaultIdentity <String>]
    [-RdpEnabled <Boolean>]
    [-VirtualNetworkSubnetId <String>]
    [-InstallScript <InstallScript[]>]
    [-StorageMount <StorageMount[]>]
    [-RegistryAdapter <RegistryAdapter[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

S2

New-AzAppServicePlan
    [-Location] <String>
    [[-Tier] <String>]
    [[-NumberofWorkers] <Int32>]
    [[-WorkerSize] <String>]
    [[-AseName] <String>]
    [[-AseResourceGroupName] <String>]
    [[-AseResourceId] <String>]
    [-AppServicePlan] <PSAppServicePlan>
    [-PerSiteScaling <Boolean>]
    [-AsyncScalingEnabled <Boolean>]
    [-AsJob]
    [-AssignIdentity <Boolean>]
    [-UserAssignedIdentityId <String[]>]
    [-DefaultIdentity <String>]
    [-RdpEnabled <Boolean>]
    [-VirtualNetworkSubnetId <String>]
    [-InstallScript <InstallScript[]>]
    [-StorageMount <StorageMount[]>]
    [-RegistryAdapter <RegistryAdapter[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-AcquirePolicyToken]
    [-ChangeReference <String>]
    [<CommonParameters>]

Description

The New-AzAppServicePlan cmdlet creates an Azure App Service plan in a given Geo location with the specified Tier, worker size, and number of workers.

Use -AsyncScalingEnabled $true to allow asynchronous scaling when there are insufficient workers to scale synchronously. This setting requires a dedicated App Service plan and does not run the cmdlet in the background; use -AsJob for background execution.

Use -ManagedInstance to create a Managed Instance plan for Windows applications that require operating system customization. Configure managed identities, installation scripts, storage mounts, registry adapters, plan-level virtual network integration, and Remote Desktop Protocol (RDP) access with the corresponding parameters. Managed Instance plans cannot use -Linux or -HyperV.

Examples

Example 1: Create an App Service plan

New-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoASP" -Location "West US" -Tier "Basic" -NumberofWorkers 2 -WorkerSize "Small"

This command creates an App Service plan named ContosoASP in the resource group named Default-Web-WestUS in Geo location West US. The command specifies a Basic Tier and allocates two small workers.

Example 2: Create an Isolated v4 App Service plan

New-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoIsolatedASP" -Location "West US" -Tier "IsolatedV4" -WorkerSize "ExtraExtraExtraLarge" -AseName "ContosoAse"

This command creates an I6V4 App Service plan in the App Service Environment named ContosoAse. Use worker sizes Small through ExtraExtraExtraLarge to select I1V4 through I6V4.

Example 3: Create a memory-optimized Isolated v4 App Service plan

New-AzAppServicePlan -ResourceGroupName "Default-Web-WestUS" -Name "ContosoMemoryOptimizedASP" -Location "West US" -Tier "IsolatedMV4" -WorkerSize "ExtraExtraLarge" -AseName "ContosoAse"

This command creates an I5MV4 memory-optimized App Service plan in the App Service Environment named ContosoAse. Use worker sizes Small through ExtraExtraLarge to select I1MV4 through I5MV4.

Example 4: Create a Managed Instance plan with an identity and networking

$subnetId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ContosoRG/providers/Microsoft.Network/virtualNetworks/ContosoVnet/subnets/ContosoSubnet"
New-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoManagedPlan" -Location "eastus" -Tier "PremiumV4" -WorkerSize "Small" -NumberofWorkers 1 -ManagedInstance -AssignIdentity $true -DefaultIdentity "[system]" -RdpEnabled $true -VirtualNetworkSubnetId $subnetId

This command creates a Managed Instance plan, enables its system-assigned managed identity and RDP access, and integrates the plan with an existing subnet. The subnet must meet the App Service virtual network integration requirements, including delegation to Microsoft.Web/serverFarms. The system-assigned identity is used by default for plan integrations.

Example 5: Configure scripts, storage mounts, and registry adapters

$script = @{
    Name = "setup"
    Source = @{
        # The ZIP package must contain Install.ps1 at its root.
        SourceUri = "https://contosostorage.blob.core.windows.net/scripts/setup.zip"
        Type = "RemoteAzureBlob"
    }
}
$mount = @{
    Name = "data"
    Type = "AzureFiles"
    Source = "\\contosostorage.file.core.windows.net\data"
    DestinationPath = "D:\data"
    CredentialsKeyVaultReference = @{
        SecretUri = "https://contosovault.vault.azure.net/secrets/storage-credentials"
    }
}
$adapter = @{
    RegistryKey = "HKEY_LOCAL_MACHINE\Software\Contoso\Setting"
    Type = "String"
    KeyVaultSecretReference = @{
        SecretUri = "https://contosovault.vault.azure.net/secrets/registry-setting"
    }
}
New-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoManagedPlan" -Location "eastus" -Tier "PremiumV4" -ManagedInstance -AssignIdentity $true -DefaultIdentity "[system]" -InstallScript $script -StorageMount $mount -RegistryAdapter $adapter

This command configures an installation script, an Azure Files mount, and a registry adapter when creating the plan. The plan identity must have permission to access the script and the referenced Key Vault secrets. Hashtable values are converted to the corresponding configuration objects.

Example 6: Create an App Service plan with asynchronous scaling enabled

New-AzAppServicePlan -ResourceGroupName "ContosoRG" -Name "ContosoASP" -Location "East US" -Tier "PremiumV3" -WorkerSize "Small" -NumberofWorkers 10 -AsyncScalingEnabled $true

This command creates a dedicated App Service plan that can scale asynchronously when there are insufficient workers to fulfill the request synchronously. The cmdlet waits for the operation to complete before returning the plan.

Parameters

-AcquirePolicyToken

Acquire an Azure Policy token automatically for this resource operation.

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

-AppServicePlan

App Service Plan Object

Parameter properties

Type:	PSAppServicePlan
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AseName

App Service Environment Name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	6
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AseResourceGroupName

App Service Environment Resource Group Name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	7
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AseResourceId

Resource id of App Service Environment

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	8
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-AsJob

Run cmdlet in the background

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

-AssignIdentity

Enable or disable the system-assigned managed identity on the App Service plan. User-assigned identities are configured separately with -UserAssignedIdentityId.

Parameter properties

Type:	Boolean
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

-AsyncScalingEnabled

Enable or disable asynchronous scaling for a dedicated App Service plan. Set to true to allow an asynchronous operation when there are insufficient workers to scale synchronously, or false to allow only synchronous scaling. Omit this parameter to use the service default. This setting is independent of -AsJob.

Parameter properties

Type:	Nullable<T>[Boolean]
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

-ChangeReference

The change reference resource ID for this resource operation.

Parameter properties

Type:	String
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

-DefaultIdentity

The identity used by default for plan integrations. Specify [system] to use the plan's system-assigned identity, or the resource ID of a user-assigned identity associated with the plan. Pass an empty string to clear the default identity.

Parameter properties

Type:	String
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

-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

-HyperV

Specify this, App Service Plan will run Windows Containers

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InstallScript

The installation scripts to configure for the Managed Instance plan. Each object specifies a Name and a Source containing SourceUri and Type. Supported source types include RemoteAzureBlob and PlatformStorage.

Parameter properties

Type:	InstallScript[]
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

-Linux

Specify this, App Service Plan will run Linux Containers

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Location

Location

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ManagedInstance

Create a Managed Instance App Service plan by enabling custom mode. Use this option for Windows applications that need installation scripts, registry customization, or plan-level storage mounts. This option cannot be combined with -Linux or -HyperV.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

App Service Plan Name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NumberofWorkers

Number Of Workers

Parameter properties

Type:	Int32
Default value:	1
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	4
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PerSiteScaling

Whether or not to enable Per Site Scaling

Parameter properties

Type:	Boolean
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

-RdpEnabled

Enable or disable Remote Desktop Protocol (RDP) access to the Managed Instance plan. Use Get-AzAppServicePlanRdpCredential to retrieve the credentials and Get-AzAppServicePlanManagedInstance to retrieve worker IP addresses.

Parameter properties

Type:	Boolean
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

-RegistryAdapter

The registry adapters to configure for the Managed Instance plan. Each object specifies RegistryKey, Type, and a KeyVaultSecretReference containing the SecretUri of the registry value. Supported types include Binary, String, Expand_String, Multi_String, DWord, and QWord.

Parameter properties

Type:	RegistryAdapter[]
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

-ResourceGroupName

Resource Group Name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-StorageMount

The storage mounts to configure for the Managed Instance plan. Each object specifies Name, Type, and DestinationPath. AzureFiles and FileShare mounts also require a Source; use CredentialsKeyVaultReference.SecretUri for credentials stored in Key Vault. LocalStorage mounts do not require a source.

Parameter properties

Type:	StorageMount[]
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

-Tag

Tags are name/value pairs that enable you to categorize resources

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Tier

The App Service plan tier. Use IsolatedV4 for I1V4 through I6V4 plans and IsolatedMV4 for I1MV4 through I5MV4 memory-optimized plans in an App Service Environment.

Parameter properties

Type:	String
Default value:	Free
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	3
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UserAssignedIdentityId

The resource IDs of user-assigned managed identities to associate with the App Service plan. Use -DefaultIdentity to select the identity used by default for plan integrations.

Parameter properties

Type:	String[]
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

-VirtualNetworkSubnetId

The full resource ID of the existing subnet used for plan-level virtual network integration. The subnet must be configured for App Service integration, including delegation to Microsoft.Web/serverFarms.

Parameter properties

Type:	String
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

-WorkerSize

The size of the workers to allocate. For IsolatedV4, Small through ExtraExtraExtraLarge select I1V4 through I6V4. For IsolatedMV4, Small through ExtraExtraLarge select I1MV4 through I5MV4.

Parameter properties

Type:	String
Default value:	Small
Accepted values:	ExtraSmall, Small, Medium, Large, ExtraLarge, ExtraExtraLarge, ExtraExtraExtraLarge
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	5
Mandatory:	False
Value from pipeline:	False
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.