AppServicePlanProperties (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.appservice.fluent.models.AppServicePlanProperties

public final class AppServicePlanProperties
extends Object

AppServicePlan resource specific properties.

Constructor Summary

Constructors
Constructor and Description

AppServicePlanProperties()

Constructors
Constructor and Description
`AppServicePlanProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`elasticScaleEnabled()` Get the elasticScaleEnabled property: ServerFarm supports ElasticScale.
`OffsetDateTime`	`freeOfferExpirationTime()` Get the freeOfferExpirationTime property: The time when the server farm free offer expires.
`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 <code>true</code>, <code>false</code> otherwise.
`Boolean`	`isSpot()` Get the isSpot property: If <code>true</code>, this App Service Plan owns spot instances.
`Boolean`	`isXenon()` Get the isXenon property: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
`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.
`Integer`	`numberOfSites()` Get the numberOfSites property: Number of apps assigned to this App Service plan.
`Boolean`	`perSiteScaling()` Get the perSiteScaling property: If <code>true</code>, 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 <code>true</code>, <code>false</code> otherwise.
`String`	`resourceGroup()` Get the resourceGroup property: Resource group of the App Service plan.
`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.
`void`	`validate()` Validates the instance.
`AppServicePlanProperties`	`withElasticScaleEnabled(Boolean elasticScaleEnabled)` Set the elasticScaleEnabled property: ServerFarm supports ElasticScale.
`AppServicePlanProperties`	`withFreeOfferExpirationTime(OffsetDateTime freeOfferExpirationTime)` Set the freeOfferExpirationTime property: The time when the server farm free offer expires.
`AppServicePlanProperties`	`withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile)` Set the hostingEnvironmentProfile property: Specification for the App Service Environment to use for the App Service plan.
`AppServicePlanProperties`	`withHyperV(Boolean hyperV)` Set the hyperV property: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
`AppServicePlanProperties`	`withIsSpot(Boolean isSpot)` Set the isSpot property: If <code>true</code>, this App Service Plan owns spot instances.
`AppServicePlanProperties`	`withIsXenon(Boolean isXenon)` Set the isXenon property: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
`AppServicePlanProperties`	`withKubeEnvironmentProfile(KubeEnvironmentProfile kubeEnvironmentProfile)` Set the kubeEnvironmentProfile property: Specification for the Kubernetes Environment to use for the App Service plan.
`AppServicePlanProperties`	`withMaximumElasticWorkerCount(Integer maximumElasticWorkerCount)` Set the maximumElasticWorkerCount property: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
`AppServicePlanProperties`	`withPerSiteScaling(Boolean perSiteScaling)` Set the perSiteScaling property: If <code>true</code>, apps assigned to this App Service plan can be scaled independently.
`AppServicePlanProperties`	`withReserved(Boolean reserved)` Set the reserved property: If Linux app service plan <code>true</code>, <code>false</code> otherwise.
`AppServicePlanProperties`	`withSpotExpirationTime(OffsetDateTime spotExpirationTime)` Set the spotExpirationTime property: The time when the server farm expires.
`AppServicePlanProperties`	`withTargetWorkerCount(Integer targetWorkerCount)` Set the targetWorkerCount property: Scaling worker count.
`AppServicePlanProperties`	`withTargetWorkerSizeId(Integer targetWorkerSizeId)` Set the targetWorkerSizeId property: Scaling worker size ID.
`AppServicePlanProperties`	`withWorkerTierName(String workerTierName)` Set the workerTierName property: Target worker tier assigned to the App Service plan.
`AppServicePlanProperties`	`withZoneRedundant(Boolean zoneRedundant)` Set the zoneRedundant property: If <code>true</code>, 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 <code>true</code>, this App Service Plan will perform availability zone balancing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AppServicePlanProperties
```
public AppServicePlanProperties()
```
- Method Detail
  - workerTierName
```
public String workerTierName()
```
    Get the workerTierName property: Target worker tier assigned to the App Service plan.
    
    Returns:
    
    the workerTierName value.
  - withWorkerTierName
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - 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.
  - 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.
  - withHostingEnvironmentProfile
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - 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.
  - geoRegion
```
public String geoRegion()
```
    Get the geoRegion property: Geographical location for the App Service plan.
    
    Returns:
    
    the geoRegion value.
  - perSiteScaling
```
public Boolean perSiteScaling()
```
    Get the perSiteScaling property: If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.
    
    Returns:
    
    the perSiteScaling value.
  - withPerSiteScaling
```
public AppServicePlanProperties withPerSiteScaling(Boolean perSiteScaling)
```
    Set the perSiteScaling property: If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.
    
    Parameters:
    
    perSiteScaling - the perSiteScaling value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - 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.
  - withElasticScaleEnabled
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - maximumElasticWorkerCount
```
public Integer maximumElasticWorkerCount()
```
    Get the maximumElasticWorkerCount property: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
    
    Returns:
    
    the maximumElasticWorkerCount value.
  - withMaximumElasticWorkerCount
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - numberOfSites
```
public Integer numberOfSites()
```
    Get the numberOfSites property: Number of apps assigned to this App Service plan.
    
    Returns:
    
    the numberOfSites value.
  - isSpot
```
public Boolean isSpot()
```
    Get the isSpot property: If <code>true</code>, this App Service Plan owns spot instances.
    
    Returns:
    
    the isSpot value.
  - withIsSpot
```
public AppServicePlanProperties withIsSpot(Boolean isSpot)
```
    Set the isSpot property: If <code>true</code>, this App Service Plan owns spot instances.
    
    Parameters:
    
    isSpot - the isSpot value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - 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.
  - withSpotExpirationTime
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - freeOfferExpirationTime
```
public OffsetDateTime freeOfferExpirationTime()
```
    Get the freeOfferExpirationTime property: The time when the server farm free offer expires.
    
    Returns:
    
    the freeOfferExpirationTime value.
  - withFreeOfferExpirationTime
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - resourceGroup
```
public String resourceGroup()
```
    Get the resourceGroup property: Resource group of the App Service plan.
    
    Returns:
    
    the resourceGroup value.
  - reserved
```
public Boolean reserved()
```
    Get the reserved property: If Linux app service plan <code>true</code>, <code>false</code> otherwise.
    
    Returns:
    
    the reserved value.
  - withReserved
```
public AppServicePlanProperties withReserved(Boolean reserved)
```
    Set the reserved property: If Linux app service plan <code>true</code>, <code>false</code> otherwise.
    
    Parameters:
    
    reserved - the reserved value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - isXenon
```
public Boolean isXenon()
```
    Get the isXenon property: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
    
    Returns:
    
    the isXenon value.
  - withIsXenon
```
public AppServicePlanProperties withIsXenon(Boolean isXenon)
```
    Set the isXenon property: Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
    
    Parameters:
    
    isXenon - the isXenon value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - hyperV
```
public Boolean hyperV()
```
    Get the hyperV property: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
    
    Returns:
    
    the hyperV value.
  - withHyperV
```
public AppServicePlanProperties withHyperV(Boolean hyperV)
```
    Set the hyperV property: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
    
    Parameters:
    
    hyperV - the hyperV value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - targetWorkerCount
```
public Integer targetWorkerCount()
```
    Get the targetWorkerCount property: Scaling worker count.
    
    Returns:
    
    the targetWorkerCount value.
  - withTargetWorkerCount
```
public AppServicePlanProperties withTargetWorkerCount(Integer targetWorkerCount)
```
    Set the targetWorkerCount property: Scaling worker count.
    
    Parameters:
    
    targetWorkerCount - the targetWorkerCount value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - targetWorkerSizeId
```
public Integer targetWorkerSizeId()
```
    Get the targetWorkerSizeId property: Scaling worker size ID.
    
    Returns:
    
    the targetWorkerSizeId value.
  - withTargetWorkerSizeId
```
public AppServicePlanProperties withTargetWorkerSizeId(Integer targetWorkerSizeId)
```
    Set the targetWorkerSizeId property: Scaling worker size ID.
    
    Parameters:
    
    targetWorkerSizeId - the targetWorkerSizeId value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - provisioningState
```
public ProvisioningState provisioningState()
```
    Get the provisioningState property: Provisioning state of the App Service Plan.
    
    Returns:
    
    the provisioningState 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.
  - withKubeEnvironmentProfile
```
public AppServicePlanProperties 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 AppServicePlanProperties object itself.
  - zoneRedundant
```
public Boolean zoneRedundant()
```
    Get the zoneRedundant property: If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing.
    
    Returns:
    
    the zoneRedundant value.
  - withZoneRedundant
```
public AppServicePlanProperties withZoneRedundant(Boolean zoneRedundant)
```
    Set the zoneRedundant property: If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing.
    
    Parameters:
    
    zoneRedundant - the zoneRedundant value to set.
    
    Returns:
    
    the AppServicePlanProperties object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class AppServicePlanProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AppServicePlanProperties

Method Detail

workerTierName

withWorkerTierName

status

subscription

hostingEnvironmentProfile

withHostingEnvironmentProfile

maximumNumberOfWorkers

geoRegion

perSiteScaling

withPerSiteScaling

elasticScaleEnabled

withElasticScaleEnabled

maximumElasticWorkerCount

withMaximumElasticWorkerCount

numberOfSites

isSpot

withIsSpot

spotExpirationTime

withSpotExpirationTime

freeOfferExpirationTime

withFreeOfferExpirationTime

resourceGroup

reserved

withReserved

isXenon

withIsXenon

hyperV

withHyperV

targetWorkerCount

withTargetWorkerCount

targetWorkerSizeId

withTargetWorkerSizeId

provisioningState

kubeEnvironmentProfile

withKubeEnvironmentProfile

zoneRedundant

withZoneRedundant

validate