PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}/?api-version=2023-09-01
The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. 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. |
capacityReservationName |
String | Yes |
The name of the capacity reservation. |
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 |
sku |
Object | Yes |
Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name. |
sku.tier |
String | No |
Specifies the tier of virtual machines in a scale set. |
sku.name |
String | No |
The sku name. |
sku.capacity |
Integer | No |
Specifies the number of virtual machines in the scale set. |
name |
String | No |
Resource name |
properties |
Object | No |
Properties of the Capacity reservation. |
properties.timeCreated |
String | No |
Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. |
properties.virtualMachinesAssociated[] |
Array | No |
A list of all virtual machine resource ids that are associated with the capacity reservation. |
properties.virtualMachinesAssociated[].id |
String | No |
Resource Id |
properties.provisioningState |
String | No |
The provisioning state, which only appears in the response. |
properties.instanceView |
Object | No |
The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations. |
properties.instanceView.utilizationInfo |
Object | No |
Represents the capacity reservation utilization in terms of resources allocated. |
properties.instanceView.utilizationInfo.virtualMachinesAllocated[] |
Array | No |
A list of all virtual machines resource ids allocated against the capacity reservation. |
properties.instanceView.utilizationInfo.virtualMachinesAllocated[].id |
String | No |
Resource Id |
properties.instanceView.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.statuses[] |
Array | No |
The resource status information. |
properties.instanceView.statuses[].time |
String | No |
The time of the status. |
properties.instanceView.statuses[].displayStatus |
String | No |
The short localizable label for the status. |
properties.instanceView.statuses[].message |
String | No |
The detailed status message, including for alerts and error messages. |
properties.instanceView.statuses[].level |
String | No |
The level code. Possible values:
|
properties.instanceView.statuses[].code |
String | No |
The status code. |
properties.platformFaultDomainCount |
Integer | No |
Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. Note: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. |
properties.provisioningTime |
String | No |
The date time when the capacity reservation was last updated. |
properties.reservationId |
String | No |
A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. |
location |
String | No |
Resource location |
zones[] |
Array | No |
Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone. |
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.