Share via


AppServiceEnvironment Class

Definition

Description of an App Service Environment.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.AppServiceEnvironmentTypeConverter))]
public class AppServiceEnvironment : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServiceEnvironment
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.AppServiceEnvironmentTypeConverter))>]
type AppServiceEnvironment = class
    interface IAppServiceEnvironment
    interface IJsonSerializable
Public Class AppServiceEnvironment
Implements IAppServiceEnvironment
Inheritance
AppServiceEnvironment
Attributes
Implements

Constructors

AppServiceEnvironment()

Creates an new AppServiceEnvironment instance.

Properties

AllowedMultiSize

List of comma separated strings describing which VM sizes are allowed for front-ends.

AllowedWorkerSize

List of comma separated strings describing which VM sizes are allowed for workers.

ApiManagementAccountId

API Management Account associated with the App Service Environment.

ClusterSetting

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

DatabaseEdition

Edition of the metadata database for the App Service Environment, e.g. "Standard".

DatabaseServiceObjective

Service objective of the metadata database for the App Service Environment, e.g. "S0".

DefaultFrontEndScaleFactor

Default Scale Factor for FrontEnds.

DnsSuffix

DNS suffix of the App Service Environment.

DynamicCacheEnabled

True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

EnvironmentCapacity

Current total, used, and available worker capacities.

EnvironmentIsHealthy

True/false indicating whether the App Service Environment is healthy.

EnvironmentStatus

Detailed message about with results of the last check of the App Service Environment.

FrontEndScaleFactor

Scale factor for front-ends.

HasLinuxWorker

Flag that displays whether an ASE has linux workers or not

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.

LastAction

Last deployment action on the App Service Environment.

LastActionResult

Result of the last deployment action on the App Service Environment.

Location

Location of the App Service Environment, e.g. "West US".

MaximumNumberOfMachine

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.

NetworkAccessControlList

Access control list for controlling traffic to the App Service Environment.

ProvisioningState

Provisioning state of the App Service Environment.

ResourceGroup

Resource group of the App Service Environment.

SslCertKeyVaultId

Key Vault ID for ILB App Service Environment default SSL certificate

SslCertKeyVaultSecretName

Key Vault Secret Name for ILB App Service Environment default SSL certificate

Status

Current status of the App Service Environment.

SubscriptionId

Subscription of the App Service Environment.

Suspended

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

UpgradeDomain

Number of upgrade domains of the App Service Environment.

UserWhitelistedIPRange

User added ip ranges to whitelist on ASE db

VipMapping

Description of IP SSL mapping for the App Service Environment.

VirtualNetworkId

Resource id of the Virtual Network.

VirtualNetworkName

Name of the Virtual Network (read-only).

VirtualNetworkSubnet

Subnet within the Virtual Network.

VirtualNetworkType

Resource type of the Virtual Network (read-only).

VnetName

Name of the Virtual Network for the App Service Environment.

VnetResourceGroupName

Resource group of the Virtual Network.

VnetSubnetName

Subnet of the Virtual Network.

WorkerPool

Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of AppServiceEnvironment.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of AppServiceEnvironment.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.IAppServiceEnvironment.

FromJsonString(String)

Creates a new instance of AppServiceEnvironment, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of AppServiceEnvironment into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to