azure.mgmt.compute.v2024_03_01.models.CapacityReservation.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2024_03_01.models.CapacityReservation
name: CapacityReservation
fullName: azure.mgmt.compute.v2024_03_01.models.CapacityReservation
module: azure.mgmt.compute.v2024_03_01.models
inheritances:
- azure.mgmt.compute.v2024_03_01.models._models_py3.Resource
summary: 'Specifies information about the capacity reservation.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'CapacityReservation(*, location: str, sku: _models.Sku, tags: Dict[str,
    str] | None = None, zones: List[str] | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: location
    description: Resource location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: sku
    description: 'SKU of the resource for which capacity needs be reserved. The SKU
      name and

      capacity is required to be set. Currently VM Skus with the capability called

      ''CapacityReservationSupported'' set to true are supported. Refer to List Microsoft.Compute
      SKUs

      in a region ([https://docs.microsoft.com/rest/api/compute/resourceskus/list](https://docs.microsoft.com/rest/api/compute/resourceskus/list))
      for supported

      values. Required.'
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.Sku>
  - name: zones
    description: 'Availability Zone to use for this capacity reservation. The zone
      has to be

      single value and also should be part for the list of zones specified during
      the capacity

      reservation group creation. The zone can be assigned only during creation. If
      not provided, the

      reservation supports only non-zonal deployments. If provided, enforces VM/VMSS
      using this

      capacity reservation to be in same zone.'
    types:
    - <xref:list>[<xref:str>]
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: 'SKU of the resource for which capacity needs be reserved. The SKU
    name and capacity

    is required to be set. Currently VM Skus with the capability called

    ''CapacityReservationSupported'' set to true are supported. Refer to List Microsoft.Compute
    SKUs

    in a region ([https://docs.microsoft.com/rest/api/compute/resourceskus/list](https://docs.microsoft.com/rest/api/compute/resourceskus/list))
    for supported

    values. Required.'
  name: sku
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.Sku>
- description: 'Availability Zone to use for this capacity reservation. The zone has
    to be single

    value and also should be part for the list of zones specified during the capacity
    reservation

    group creation. The zone can be assigned only during creation. If not provided,
    the reservation

    supports only non-zonal deployments. If provided, enforces VM/VMSS using this
    capacity

    reservation to be in same zone.'
  name: zones
  types:
  - <xref:list>[<xref:str>]
- description: 'A unique id generated and assigned to the capacity reservation by
    the

    platform which does not change throughout the lifetime of the resource.'
  name: reservation_id
  types:
  - <xref:str>
- description: 'Specifies the value of fault domain count that Capacity

    Reservation supports for requested VM size. **Note:** The fault domain count specified
    for a

    resource (like virtual machines scale set) must be less than or equal to this
    value if it

    deploys using capacity reservation. Minimum api-version: 2022-08-01.'
  name: platform_fault_domain_count
  types:
  - <xref:int>
- description: 'A list of all virtual machine resource ids that are

    associated with the capacity reservation.'
  name: virtual_machines_associated
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2024_03_01.models.SubResourceReadOnly>]
- description: The date time when the capacity reservation was last updated.
  name: provisioning_time
  types:
  - <xref:datetime.datetime>
- description: The provisioning state, which only appears in the response.
  name: provisioning_state
  types:
  - <xref:str>
- description: The Capacity reservation instance view.
  name: instance_view
  types:
  - <xref:azure.mgmt.compute.v2024_03_01.models.CapacityReservationInstanceView>
- description: 'Specifies the time at which the Capacity Reservation resource was
    created.

    Minimum api-version: 2021-11-01.'
  name: time_created
  types:
  - <xref:datetime.datetime>