AppServicePlanInner Class

Package:

com.azure.resourcemanager.appservice.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.45.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.appservice.fluent.models.AppServicePlanInner

public final class AppServicePlanInner
extends Resource

App Service plan.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Boolean	elasticScaleEnabled() Get the elasticScaleEnabled property: ServerFarm supports ElasticScale.
ExtendedLocation	extendedLocation() Get the extendedLocation property: Extended Location.
OffsetDateTime	freeOfferExpirationTime() Get the freeOfferExpirationTime property: The time when the server farm free offer expires.
static AppServicePlanInner	fromJson(JsonReader jsonReader) Reads an instance of AppServicePlanInner from the JsonReader.
String	geoRegion() Get the geoRegion property: Geographical location for the App Service plan.
HostingEnvironmentProfile	hostingEnvironmentProfile() Get the hostingEnvironmentProfile property: Specification for the App Service Environment to use for the App Service plan.
Boolean	hyperV() Get the hyperV property: If Hyper-V container app service plan true, false otherwise.
String	id() Get the id property: Fully qualified resource Id for the resource.
Boolean	isSpot() Get the isSpot property: If true, this App Service Plan owns spot instances.
Boolean	isXenon() Get the isXenon property: Obsolete: If Hyper-V container app service plan true, false otherwise.
String	kind() Get the kind property: Kind of resource.
KubeEnvironmentProfile	kubeEnvironmentProfile() Get the kubeEnvironmentProfile property: Specification for the Kubernetes Environment to use for the App Service plan.
Integer	maximumElasticWorkerCount() Get the maximumElasticWorkerCount property: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
Integer	maximumNumberOfWorkers() Get the maximumNumberOfWorkers property: Maximum number of instances that can be assigned to this App Service plan.
String	name() Get the name property: The name of the resource.
Integer	numberOfSites() Get the numberOfSites property: Number of apps assigned to this App Service plan.
Integer	numberOfWorkers() Get the numberOfWorkers property: The number of instances that are assigned to this App Service plan.
Boolean	perSiteScaling() Get the perSiteScaling property: If true, apps assigned to this App Service plan can be scaled independently.
ProvisioningState	provisioningState() Get the provisioningState property: Provisioning state of the App Service Plan.
Boolean	reserved() Get the reserved property: If Linux app service plan true, false otherwise.
String	resourceGroup() Get the resourceGroup property: Resource group of the App Service plan.
SkuDescription	sku() Get the sku property: Description of a SKU for a scalable resource.
OffsetDateTime	spotExpirationTime() Get the spotExpirationTime property: The time when the server farm expires.
StatusOptions	status() Get the status property: App Service plan status.
String	subscription() Get the subscription property: App Service plan subscription.
Integer	targetWorkerCount() Get the targetWorkerCount property: Scaling worker count.
Integer	targetWorkerSizeId() Get the targetWorkerSizeId property: Scaling worker size ID.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
AppServicePlanInner	withElasticScaleEnabled(Boolean elasticScaleEnabled) Set the elasticScaleEnabled property: ServerFarm supports ElasticScale.
AppServicePlanInner	withExtendedLocation(ExtendedLocation extendedLocation) Set the extendedLocation property: Extended Location.
AppServicePlanInner	withFreeOfferExpirationTime(OffsetDateTime freeOfferExpirationTime) Set the freeOfferExpirationTime property: The time when the server farm free offer expires.
AppServicePlanInner	withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile) Set the hostingEnvironmentProfile property: Specification for the App Service Environment to use for the App Service plan.
AppServicePlanInner	withHyperV(Boolean hyperV) Set the hyperV property: If Hyper-V container app service plan true, false otherwise.
AppServicePlanInner	withIsSpot(Boolean isSpot) Set the isSpot property: If true, this App Service Plan owns spot instances.
AppServicePlanInner	withIsXenon(Boolean isXenon) Set the isXenon property: Obsolete: If Hyper-V container app service plan true, false otherwise.
AppServicePlanInner	withKind(String kind) Set the kind property: Kind of resource.
AppServicePlanInner	withKubeEnvironmentProfile(KubeEnvironmentProfile kubeEnvironmentProfile) Set the kubeEnvironmentProfile property: Specification for the Kubernetes Environment to use for the App Service plan.
AppServicePlanInner	withLocation(String location)
AppServicePlanInner	withMaximumElasticWorkerCount(Integer maximumElasticWorkerCount) Set the maximumElasticWorkerCount property: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
AppServicePlanInner	withPerSiteScaling(Boolean perSiteScaling) Set the perSiteScaling property: If true, apps assigned to this App Service plan can be scaled independently.
AppServicePlanInner	withReserved(Boolean reserved) Set the reserved property: If Linux app service plan true, false otherwise.
AppServicePlanInner	withSku(SkuDescription sku) Set the sku property: Description of a SKU for a scalable resource.
AppServicePlanInner	withSpotExpirationTime(OffsetDateTime spotExpirationTime) Set the spotExpirationTime property: The time when the server farm expires.
AppServicePlanInner	withTags(Map<String,String> tags)
AppServicePlanInner	withTargetWorkerCount(Integer targetWorkerCount) Set the targetWorkerCount property: Scaling worker count.
AppServicePlanInner	withTargetWorkerSizeId(Integer targetWorkerSizeId) Set the targetWorkerSizeId property: Scaling worker size ID.
AppServicePlanInner	withWorkerTierName(String workerTierName) Set the workerTierName property: Target worker tier assigned to the App Service plan.
AppServicePlanInner	withZoneRedundant(Boolean zoneRedundant) Set the zoneRedundant property: If true, this App Service Plan will perform availability zone balancing.
String	workerTierName() Get the workerTierName property: Target worker tier assigned to the App Service plan.
Boolean	zoneRedundant() Get the zoneRedundant property: If true, this App Service Plan will perform availability zone balancing.

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

