Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The capacityReservationGroups 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Compute/capacityReservationGroups@2021-11-01' = {
location: 'string'
name: 'string'
properties: {}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property Values
Microsoft.Compute/capacityReservationGroups
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | capacity reservation group Properties. | CapacityReservationGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| zones | Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. | string[] |
CapacityReservationGroupProperties
| Name | Description | Value |
|---|
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Bicep Samples
A basic example of deploying Capacity Reservation Group.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource capacityReservationGroup 'Microsoft.Compute/capacityReservationGroups@2022-03-01' = {
name: resourceName
location: location
}
ARM template resource definition
The capacityReservationGroups 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 resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/capacityReservationGroups",
"apiVersion": "2021-11-01",
"name": "string",
"location": "string",
"properties": {
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property Values
Microsoft.Compute/capacityReservationGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-11-01' |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | capacity reservation group Properties. | CapacityReservationGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Compute/capacityReservationGroups' |
| zones | Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. | string[] |
CapacityReservationGroupProperties
| Name | Description | Value |
|---|
ResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The capacityReservationGroups 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/capacityReservationGroups@2021-11-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
}
zones = [
"string"
]
}
}
Property Values
Microsoft.Compute/capacityReservationGroups
| Name | Description | Value |
|---|---|---|
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | capacity reservation group Properties. | CapacityReservationGroupProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Compute/capacityReservationGroups@2021-11-01" |
| zones | Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones. | string[] |
CapacityReservationGroupProperties
| Name | Description | Value |
|---|
ResourceTags
| Name | Description | Value |
|---|
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 = ["*"]
}
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Capacity Reservation Group | AVM Resource Module for Capacity Reservation Group |