Microsoft.Compute capacityReservationGroups/capacityReservations 2025-04-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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 Bicep to your template.

resource symbolicname 'Microsoft.Compute/capacityReservationGroups/capacityReservations@2025-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    scheduleProfile: {
      end: 'string'
      start: 'string'
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

Microsoft.Compute/capacityReservationGroups/capacityReservations

CapacityReservationProperties

ScheduleProfile

Sku

TrackedResourceTags

Usage Examples

Bicep Samples

A basic example of deploying Capacity Reservation within a Capacity Reservation Group.

param resourceName string = 'acctest0001'
param location string = 'westus'

resource capacityReservationGroup 'Microsoft.Compute/capacityReservationGroups@2022-03-01' = {
  name: '${resourceName}-ccrg'
  location: location
}

resource capacityReservation 'Microsoft.Compute/capacityReservationGroups/capacityReservations@2022-03-01' = {
  parent: capacityReservationGroup
  name: '${resourceName}-ccr'
  location: location
  sku: {
    capacity: 2
    name: 'Standard_F2'
  }
}

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2025-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "scheduleProfile": {
      "end": "string",
      "start": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Compute/capacityReservationGroups/capacityReservations

CapacityReservationProperties

ScheduleProfile

Sku

TrackedResourceTags

Usage Examples

Terraform (AzAPI provider) resource definition

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

• Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/capacityReservationGroups/capacityReservations@2025-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      scheduleProfile = {
        end = "string"
        start = "string"
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
    zones = [
      "string"
    ]
  }
}

Property Values

Microsoft.Compute/capacityReservationGroups/capacityReservations

CapacityReservationProperties

ScheduleProfile

Sku

TrackedResourceTags

Usage Examples

Terraform Samples

A basic example of deploying Capacity Reservation within a Capacity Reservation Group.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "capacityReservationGroup" {
  type      = "Microsoft.Compute/capacityReservationGroups@2022-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-ccrg"
  location  = var.location
}

resource "azapi_resource" "capacityReservation" {
  type      = "Microsoft.Compute/capacityReservationGroups/capacityReservations@2022-03-01"
  parent_id = azapi_resource.capacityReservationGroup.id
  name      = "${var.resource_name}-ccr"
  location  = var.location
  body = {
    sku = {
      capacity = 2
      name     = "Standard_F2"
    }
  }
}