AppServiceEnvironmentInner Class

Package:

com.azure.resourcemanager.appservice.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.47.0

• java.lang.Object
• • com.azure.resourcemanager.appservice.fluent.models.AppServiceEnvironmentInner

Implements

JsonSerializable<AppServiceEnvironmentInner>

public final class AppServiceEnvironmentInner
implements JsonSerializable<AppServiceEnvironmentInner>

Description of an App Service Environment.

Constructor Summary

Constructor	Description
AppServiceEnvironmentInner()	Creates an instance of AppServiceEnvironmentInner class.

Method Summary

Modifier and Type	Method and Description
List<NameValuePair>	clusterSettings() Get the clusterSettings property: Custom settings for changing the behavior of the App Service Environment.
CustomDnsSuffixConfigurationInner	customDnsSuffixConfiguration() Get the customDnsSuffixConfiguration property: Full view of the custom domain suffix configuration for ASEv3.
Integer	dedicatedHostCount() Get the dedicatedHostCount property: Dedicated Host Count.
String	dnsSuffix() Get the dnsSuffix property: DNS suffix of the App Service Environment.
static AppServiceEnvironmentInner	fromJson(JsonReader jsonReader) Reads an instance of AppServiceEnvironmentInner from the JsonReader.
Integer	frontEndScaleFactor() Get the frontEndScaleFactor property: Scale factor for front-ends.
Boolean	hasLinuxWorkers() Get the hasLinuxWorkers property: Flag that displays whether an ASE has linux workers or not.
LoadBalancingMode	internalLoadBalancingMode() Get the internalLoadBalancingMode property: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
Integer	ipsslAddressCount() Get the ipsslAddressCount property: Number of IP SSL addresses reserved for the App Service Environment.
Integer	maximumNumberOfMachines() Get the maximumNumberOfMachines property: Maximum number of VMs in the App Service Environment.
Integer	multiRoleCount() Get the multiRoleCount property: Number of front-end instances.
String	multiSize() Get the multiSize property: Front-end VM size, e.g.
AseV3NetworkingConfigurationInner	networkingConfiguration() Get the networkingConfiguration property: Full view of networking configuration for an ASE.
ProvisioningState	provisioningState() Get the provisioningState property: Provisioning state of the App Service Environment.
HostingEnvironmentStatus	status() Get the status property: Current status of the App Service Environment.
Boolean	suspended() Get the suspended property: true if the App Service Environment is suspended; otherwise, false.
JsonWriter	toJson(JsonWriter jsonWriter)
UpgradeAvailability	upgradeAvailability() Get the upgradeAvailability property: Whether an upgrade is available for this App Service Environment.
UpgradePreference	upgradePreference() Get the upgradePreference property: Upgrade Preference.
List<String>	userWhitelistedIpRanges() Get the userWhitelistedIpRanges property: User added ip ranges to whitelist on ASE db.
void	validate() Validates the instance.
VirtualNetworkProfile	virtualNetwork() Get the virtualNetwork property: Description of the Virtual Network.
AppServiceEnvironmentInner	withClusterSettings(List<NameValuePair> clusterSettings) Set the clusterSettings property: Custom settings for changing the behavior of the App Service Environment.
AppServiceEnvironmentInner	withCustomDnsSuffixConfiguration(CustomDnsSuffixConfigurationInner customDnsSuffixConfiguration) Set the customDnsSuffixConfiguration property: Full view of the custom domain suffix configuration for ASEv3.
AppServiceEnvironmentInner	withDedicatedHostCount(Integer dedicatedHostCount) Set the dedicatedHostCount property: Dedicated Host Count.
AppServiceEnvironmentInner	withDnsSuffix(String dnsSuffix) Set the dnsSuffix property: DNS suffix of the App Service Environment.
AppServiceEnvironmentInner	withFrontEndScaleFactor(Integer frontEndScaleFactor) Set the frontEndScaleFactor property: Scale factor for front-ends.
AppServiceEnvironmentInner	withInternalLoadBalancingMode(LoadBalancingMode internalLoadBalancingMode) Set the internalLoadBalancingMode property: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
AppServiceEnvironmentInner	withIpsslAddressCount(Integer ipsslAddressCount) Set the ipsslAddressCount property: Number of IP SSL addresses reserved for the App Service Environment.
AppServiceEnvironmentInner	withMultiSize(String multiSize) Set the multiSize property: Front-end VM size, e.g.
AppServiceEnvironmentInner	withNetworkingConfiguration(AseV3NetworkingConfigurationInner networkingConfiguration) Set the networkingConfiguration property: Full view of networking configuration for an ASE.
AppServiceEnvironmentInner	withUpgradePreference(UpgradePreference upgradePreference) Set the upgradePreference property: Upgrade Preference.
AppServiceEnvironmentInner	withUserWhitelistedIpRanges(List<String> userWhitelistedIpRanges) Set the userWhitelistedIpRanges property: User added ip ranges to whitelist on ASE db.
AppServiceEnvironmentInner	withVirtualNetwork(VirtualNetworkProfile virtualNetwork) Set the virtualNetwork property: Description of the Virtual Network.
AppServiceEnvironmentInner	withZoneRedundant(Boolean zoneRedundant) Set the zoneRedundant property: Whether or not this App Service Environment is zone-redundant.
Boolean	zoneRedundant() Get the zoneRedundant property: Whether or not this App Service Environment is zone-redundant.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AppServiceEnvironmentInner

