Share via


AppServicePlan Class

Definition

AppServicePlan.

public class AppServicePlan : Azure.Provisioning.Primitives.ProvisionableResource
public class AppServicePlan : Azure.Provisioning.Primitives.Resource
type AppServicePlan = class
    inherit ProvisionableResource
type AppServicePlan = class
    inherit Resource
Public Class AppServicePlan
Inherits ProvisionableResource
Public Class AppServicePlan
Inherits Resource
Inheritance
Inheritance
Azure.Provisioning.Primitives.Resource
AppServicePlan

Constructors

AppServicePlan(String, String)

Creates a new AppServicePlan.

Properties

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
ExtendedLocation

Extended Location.

FreeOfferExpireOn

The time when the server farm free offer expires.

GeoRegion

Geographical location for the App Service plan.

HostingEnvironmentProfile

Specification for the App Service Environment to use for the App Service plan.

Id

Gets the Id.

IsAsyncScalingEnabled

If <code>true</code>, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If <code>false</code>, this App Service Plan will only attempt sync scaling.

IsElasticScaleEnabled

ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
IsHyperV

If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.

IsPerSiteScaling

If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.

IsReserved

If Linux app service plan <code>true</code>, <code>false</code> otherwise.

IsSpot

If <code>true</code>, this App Service Plan owns spot instances.

IsXenon

Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.

IsZoneRedundant

If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing.

Kind

Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.

KubeEnvironmentProfile

Specification for the Kubernetes Environment to use for the App Service plan.

Location

Gets or sets the Location.

MaximumElasticWorkerCount

Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

MaximumNumberOfWorkers

Maximum number of instances that can be assigned to this App Service plan.

Name

Name of the App Service plan.

NumberOfSites

Number of apps assigned to this App Service plan.

NumberOfWorkers

The number of instances that are assigned to this App Service plan.

ProvisioningState

Provisioning state of the App Service Plan.

ResourceGroup

Resource group of the App Service plan.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
Sku

Description of a SKU for a scalable resource.

SpotExpireOn

The time when the server farm expires. Valid only if it is a spot server farm.

Status

App Service plan status.

Subscription

App Service plan subscription.

SystemData

Gets the SystemData.

Tags

Gets or sets the Tags.

TargetWorkerCount

Scaling worker count.

TargetWorkerSizeId

Scaling worker size ID.

WorkerTierName

Target worker tier assigned to the App Service plan.

Methods

AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of AppServicePlan.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing AppServicePlan.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Applies to