AppServicePlanInner

public AppServicePlanInner()

Creates an instance of AppServicePlanInner class.

Method Details

elasticScaleEnabled

public Boolean elasticScaleEnabled()

Get the elasticScaleEnabled property: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku.

Returns:

the elasticScaleEnabled value.

extendedLocation

public ExtendedLocation extendedLocation()

Get the extendedLocation property: Extended Location.

Returns:

the extendedLocation value.

freeOfferExpirationTime

public OffsetDateTime freeOfferExpirationTime()

Get the freeOfferExpirationTime property: The time when the server farm free offer expires.

Returns:

the freeOfferExpirationTime value.

fromJson

public static AppServicePlanInner fromJson(JsonReader jsonReader)

Reads an instance of AppServicePlanInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

geoRegion

public String geoRegion()

Get the geoRegion property: Geographical location for the App Service plan.

Returns:

the geoRegion value.

hostingEnvironmentProfile

public HostingEnvironmentProfile hostingEnvironmentProfile()

Get the hostingEnvironmentProfile property: Specification for the App Service Environment to use for the App Service plan.

Returns:

the hostingEnvironmentProfile value.

hyperV

public Boolean hyperV()

Get the hyperV property: If Hyper-V container app service plan true, false otherwise.

Returns:

the hyperV value.

id

public String id()

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

Overrides:

AppServicePlanInner.id()

Returns:

the id value.

isSpot

public Boolean isSpot()

Get the isSpot property: If true, this App Service Plan owns spot instances.

Returns:

the isSpot value.

isXenon

public Boolean isXenon()

Get the isXenon property: Obsolete: If Hyper-V container app service plan true, false otherwise.

Returns:

the isXenon value.

kind

public String kind()

Get the kind property: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things\_You\_Should\_Know/kind\_property.md\#app-service-resource-kind-reference for details supported values for kind.

Returns:

the kind value.

kubeEnvironmentProfile

public KubeEnvironmentProfile kubeEnvironmentProfile()

Get the kubeEnvironmentProfile property: Specification for the Kubernetes Environment to use for the App Service plan.

