Microsoft.Compute capacityReservationGroups/capacityReservations

ARM template resource definition

The capacityReservationGroups/capacityReservations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/capacityReservationGroups/capacityReservations resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/capacityReservationGroups/capacityReservations",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {},
  "zones": [ "string" ]
}

Property values

capacityReservationGroups/capacityReservations

Name Description Value
type The resource type 'Microsoft.Compute/capacityReservationGroups/capacityReservations'
apiVersion The resource api version '2023-09-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
sku 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 (/rest/api/compute/resourceskus/list) for supported values. Sku (required)
properties Properties of the Capacity reservation. CapacityReservationProperties
zones 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. string[]

CapacityReservationProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Name Description Value
capacity Specifies the number of virtual machines in the scale set. int
name The sku name. string
tier Specifies the tier of virtual machines in a scale set.

Possible Values:

Standard

Basic

string