Share via

AppServiceEnvironmentResourceInner Class

  • Reference
Package:
com.azure.resourcemanager.appservice.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appservice:2.44.0

public final class AppServiceEnvironmentResourceInner
extends Resource

App Service Environment ARM resource.

Constructor Summary

Constructor Description
AppServiceEnvironmentResourceInner()

Creates an instance of AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner fromJson(JsonReader jsonReader)

Reads an instance of AppServiceEnvironmentResourceInner 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.
String id()

Get the id property: Fully qualified resource Id for the resource.
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.
String kind()

Get the kind property: Kind of resource.
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.
String name()

Get the name property: The name of the resource.
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)
String type()

Get the type property: The type of the resource.
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.
AppServiceEnvironmentResourceInner withClusterSettings(List<NameValuePair> clusterSettings)

Set the clusterSettings property: Custom settings for changing the behavior of the App Service Environment.
AppServiceEnvironmentResourceInner withCustomDnsSuffixConfiguration(CustomDnsSuffixConfigurationInner customDnsSuffixConfiguration)

Set the customDnsSuffixConfiguration property: Full view of the custom domain suffix configuration for ASEv3.
AppServiceEnvironmentResourceInner withDedicatedHostCount(Integer dedicatedHostCount)

Set the dedicatedHostCount property: Dedicated Host Count.
AppServiceEnvironmentResourceInner withDnsSuffix(String dnsSuffix)

Set the dnsSuffix property: DNS suffix of the App Service Environment.
AppServiceEnvironmentResourceInner withFrontEndScaleFactor(Integer frontEndScaleFactor)

Set the frontEndScaleFactor property: Scale factor for front-ends.
AppServiceEnvironmentResourceInner withInternalLoadBalancingMode(LoadBalancingMode internalLoadBalancingMode)

Set the internalLoadBalancingMode property: Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
AppServiceEnvironmentResourceInner withIpsslAddressCount(Integer ipsslAddressCount)

Set the ipsslAddressCount property: Number of IP SSL addresses reserved for the App Service Environment.
AppServiceEnvironmentResourceInner withKind(String kind)

Set the kind property: Kind of resource.
AppServiceEnvironmentResourceInner withLocation(String location)
AppServiceEnvironmentResourceInner withMultiSize(String multiSize)

Set the multiSize property: Front-end VM size, e.g.
AppServiceEnvironmentResourceInner withNetworkingConfiguration(AseV3NetworkingConfigurationInner networkingConfiguration)

Set the networkingConfiguration property: Full view of networking configuration for an ASE.
AppServiceEnvironmentResourceInner withTags(Map<String,String> tags)
AppServiceEnvironmentResourceInner withUpgradePreference(UpgradePreference upgradePreference)

Set the upgradePreference property: Upgrade Preference.
AppServiceEnvironmentResourceInner withUserWhitelistedIpRanges(List<String> userWhitelistedIpRanges)

Set the userWhitelistedIpRanges property: User added ip ranges to whitelist on ASE db.
AppServiceEnvironmentResourceInner withVirtualNetwork(VirtualNetworkProfile virtualNetwork)

Set the virtualNetwork property: Description of the Virtual Network.
AppServiceEnvironmentResourceInner 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 ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AppServiceEnvironmentResourceInner

public AppServiceEnvironmentResourceInner()

Creates an instance of AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner fromJson(JsonReader jsonReader)

Reads an instance of AppServiceEnvironmentResourceInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AppServiceEnvironmentResourceInner 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.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

AppServiceEnvironmentResourceInner.id()

Returns:

the id 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.

kind

public String kind()

Get the kind property: Kind of resource.

Returns:

the kind 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.

name

public String name()

Get the name property: The name of the resource.

Overrides:

AppServiceEnvironmentResourceInner.name()

Returns:

the name 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)

Overrides:

AppServiceEnvironmentResourceInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

AppServiceEnvironmentResourceInner.type()

Returns:

the type value.

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 AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner object itself.

withCustomDnsSuffixConfiguration

public AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner object itself.

withDedicatedHostCount

public AppServiceEnvironmentResourceInner withDedicatedHostCount(Integer dedicatedHostCount)

Set the dedicatedHostCount property: Dedicated Host Count.

Parameters:

dedicatedHostCount - the dedicatedHostCount value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withDnsSuffix

public AppServiceEnvironmentResourceInner withDnsSuffix(String dnsSuffix)

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

Parameters:

dnsSuffix - the dnsSuffix value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withFrontEndScaleFactor

public AppServiceEnvironmentResourceInner withFrontEndScaleFactor(Integer frontEndScaleFactor)

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

Parameters:

frontEndScaleFactor - the frontEndScaleFactor value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withInternalLoadBalancingMode

public AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner object itself.

withIpsslAddressCount

public AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner object itself.

withKind

public AppServiceEnvironmentResourceInner withKind(String kind)

Set the kind property: Kind of resource.

Parameters:

kind - the kind value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withLocation

public AppServiceEnvironmentResourceInner withLocation(String location)

Overrides:

AppServiceEnvironmentResourceInner.withLocation(String location)

Parameters:

location

withMultiSize

public AppServiceEnvironmentResourceInner withMultiSize(String multiSize)

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

Parameters:

multiSize - the multiSize value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withNetworkingConfiguration

public AppServiceEnvironmentResourceInner withNetworkingConfiguration(AseV3NetworkingConfigurationInner networkingConfiguration)

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

Parameters:

networkingConfiguration - the networkingConfiguration value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withTags

public AppServiceEnvironmentResourceInner withTags(Map tags)

Overrides:

AppServiceEnvironmentResourceInner.withTags(Map<String,String> tags)

Parameters:

tags

withUpgradePreference

public AppServiceEnvironmentResourceInner withUpgradePreference(UpgradePreference upgradePreference)

Set the upgradePreference property: Upgrade Preference.

Parameters:

upgradePreference - the upgradePreference value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withUserWhitelistedIpRanges

public AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner object itself.

withVirtualNetwork

public AppServiceEnvironmentResourceInner withVirtualNetwork(VirtualNetworkProfile virtualNetwork)

Set the virtualNetwork property: Description of the Virtual Network.

Parameters:

virtualNetwork - the virtualNetwork value to set.

Returns:

the AppServiceEnvironmentResourceInner object itself.

withZoneRedundant

public AppServiceEnvironmentResourceInner 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 AppServiceEnvironmentResourceInner object itself.

zoneRedundant

public Boolean zoneRedundant()

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

Returns:

the zoneRedundant value.

Applies to