AppServiceEnvironment Class

Definition

Description of an App Service Environment.

public class AppServiceEnvironment
type AppServiceEnvironment = class
Public Class AppServiceEnvironment
Inheritance
AppServiceEnvironment

Constructors

AppServiceEnvironment()

Initializes a new instance of the AppServiceEnvironment class.

AppServiceEnvironment(String, String, VirtualNetworkProfile, IList<WorkerPool>, Nullable<ProvisioningState>, Nullable<HostingEnvironmentStatus>, String, String, String, Nullable<InternalLoadBalancingMode>, String, Nullable<Int32>, Nullable<Int32>, String, String, Nullable<Int32>, String, String, String, String, String, String, Nullable<Int32>, IList<VirtualIPMapping>, IList<StampCapacity>, IList<NetworkAccessControlEntry>, Nullable<Boolean>, String, String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>, IList<NameValuePair>)

Properties

AllowedMultiSizes

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

AllowedWorkerSizes

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

ApiManagementAccountId

Gets or sets API Management Account associated with the App Service Environment.

ClusterSettings

Gets or sets custom settings for changing the behavior of the App Service Environment.

DatabaseEdition

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

DatabaseServiceObjective

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

DefaultFrontEndScaleFactor

Gets default Scale Factor for FrontEnds.

DnsSuffix

Gets or sets DNS suffix of the App Service Environment.

DynamicCacheEnabled

Gets or sets 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).

EnvironmentCapacities

Gets current total, used, and available worker capacities.

EnvironmentIsHealthy

Gets true/false indicating whether the App Service Environment is healthy.

EnvironmentStatus

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

FrontEndScaleFactor

Gets or sets scale factor for front-ends.

InternalLoadBalancingMode

Gets or sets specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'

IpsslAddressCount

Gets or sets number of IP SSL addresses reserved for the App Service Environment.

LastAction

Gets last deployment action on the App Service Environment.

LastActionResult

Gets result of the last deployment action on the App Service Environment.

Location

Gets or sets location of the App Service Environment, e.g. "West US".

MaximumNumberOfMachines

Gets maximum number of VMs in the App Service Environment.

MultiRoleCount

Gets or sets number of front-end instances.

MultiSize

Gets or sets front-end VM size, e.g. "Medium", "Large".

Name

Gets or sets name of the App Service Environment.

NetworkAccessControlList

Gets or sets access control list for controlling traffic to the App Service Environment.

ProvisioningState

Gets provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'

ResourceGroup

Gets resource group of the App Service Environment.

Status

Gets current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'

SubscriptionId

Gets subscription of the App Service Environment.

Suspended

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

UpgradeDomains

Gets number of upgrade domains of the App Service Environment.

VipMappings

Gets description of IP SSL mapping for the App Service Environment.

VirtualNetwork

Gets or sets description of the Virtual Network.

VnetName

Gets or sets name of the Virtual Network for the App Service Environment.

VnetResourceGroupName

Gets or sets resource group of the Virtual Network.

VnetSubnetName

Gets or sets subnet of the Virtual Network.

WorkerPools

Gets or sets description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

Methods

Validate()

Validate the object.

Applies to