AppServiceEnvironment Class

Definition

Description of an App Service Environment.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.AppServiceEnvironmentTypeConverter))]
public class AppServiceEnvironment : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IAppServiceEnvironment
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.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

AllowNewPrivateEndpointConnection

Property to enable and disable new private endpoint connection creation on ASE

CertificateUrl

The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.

ClusterSetting

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

CustomDnsSuffixConfigurationId

Resource Id.

CustomDnsSuffixConfigurationKind

Kind of resource.

CustomDnsSuffixConfigurationName

Resource Name.

CustomDnsSuffixConfigurationPropertiesDnsSuffix

The default custom domain suffix to use for all sites deployed on the ASE.

CustomDnsSuffixConfigurationPropertiesProvisioningState
CustomDnsSuffixConfigurationType

Resource type.

DedicatedHostCount

Dedicated Host Count

DnsSuffix

DNS suffix of the App Service Environment.

ExternalInboundIPAddress
FrontEndScaleFactor

Scale factor for front-ends.

FtpEnabled

Property to enable and disable FTP on ASEV3

HasLinuxWorker

Flag that displays whether an ASE has linux workers or not

InboundIPAddressOverride

Customer provided Inbound IP Address. Only able to be set on Ase create.

InternalInboundIPAddress
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.

KeyVaultReferenceIdentity

The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.

LinuxOutboundIPAddress
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".

NetworkingConfigurationId

Resource Id.

NetworkingConfigurationKind

Kind of resource.

NetworkingConfigurationName

Resource Name.

NetworkingConfigurationType

Resource type.

ProvisioningDetail
ProvisioningState

Provisioning state of the App Service Environment.

RemoteDebugEnabled

Property to enable and disable Remote Debug on ASEV3

Status

Current status 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).

UpgradeAvailability

Whether an upgrade is available for this App Service Environment.

UpgradePreference

Upgrade Preference

UserWhitelistedIPRange

User added ip ranges to whitelist on ASE db

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).

WindowsOutboundIPAddress
ZoneRedundant

Whether or not this App Service Environment is zone-redundant.

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.Api20231201.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