public AppServiceEnvironmentInner()

Creates an instance of AppServiceEnvironmentInner class.

Method Details

clusterSettings

public List clusterSettings()

Get the clusterSettings property: Custom settings for changing the behavior of the App Service Environment.

Returns:

the clusterSettings value.

customDnsSuffixConfiguration

public CustomDnsSuffixConfigurationInner customDnsSuffixConfiguration()

Get the customDnsSuffixConfiguration property: Full view of the custom domain suffix configuration for ASEv3.

Returns:

the customDnsSuffixConfiguration value.

dedicatedHostCount

public Integer dedicatedHostCount()

Get the dedicatedHostCount property: Dedicated Host Count.

Returns:

the dedicatedHostCount value.

dnsSuffix

public String dnsSuffix()

Get the dnsSuffix property: DNS suffix of the App Service Environment.

Returns:

the dnsSuffix value.

fromJson

public static AppServiceEnvironmentInner fromJson(JsonReader jsonReader)

Reads an instance of AppServiceEnvironmentInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AppServiceEnvironmentInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

frontEndScaleFactor

public Integer frontEndScaleFactor()

Get the frontEndScaleFactor property: Scale factor for front-ends.

Returns:

the frontEndScaleFactor value.

hasLinuxWorkers

public Boolean hasLinuxWorkers()

Get the hasLinuxWorkers property: Flag that displays whether an ASE has linux workers or not.

Returns:

the hasLinuxWorkers value.

internalLoadBalancingMode

public LoadBalancingMode internalLoadBalancingMode()

Get the internalLoadBalancingMode property: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

Returns:

the internalLoadBalancingMode value.

ipsslAddressCount

public Integer ipsslAddressCount()

Get the ipsslAddressCount property: Number of IP SSL addresses reserved for the App Service Environment.

Returns:

the ipsslAddressCount value.

maximumNumberOfMachines

public Integer maximumNumberOfMachines()

Get the maximumNumberOfMachines property: Maximum number of VMs in the App Service Environment.

Returns:

the maximumNumberOfMachines value.

multiRoleCount

public Integer multiRoleCount()

Get the multiRoleCount property: Number of front-end instances.

Returns:

the multiRoleCount value.

multiSize

public String multiSize()

Get the multiSize property: Front-end VM size, e.g. "Medium", "Large".

Returns:

the multiSize value.

networkingConfiguration

public AseV3NetworkingConfigurationInner networkingConfiguration()

Get the networkingConfiguration property: Full view of networking configuration for an ASE.

Returns:

the networkingConfiguration value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the App Service Environment.

Returns:

the provisioningState value.

status

public HostingEnvironmentStatus status()

Get the status property: Current status of the App Service Environment.

Returns:

the status value.

suspended

public Boolean suspended()

Get the suspended property: 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).

Returns:

the suspended value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

upgradeAvailability

public UpgradeAvailability upgradeAvailability()

Get the upgradeAvailability property: Whether an upgrade is available for this App Service Environment.

Returns:

the upgradeAvailability value.

upgradePreference

public UpgradePreference upgradePreference()

Get the upgradePreference property: Upgrade Preference.

Returns:

the upgradePreference value.