Returns:

the kubeEnvironmentProfile value.

maximumElasticWorkerCount

public Integer maximumElasticWorkerCount()

Get the maximumElasticWorkerCount property: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

Returns:

the maximumElasticWorkerCount value.

maximumNumberOfWorkers

public Integer maximumNumberOfWorkers()

Get the maximumNumberOfWorkers property: Maximum number of instances that can be assigned to this App Service plan.

Returns:

the maximumNumberOfWorkers value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

AppServicePlanInner.name()

Returns:

the name value.

numberOfSites

public Integer numberOfSites()

Get the numberOfSites property: Number of apps assigned to this App Service plan.

Returns:

the numberOfSites value.

numberOfWorkers

public Integer numberOfWorkers()

Get the numberOfWorkers property: The number of instances that are assigned to this App Service plan.

Returns:

the numberOfWorkers value.

perSiteScaling

public Boolean perSiteScaling()

Get the perSiteScaling property: If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.

Returns:

the perSiteScaling value.

provisioningState

public ProvisioningState provisioningState()

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

Returns:

the provisioningState value.

reserved

public Boolean reserved()

Get the reserved property: If Linux app service plan true, false otherwise.

Returns:

the reserved value.

resourceGroup

public String resourceGroup()

Get the resourceGroup property: Resource group of the App Service plan.

Returns:

the resourceGroup value.

sku

public SkuDescription sku()

Get the sku property: Description of a SKU for a scalable resource.

Returns:

the sku value.

spotExpirationTime

public OffsetDateTime spotExpirationTime()

Get the spotExpirationTime property: The time when the server farm expires. Valid only if it is a spot server farm.

Returns:

the spotExpirationTime value.

status

public StatusOptions status()

Get the status property: App Service plan status.

Returns:

the status value.

subscription

public String subscription()

Get the subscription property: App Service plan subscription.

Returns:

the subscription value.

targetWorkerCount

public Integer targetWorkerCount()

Get the targetWorkerCount property: Scaling worker count.

Returns:

the targetWorkerCount value.

targetWorkerSizeId

public Integer targetWorkerSizeId()

Get the targetWorkerSizeId property: Scaling worker size ID.

Returns:

the targetWorkerSizeId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AppServicePlanInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

AppServicePlanInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withElasticScaleEnabled

public AppServicePlanInner withElasticScaleEnabled(Boolean elasticScaleEnabled)

Set the elasticScaleEnabled property: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku.

Parameters:

elasticScaleEnabled - the elasticScaleEnabled value to set.

Returns:

the AppServicePlanInner object itself.

withExtendedLocation

public AppServicePlanInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: Extended Location.

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the AppServicePlanInner object itself.

withFreeOfferExpirationTime

public AppServicePlanInner withFreeOfferExpirationTime(OffsetDateTime freeOfferExpirationTime)

Set the freeOfferExpirationTime property: The time when the server farm free offer expires.

Parameters:

freeOfferExpirationTime - the freeOfferExpirationTime value to set.

Returns:

the AppServicePlanInner object itself.

withHostingEnvironmentProfile

public AppServicePlanInner withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile)

Set the hostingEnvironmentProfile property: Specification for the App Service Environment to use for the App Service plan.

Parameters:

hostingEnvironmentProfile - the hostingEnvironmentProfile value to set.

Returns:

the AppServicePlanInner object itself.

withHyperV

public AppServicePlanInner withHyperV(Boolean hyperV)

Set the hyperV property: If Hyper-V container app service plan true, false otherwise.

Parameters:

hyperV - the hyperV value to set.

Returns:

the AppServicePlanInner object itself.

withIsSpot

public AppServicePlanInner withIsSpot(Boolean isSpot)

Set the isSpot property: If true, this App Service Plan owns spot instances.

Parameters:

isSpot - the isSpot value to set.

Returns:

the AppServicePlanInner object itself.

withIsXenon

public AppServicePlanInner withIsXenon(Boolean isXenon)

