Share via

AppServiceEnvironment Class

Definition

Namespace:
Azure.Provisioning.AppService
Assembly:
Azure.Provisioning.AppService.dll
Package:
Azure.Provisioning.AppService v1.3.0
Package:
Azure.Provisioning.AppService v1.3.0-beta.1
Source:
AppServiceEnvironment.cs
Source:
AppServiceEnvironment.cs

AppServiceEnvironment.

public class AppServiceEnvironment : Azure.Provisioning.Primitives.ProvisionableResource
type AppServiceEnvironment = class
    inherit ProvisionableResource
Public Class AppServiceEnvironment
Inherits ProvisionableResource
Inheritance
Object
Provisionable
ProvisionableConstruct
NamedProvisionableConstruct
ProvisionableResource
AppServiceEnvironment

Constructors

Name Description
AppServiceEnvironment(String, String)

Creates a new AppServiceEnvironment.

Properties

Name Description
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)
ClusterSettings

Custom settings for changing the behavior of the App Service Environment.
CustomDnsSuffixConfig

Full view of the custom domain suffix configuration for ASEv3.
DedicatedHostCount

Dedicated Host Count.
DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
DnsSuffix

DNS suffix of the App Service Environment.
FrontEndScaleFactor

Scale factor for front-ends.
HasLinuxWorkers

Flag that displays whether an ASE has linux workers or not.
Id

Gets the Id.
InternalLoadBalancingMode

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
IPSslAddressCount

Number of IP SSL addresses reserved for the App Service Environment.
IsExistingResource

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

(Inherited from ProvisionableResource)
IsSuspended

<code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
IsZoneRedundant

Whether or not this App Service Environment is zone-redundant.
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.
Location

Gets or sets the Location.
MaximumNumberOfMachines

Maximum number of VMs in the App Service Environment.
MultiRoleCount

Number of front-end instances.
MultiSize

Front-end VM size, e.g. "Medium", "Large".
Name

Name of the App Service Environment.
NetworkingConfig

Full view of networking configuration for an ASE.
ProvisioningState

Provisioning state of the App Service Environment.
ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
Status

Current status of the App Service Environment.
SystemData

Gets the SystemData.
Tags

Gets or sets the Tags.
UpgradeAvailability

Whether an upgrade is available for this App Service Environment.
UpgradePreference

Upgrade Preference.
UserWhitelistedIPRanges

User added ip ranges to whitelist on ASE db.
VirtualNetwork

Description of the Virtual Network.

Methods

Name Description
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)
DefineModelProperty<T>(String, String[], T, 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 AppServiceEnvironment.
DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing AppServiceEnvironment.
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

Name Description
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)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to