azure.mgmt.web.v2020_09_01.models.AppServicePlanPatchResource.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2020_09_01.models.AppServicePlanPatchResource
name: AppServicePlanPatchResource
fullName: azure.mgmt.web.v2020_09_01.models.AppServicePlanPatchResource
module: azure.mgmt.web.v2020_09_01.models
inheritances:
- azure.mgmt.web.v2020_09_01.models._models_py3.ProxyOnlyResource
summary: 'ARM resource for a app service plan.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'AppServicePlanPatchResource(*, kind: str | None = None, worker_tier_name:
    str | None = None, hosting_environment_profile: _models.HostingEnvironmentProfile
    | None = None, per_site_scaling: bool = False, maximum_elastic_worker_count: int
    | None = None, is_spot: bool | None = None, spot_expiration_time: datetime | None
    = None, free_offer_expiration_time: datetime | None = None, reserved: bool = False,
    is_xenon: bool = False, hyper_v: bool = False, target_worker_count: int | None
    = None, target_worker_size_id: int | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: kind
    description: Kind of resource.
    types:
    - <xref:str>
  - name: worker_tier_name
    description: Target worker tier assigned to the App Service plan.
    types:
    - <xref:str>
  - name: hosting_environment_profile
    description: 'Specification for the App Service Environment to use for

      the App Service plan.'
    types:
    - <xref:azure.mgmt.web.v2020_09_01.models.HostingEnvironmentProfile>
  - name: per_site_scaling
    description: '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.'
    types:
    - <xref:bool>
  - name: maximum_elastic_worker_count
    description: 'Maximum number of total workers allowed for this

      ElasticScaleEnabled App Service Plan.'
    types:
    - <xref:int>
  - name: is_spot
    description: If `<code>true</code>`, this App Service Plan owns spot instances.
    types:
    - <xref:bool>
  - name: spot_expiration_time
    description: 'The time when the server farm expires. Valid only if it is a

      spot server farm.'
    types:
    - <xref:datetime.datetime>
  - name: free_offer_expiration_time
    description: The time when the server farm free offer expires.
    types:
    - <xref:datetime.datetime>
  - name: reserved
    description: "This needs to set to `<code>true</code>`\_when creating a Linux\
      \ App\nService Plan, along with `<code>kind</code>` set to `<code>Linux</code>`.\
      \ It should\nbe `<code>false</code>` otherwise."
    types:
    - <xref:bool>
  - name: is_xenon
    description: 'Obsolete: If Hyper-V container app service plan `<code>true</code>`,

      `<code>false</code>` otherwise.'
    types:
    - <xref:bool>
  - name: hyper_v
    description: 'If Hyper-V container app service plan `<code>true</code>`,

      `<code>false</code>` otherwise.'
    types:
    - <xref:bool>
  - name: target_worker_count
    description: Scaling worker count.
    types:
    - <xref:int>
  - name: target_worker_size_id
    description: Scaling worker size ID.
    types:
    - <xref:int>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource Name.
  name: name
  types:
  - <xref:str>
- description: Kind of resource.
  name: kind
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: The system metadata relating to this resource.
  name: system_data
  types:
  - <xref:azure.mgmt.web.v2020_09_01.models.SystemData>
- description: Target worker tier assigned to the App Service plan.
  name: worker_tier_name
  types:
  - <xref:str>
- description: 'App Service plan status. Known values are: "Ready", "Pending", and
    "Creating".'
  name: status
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2020_09_01.models.StatusOptions>
- description: App Service plan subscription.
  name: subscription
  types:
  - <xref:str>
- description: 'Specification for the App Service Environment to use for the

    App Service plan.'
  name: hosting_environment_profile
  types:
  - <xref:azure.mgmt.web.v2020_09_01.models.HostingEnvironmentProfile>
- description: 'Maximum number of instances that can be assigned to this App

    Service plan.'
  name: maximum_number_of_workers
  types:
  - <xref:int>
- description: Geographical location for the App Service plan.
  name: geo_region
  types:
  - <xref:str>
- description: '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.'
  name: per_site_scaling
  types:
  - <xref:bool>
- description: 'Maximum number of total workers allowed for this

    ElasticScaleEnabled App Service Plan.'
  name: maximum_elastic_worker_count
  types:
  - <xref:int>
- description: Number of apps assigned to this App Service plan.
  name: number_of_sites
  types:
  - <xref:int>
- description: If `<code>true</code>`, this App Service Plan owns spot instances.
  name: is_spot
  types:
  - <xref:bool>
- description: 'The time when the server farm expires. Valid only if it is a spot

    server farm.'
  name: spot_expiration_time
  types:
  - <xref:datetime.datetime>
- description: The time when the server farm free offer expires.
  name: free_offer_expiration_time
  types:
  - <xref:datetime.datetime>
- description: Resource group of the App Service plan.
  name: resource_group
  types:
  - <xref:str>
- description: "This needs to set to `<code>true</code>`\_when creating a Linux App\n\
    Service Plan, along with `<code>kind</code>` set to `<code>Linux</code>`. It should\n\
    be `<code>false</code>` otherwise."
  name: reserved
  types:
  - <xref:bool>
- description: 'Obsolete: If Hyper-V container app service plan `<code>true</code>`,

    `<code>false</code>` otherwise.'
  name: is_xenon
  types:
  - <xref:bool>
- description: 'If Hyper-V container app service plan `<code>true</code>`,

    `<code>false</code>` otherwise.'
  name: hyper_v
  types:
  - <xref:bool>
- description: Scaling worker count.
  name: target_worker_count
  types:
  - <xref:int>
- description: Scaling worker size ID.
  name: target_worker_size_id
  types:
  - <xref:int>
- description: 'Provisioning state of the App Service Environment. Known values are:

    "Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".'
  name: provisioning_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2020_09_01.models.ProvisioningState>