Set the isXenon property: Obsolete: If Hyper-V container app service plan true, false otherwise.

Parameters:

isXenon - the isXenon value to set.

Returns:

the AppServicePlanInner object itself.

withKind

public AppServicePlanInner withKind(String kind)

Set the kind property: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things\_You\_Should\_Know/kind\_property.md\#app-service-resource-kind-reference for details supported values for kind.

Parameters:

kind - the kind value to set.

Returns:

the AppServicePlanInner object itself.

withKubeEnvironmentProfile

public AppServicePlanInner withKubeEnvironmentProfile(KubeEnvironmentProfile kubeEnvironmentProfile)

Set the kubeEnvironmentProfile property: Specification for the Kubernetes Environment to use for the App Service plan.

Parameters:

kubeEnvironmentProfile - the kubeEnvironmentProfile value to set.

Returns:

the AppServicePlanInner object itself.

withLocation

public AppServicePlanInner withLocation(String location)

Overrides:

AppServicePlanInner.withLocation(String location)

Parameters:

location

withMaximumElasticWorkerCount

public AppServicePlanInner withMaximumElasticWorkerCount(Integer maximumElasticWorkerCount)

Set the maximumElasticWorkerCount property: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

Parameters:

maximumElasticWorkerCount - the maximumElasticWorkerCount value to set.

Returns:

the AppServicePlanInner object itself.

withPerSiteScaling

public AppServicePlanInner withPerSiteScaling(Boolean perSiteScaling)

Set the perSiteScaling property: If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.

Parameters:

perSiteScaling - the perSiteScaling value to set.

Returns:

the AppServicePlanInner object itself.

withReserved

public AppServicePlanInner withReserved(Boolean reserved)

Set the reserved property: If Linux app service plan true, false otherwise.

Parameters:

reserved - the reserved value to set.

Returns:

the AppServicePlanInner object itself.

withSku

public AppServicePlanInner withSku(SkuDescription sku)

Set the sku property: Description of a SKU for a scalable resource.

Parameters:

sku - the sku value to set.

Returns:

the AppServicePlanInner object itself.

withSpotExpirationTime

public AppServicePlanInner withSpotExpirationTime(OffsetDateTime spotExpirationTime)

Set the spotExpirationTime property: The time when the server farm expires. Valid only if it is a spot server farm.

Parameters:

spotExpirationTime - the spotExpirationTime value to set.

Returns:

the AppServicePlanInner object itself.

withTags

public AppServicePlanInner withTags(Map tags)

Overrides:

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

Parameters:

tags

withTargetWorkerCount

public AppServicePlanInner withTargetWorkerCount(Integer targetWorkerCount)

Set the targetWorkerCount property: Scaling worker count.

Parameters:

targetWorkerCount - the targetWorkerCount value to set.

Returns:

the AppServicePlanInner object itself.

withTargetWorkerSizeId

public AppServicePlanInner withTargetWorkerSizeId(Integer targetWorkerSizeId)

Set the targetWorkerSizeId property: Scaling worker size ID.

Parameters:

targetWorkerSizeId - the targetWorkerSizeId value to set.

Returns:

the AppServicePlanInner object itself.

withWorkerTierName

public AppServicePlanInner withWorkerTierName(String workerTierName)

Set the workerTierName property: Target worker tier assigned to the App Service plan.

Parameters:

workerTierName - the workerTierName value to set.

Returns:

the AppServicePlanInner object itself.

withZoneRedundant

public AppServicePlanInner withZoneRedundant(Boolean zoneRedundant)

Set the zoneRedundant property: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

Parameters:

zoneRedundant - the zoneRedundant value to set.

Returns:

the AppServicePlanInner object itself.

workerTierName

public String workerTierName()

Get the workerTierName property: Target worker tier assigned to the App Service plan.

Returns:

the workerTierName value.

zoneRedundant

public Boolean zoneRedundant()

Get the zoneRedundant property: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

Returns:

the zoneRedundant value.