compute.azure.com/v1api20250401
APIVersion
| Value | Description |
|---|---|
| “2025-04-01” |
CapacityReservation
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/ComputeRP.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
Used by: CapacityReservationList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | CapacityReservation_Spec Optional |
|
| status | CapacityReservation_STATUS Optional |
CapacityReservation_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CapacityReservationOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a compute.azure.com/CapacityReservationGroup resource | genruntime.KnownResourceReference Required |
| scheduleProfile | Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is Block. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. |
ScheduleProfile Optional |
| sku | SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called CapacityReservationSupported set to true are supported. When CapacityReservationSupported is true, the SKU capability also specifies the SupportedCapacityReservationTypes, which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. |
Sku Required |
| tags | Resource tags. | map[string]string Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservation_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| instanceView | The Capacity reservation instance view. | CapacityReservationInstanceView_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| platformFaultDomainCount | 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. | int Optional |
| provisioningState | The provisioning state, which only appears in the response. | string Optional |
| provisioningTime | The date time when the capacity reservation was last updated. | string Optional |
| reservationId | A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. | string Optional |
| scheduleProfile | Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is Block. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. |
ScheduleProfile_STATUS Optional |
| sku | SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called CapacityReservationSupported set to true are supported. When CapacityReservationSupported is true, the SKU capability also specifies the SupportedCapacityReservationTypes, which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. |
Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| timeCreated | Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| virtualMachinesAssociated | A list of all virtual machine resource ids that are associated with the capacity reservation. | SubResourceReadOnly_STATUS[] Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservationGroup
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/ComputeRP.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
Used by: CapacityReservationGroupList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | CapacityReservationGroup_Spec Optional |
|
| status | CapacityReservationGroup_STATUS Optional |
CapacityReservationGroup_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CapacityReservationGroupOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| reservationType | Indicates the type of capacity reservation. Allowed values are Block for block capacity reservations and Targeted for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. |
ReservationType Optional |
| sharingProfile | Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. | ResourceSharingProfile Optional |
| tags | Resource tags. | map[string]string Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservationGroup_STATUS
| Property | Description | Type |
|---|---|---|
| capacityReservations | A list of all capacity reservation resource ids that belong to capacity reservation group. | SubResourceReadOnly_STATUS[] Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| instanceView | The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. | CapacityReservationGroupInstanceView_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| reservationType | Indicates the type of capacity reservation. Allowed values are Block for block capacity reservations and Targeted for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. |
ReservationType_STATUS Optional |
| sharingProfile | Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. | ResourceSharingProfile_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| virtualMachinesAssociated | A list of references to all virtual machines associated to the capacity reservation group. | SubResourceReadOnly_STATUS[] Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservationGroupList
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/ComputeRP.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | CapacityReservationGroup[] Optional |
CapacityReservationList
Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2025-04-01/ComputeRP.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | CapacityReservation[] Optional |
CapacityReservation_Spec
Used by: CapacityReservation.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CapacityReservationOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a compute.azure.com/CapacityReservationGroup resource | genruntime.KnownResourceReference Required |
| scheduleProfile | Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is Block. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. |
ScheduleProfile Optional |
| sku | SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called CapacityReservationSupported set to true are supported. When CapacityReservationSupported is true, the SKU capability also specifies the SupportedCapacityReservationTypes, which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. |
Sku Required |
| tags | Resource tags. | map[string]string Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservation_STATUS
Used by: CapacityReservation.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| instanceView | The Capacity reservation instance view. | CapacityReservationInstanceView_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| platformFaultDomainCount | 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. | int Optional |
| provisioningState | The provisioning state, which only appears in the response. | string Optional |
| provisioningTime | The date time when the capacity reservation was last updated. | string Optional |
| reservationId | A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. | string Optional |
| scheduleProfile | Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is Block. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details. |
ScheduleProfile_STATUS Optional |
| sku | SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called CapacityReservationSupported set to true are supported. When CapacityReservationSupported is true, the SKU capability also specifies the SupportedCapacityReservationTypes, which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values. |
Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| timeCreated | Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| virtualMachinesAssociated | A list of all virtual machine resource ids that are associated with the capacity reservation. | SubResourceReadOnly_STATUS[] Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservationGroup_Spec
Used by: CapacityReservationGroup.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CapacityReservationGroupOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| reservationType | Indicates the type of capacity reservation. Allowed values are Block for block capacity reservations and Targeted for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. |
ReservationType Optional |
| sharingProfile | Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. | ResourceSharingProfile Optional |
| tags | Resource tags. | map[string]string Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservationGroup_STATUS
Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.
Used by: CapacityReservationGroup.
| Property | Description | Type |
|---|---|---|
| capacityReservations | A list of all capacity reservation resource ids that belong to capacity reservation group. | SubResourceReadOnly_STATUS[] Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| instanceView | The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group. | CapacityReservationGroupInstanceView_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| reservationType | Indicates the type of capacity reservation. Allowed values are Block for block capacity reservations and Targeted for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned. |
ReservationType_STATUS Optional |
| sharingProfile | Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. | ResourceSharingProfile_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| virtualMachinesAssociated | A list of references to all virtual machines associated to the capacity reservation group. | SubResourceReadOnly_STATUS[] Optional |
| zones | The availability zones. | string[] Optional |
CapacityReservationGroupInstanceView_STATUS
Used by: CapacityReservationGroup_STATUS.
| Property | Description | Type |
|---|---|---|
| capacityReservations | List of instance view of the capacity reservations under the capacity reservation group. | CapacityReservationInstanceViewWithName_STATUS[] Optional |
| sharedSubscriptionIds | 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. | SubResourceReadOnly_STATUS[] Optional |
CapacityReservationGroupOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: CapacityReservationGroup_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
CapacityReservationInstanceView_STATUS
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.
Used by: CapacityReservation_STATUS.
| Property | Description | Type |
|---|---|---|
| statuses | The resource status information. | InstanceViewStatus_STATUS[] Optional |
| utilizationInfo | Unutilized capacity of the capacity reservation. | CapacityReservationUtilization_STATUS Optional |
CapacityReservationOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: CapacityReservation_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ReservationType
Indicates the type of capacity reservation. Allowed values are Block for block capacity reservations and Targeted for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.
Used by: CapacityReservationGroup_Spec.
| Value | Description |
|---|---|
| “Block” | |
| “Targeted” |
ReservationType_STATUS
Indicates the type of capacity reservation. Allowed values are Block for block capacity reservations and Targeted for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.
Used by: CapacityReservationGroup_STATUS.
| Value | Description |
|---|---|
| “Block” | |
| “Targeted” |
ResourceSharingProfile
Used by: CapacityReservationGroup_Spec.
| Property | Description | Type |
|---|---|---|
| subscriptionIds | Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. | SubResource[] Optional |
ResourceSharingProfile_STATUS
Used by: CapacityReservationGroup_STATUS.
| Property | Description | Type |
|---|---|---|
| subscriptionIds | Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. | SubResource_STATUS[] Optional |
ScheduleProfile
Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is Block. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.
Used by: CapacityReservation_Spec.
| Property | Description | Type |
|---|---|---|
| end | The required end date for block capacity reservations. Must be after the start date, with a duration of either 1–14 whole days or 3–26 whole weeks. Example: 2025-06-28. | string Optional |
| start | The required start date for block capacity reservations. Must be today or within 56 days in the future. For same-day scheduling, requests must be submitted before 11:30 AM UTC. Example: 2025-06-27. | string Optional |
ScheduleProfile_STATUS
Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is Block. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.
Used by: CapacityReservation_STATUS.
| Property | Description | Type |
|---|---|---|
| end | The required end date for block capacity reservations. Must be after the start date, with a duration of either 1–14 whole days or 3–26 whole weeks. Example: 2025-06-28. | string Optional |
| start | The required start date for block capacity reservations. Must be today or within 56 days in the future. For same-day scheduling, requests must be submitted before 11:30 AM UTC. Example: 2025-06-27. | string Optional |
Sku
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.
Used by: CapacityReservation_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | Specifies the number of virtual machines in the scale set. | int Optional |
| name | The sku name. | string Optional |
| tier | Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic | string Optional |
Sku_STATUS
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.
Used by: CapacityReservation_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | Specifies the number of virtual machines in the scale set. | int Optional |
| name | The sku name. | string Optional |
| tier | Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic | string Optional |
SubResourceReadOnly_STATUS
Used by: CapacityReservation_STATUS, CapacityReservationGroup_STATUS, CapacityReservationGroup_STATUS, CapacityReservationGroupInstanceView_STATUS, and CapacityReservationUtilization_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource Id | string Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: CapacityReservation_STATUS, and CapacityReservationGroup_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
CapacityReservationInstanceViewWithName_STATUS
The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.
Used by: CapacityReservationGroupInstanceView_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The name of the capacity reservation. | string Optional |
| statuses | The resource status information. | InstanceViewStatus_STATUS[] Optional |
| utilizationInfo | Unutilized capacity of the capacity reservation. | CapacityReservationUtilization_STATUS Optional |
CapacityReservationUtilization_STATUS
Represents the capacity reservation utilization in terms of resources allocated.
Used by: CapacityReservationInstanceView_STATUS, and CapacityReservationInstanceViewWithName_STATUS.
| Property | Description | Type |
|---|---|---|
| currentCapacity | 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. | int Optional |
| virtualMachinesAllocated | A list of all virtual machines resource ids allocated against the capacity reservation. | SubResourceReadOnly_STATUS[] Optional |
InstanceViewStatus_STATUS
Instance view status.
Used by: CapacityReservationInstanceView_STATUS, and CapacityReservationInstanceViewWithName_STATUS.
| Property | Description | Type |
|---|---|---|
| code | The status code. | string Optional |
| displayStatus | The short localizable label for the status. | string Optional |
| level | The level code. | StatusLevelTypes_STATUS Optional |
| message | The detailed status message, including for alerts and error messages. | string Optional |
| time | The time of the status. | string Optional |
SubResource
Used by: ResourceSharingProfile.
| Property | Description | Type |
|---|---|---|
| reference | Resource Id | genruntime.ResourceReference Optional |
SubResource_STATUS
Used by: ResourceSharingProfile_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource Id | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
StatusLevelTypes_STATUS
The level code.
Used by: InstanceViewStatus_STATUS.
| Value | Description |
|---|---|
| “Error” | |
| “Info” | |
| “Warning” |