PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/?api-version=2023-09-01
The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
capacityReservationGroupName |
String | Yes |
The name of the capacity reservation group. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No |
capacity reservation group Properties. |
properties.virtualMachinesAssociated[] |
Array | No |
A list of references to all virtual machines associated to the capacity reservation group. |
properties.virtualMachinesAssociated[].id |
String | No |
Resource Id |
properties.instanceView |
Object | No | |
properties.instanceView.sharedSubscriptionIds[] |
Array | No |
List of the subscriptions that the capacity reservation group is shared with. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. |
properties.instanceView.sharedSubscriptionIds[].id |
String | No |
Resource Id |
properties.instanceView.capacityReservations[] |
Array | No |
List of instance view of the capacity reservations under the capacity reservation group. |
properties.instanceView.capacityReservations[].name |
String | No |
The name of the capacity reservation. |
properties.instanceView.capacityReservations[].utilizationInfo |
Object | No |
Represents the capacity reservation utilization in terms of resources allocated. |
properties.instanceView.capacityReservations[].utilizationInfo.virtualMachinesAllocated[] |
Array | No |
A list of all virtual machines resource ids allocated against the capacity reservation. |
properties.instanceView.capacityReservations[].utilizationInfo.virtualMachinesAllocated[].id |
String | No |
Resource Id |
properties.instanceView.capacityReservations[].utilizationInfo.currentCapacity |
Integer | No |
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. |
properties.instanceView.capacityReservations[].statuses[] |
Array | No |
The resource status information. |
properties.instanceView.capacityReservations[].statuses[].time |
String | No |
The time of the status. |
properties.instanceView.capacityReservations[].statuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.instanceView.capacityReservations[].statuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.instanceView.capacityReservations[].statuses[].level |
String | No |
The level code. Possible values:
|
properties.instanceView.capacityReservations[].statuses[].code |
String | No |
The status code. |
properties.sharingProfile |
Object | No | |
properties.sharingProfile.subscriptionIds[] |
Array | No |
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. |
properties.sharingProfile.subscriptionIds[].id |
String | No |
Resource Id |
properties.capacityReservations[] |
Array | No |
A list of all capacity reservation resource ids that belong to capacity reservation group. |
properties.capacityReservations[].id |
String | No |
Resource Id |
location |
String | No |
Resource location |
zones[] |
Array | No |
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. |
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.