userWhitelistedIpRanges

public List userWhitelistedIpRanges()

Get the userWhitelistedIpRanges property: User added ip ranges to whitelist on ASE db.

Returns:

the userWhitelistedIpRanges value.

validate

public void validate()

Validates the instance.

virtualNetwork

public VirtualNetworkProfile virtualNetwork()

Get the virtualNetwork property: Description of the Virtual Network.

Returns:

the virtualNetwork value.

withClusterSettings

public AppServiceEnvironmentInner withClusterSettings(List clusterSettings)

Set the clusterSettings property: Custom settings for changing the behavior of the App Service Environment.

Parameters:

clusterSettings - the clusterSettings value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withCustomDnsSuffixConfiguration

public AppServiceEnvironmentInner withCustomDnsSuffixConfiguration(CustomDnsSuffixConfigurationInner customDnsSuffixConfiguration)

Set the customDnsSuffixConfiguration property: Full view of the custom domain suffix configuration for ASEv3.

Parameters:

customDnsSuffixConfiguration - the customDnsSuffixConfiguration value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withDedicatedHostCount

public AppServiceEnvironmentInner withDedicatedHostCount(Integer dedicatedHostCount)

Set the dedicatedHostCount property: Dedicated Host Count.

Parameters:

dedicatedHostCount - the dedicatedHostCount value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withDnsSuffix

public AppServiceEnvironmentInner withDnsSuffix(String dnsSuffix)

Set the dnsSuffix property: DNS suffix of the App Service Environment.

Parameters:

dnsSuffix - the dnsSuffix value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withFrontEndScaleFactor

public AppServiceEnvironmentInner withFrontEndScaleFactor(Integer frontEndScaleFactor)

Set the frontEndScaleFactor property: Scale factor for front-ends.

Parameters:

frontEndScaleFactor - the frontEndScaleFactor value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withInternalLoadBalancingMode

public AppServiceEnvironmentInner withInternalLoadBalancingMode(LoadBalancingMode internalLoadBalancingMode)

Set the internalLoadBalancingMode property: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

Parameters:

internalLoadBalancingMode - the internalLoadBalancingMode value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withIpsslAddressCount

public AppServiceEnvironmentInner withIpsslAddressCount(Integer ipsslAddressCount)

Set the ipsslAddressCount property: Number of IP SSL addresses reserved for the App Service Environment.

Parameters:

ipsslAddressCount - the ipsslAddressCount value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withMultiSize

public AppServiceEnvironmentInner withMultiSize(String multiSize)

Set the multiSize property: Front-end VM size, e.g. "Medium", "Large".

Parameters:

multiSize - the multiSize value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withNetworkingConfiguration

public AppServiceEnvironmentInner withNetworkingConfiguration(AseV3NetworkingConfigurationInner networkingConfiguration)

Set the networkingConfiguration property: Full view of networking configuration for an ASE.

Parameters:

networkingConfiguration - the networkingConfiguration value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withUpgradePreference

public AppServiceEnvironmentInner withUpgradePreference(UpgradePreference upgradePreference)

Set the upgradePreference property: Upgrade Preference.

Parameters:

upgradePreference - the upgradePreference value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withUserWhitelistedIpRanges

public AppServiceEnvironmentInner withUserWhitelistedIpRanges(List userWhitelistedIpRanges)

Set the userWhitelistedIpRanges property: User added ip ranges to whitelist on ASE db.

Parameters:

userWhitelistedIpRanges - the userWhitelistedIpRanges value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withVirtualNetwork

public AppServiceEnvironmentInner withVirtualNetwork(VirtualNetworkProfile virtualNetwork)

Set the virtualNetwork property: Description of the Virtual Network.

Parameters:

virtualNetwork - the virtualNetwork value to set.

Returns:

the AppServiceEnvironmentInner object itself.

withZoneRedundant

public AppServiceEnvironmentInner withZoneRedundant(Boolean zoneRedundant)

Set the zoneRedundant property: Whether or not this App Service Environment is zone-redundant.

Parameters:

zoneRedundant - the zoneRedundant value to set.

Returns:

the AppServiceEnvironmentInner object itself.

zoneRedundant

public Boolean zoneRedundant()

Get the zoneRedundant property: Whether or not this App Service Environment is zone-redundant.

Returns:

the zoneRedundant value.