Microsoft.Compute capacityReservationGroups 2025-04-01

Bicep resource definition

The capacityReservationGroups 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Compute/capacityReservationGroups@2025-04-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    reservationType: 'string'
    sharingProfile: {
      subscriptionIds: [
        {
          id: 'string'
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

Microsoft.Compute/capacityReservationGroups

CapacityReservationGroupProperties

ResourceSharingProfile

SubResource

TrackedResourceTags

ARM template resource definition

The capacityReservationGroups 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/capacityReservationGroups",
  "apiVersion": "2025-04-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "reservationType": "string",
    "sharingProfile": {
      "subscriptionIds": [
        {
          "id": "string"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Compute/capacityReservationGroups

CapacityReservationGroupProperties

ResourceSharingProfile

SubResource

TrackedResourceTags

Usage Examples

Terraform (AzAPI provider) resource definition

The capacityReservationGroups 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/capacityReservationGroups@2025-04-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      reservationType = "string"
      sharingProfile = {
        subscriptionIds = [
          {
            id = "string"
          }
        ]
      }
    }
    zones = [
      "string"
    ]
  }
}

Property Values

Microsoft.Compute/capacityReservationGroups

CapacityReservationGroupProperties

ResourceSharingProfile

SubResource

TrackedResourceTags

Usage Examples

Terraform Samples

A basic example of deploying 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 = "westeurope"
}

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
  ___location                  = var.___location
  schema_validation_enabled = false
  response_export_values    = ["*"]
}