Microsoft.Compute capacityReservationGroups 2024-07-01

• Latest
• 2024-11-01
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01

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@2024-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    sharingProfile: {
      subscriptionIds: [
        {
          id: 'string'
        }
      ]
    }
  }
  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
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[]

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource Id	string

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": "2024-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "sharingProfile": {
      "subscriptionIds": [
        {
          "id": "string"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Compute/capacityReservationGroups

Name	Description	Value
apiVersion	The api version	'2024-07-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
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[]

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource Id	string

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@2024-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      sharingProfile = {
        subscriptionIds = [
          {
            id = "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.
type	The resource type	"Microsoft.Compute/capacityReservationGroups@2024-07-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
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[]

ResourceTags

Name	Description	Value

SubResource

Name	Description	Value
id	Resource Id	string