Class AppServicePlanProperties

java.lang.Object
com.azure.resourcemanager.appservice.fluent.models.AppServicePlanProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<AppServicePlanProperties>
public final class AppServicePlanProperties extends Object implements com.azure.json.JsonSerializable<AppServicePlanProperties>
AppServicePlan resource specific properties.

  • Constructor Details

    • AppServicePlanProperties

      public AppServicePlanProperties()
      Creates an instance of AppServicePlanProperties class.

  • Method Details

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

    • numberOfWorkers

      public Integer numberOfWorkers()
      Get the numberOfWorkers property: The number of instances that are assigned to this App Service plan.
      Returns:
      the numberOfWorkers 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.

    • asyncScalingEnabled

      public Boolean asyncScalingEnabled()
      Get the asyncScalingEnabled property: If <code>true</code>, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If <code>false</code>, this App Service Plan will only attempt sync scaling.
      Returns:
      the asyncScalingEnabled value.

    • withAsyncScalingEnabled

      public AppServicePlanProperties withAsyncScalingEnabled(Boolean asyncScalingEnabled)
      Set the asyncScalingEnabled property: If <code>true</code>, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If <code>false</code>, this App Service Plan will only attempt sync scaling.
      Parameters:
      asyncScalingEnabled - the asyncScalingEnabled value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • planDefaultIdentity

      public DefaultIdentity planDefaultIdentity()
      Get the planDefaultIdentity property: Identity to use by platform for various features and integrations using managed identity.
      Returns:
      the planDefaultIdentity value.

    • withPlanDefaultIdentity

      public AppServicePlanProperties withPlanDefaultIdentity(DefaultIdentity planDefaultIdentity)
      Set the planDefaultIdentity property: Identity to use by platform for various features and integrations using managed identity.
      Parameters:
      planDefaultIdentity - the planDefaultIdentity value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • isCustomMode

      public Boolean isCustomMode()
      Get the isCustomMode property: Whether this server farm is in custom mode.
      Returns:
      the isCustomMode value.

    • withIsCustomMode

      public AppServicePlanProperties withIsCustomMode(Boolean isCustomMode)
      Set the isCustomMode property: Whether this server farm is in custom mode.
      Parameters:
      isCustomMode - the isCustomMode value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • registryAdapters

      public List<RegistryAdapter> registryAdapters()
      Get the registryAdapters property: Registry adapters associated with this App Service plan.
      Returns:
      the registryAdapters value.

    • withRegistryAdapters

      public AppServicePlanProperties withRegistryAdapters(List<RegistryAdapter> registryAdapters)
      Set the registryAdapters property: Registry adapters associated with this App Service plan.
      Parameters:
      registryAdapters - the registryAdapters value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • installScripts

      public List<InstallScript> installScripts()
      Get the installScripts property: Install scripts associated with this App Service plan.
      Returns:
      the installScripts value.

    • withInstallScripts

      public AppServicePlanProperties withInstallScripts(List<InstallScript> installScripts)
      Set the installScripts property: Install scripts associated with this App Service plan.
      Parameters:
      installScripts - the installScripts value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • network

      public ServerFarmNetworkSettings network()
      Get the network property: All network settings for the server farm.
      Returns:
      the network value.

    • withNetwork

      public AppServicePlanProperties withNetwork(ServerFarmNetworkSettings network)
      Set the network property: All network settings for the server farm.
      Parameters:
      network - the network value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • storageMounts

      public List<StorageMount> storageMounts()
      Get the storageMounts property: Storage mounts associated with this App Service plan.
      Returns:
      the storageMounts value.

    • withStorageMounts

      public AppServicePlanProperties withStorageMounts(List<StorageMount> storageMounts)
      Set the storageMounts property: Storage mounts associated with this App Service plan.
      Parameters:
      storageMounts - the storageMounts value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • rdpEnabled

      public Boolean rdpEnabled()
      Get the rdpEnabled property: If <code>true</code>, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If <code>false</code>, RDP access is disabled.
      Returns:
      the rdpEnabled value.

    • withRdpEnabled

      public AppServicePlanProperties withRdpEnabled(Boolean rdpEnabled)
      Set the rdpEnabled property: If <code>true</code>, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If <code>false</code>, RDP access is disabled.
      Parameters:
      rdpEnabled - the rdpEnabled value to set.
      Returns:
      the AppServicePlanProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AppServicePlanProperties>
      Throws:
      IOException

    • fromJson

      public static AppServicePlanProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AppServicePlanProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AppServicePlanProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the AppServicePlanProperties.