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.
To create a Microsoft.Compute/capacityReservationGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Compute/capacityReservationGroups",
"apiVersion": "2023-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"sharingProfile": {
"subscriptionIds": [
{
"id": "string"
}
]
}
},
"zones": [ "string" ]
}
Property values
capacityReservationGroups
Name |
Description |
Value |
type |
The resource type |
'Microsoft.Compute/capacityReservationGroups' |
apiVersion |
The resource api version |
'2023-09-01' |
name |
The resource name |
string (required) |
location |
Resource location |
string (required) |
tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
properties |
capacity reservation group Properties. |
CapacityReservationGroupProperties |
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 |
sharingProfile |
Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. |
ResourceSharingProfile |
ResourceSharingProfile
Name |
Description |
Value |
subscriptionIds |
Specifies an array of subscription resource IDs that capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. |
SubResource[] |
SubResource
Name |
Description |
Value |
id |
Resource Id |
string |