azure-native.compute.CapacityReservation
Explore with Pulumi AI
Specifies information about the capacity reservation. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2021-04-01
Example Usage
Create or update a capacity reservation .
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var capacityReservation = new AzureNative.Compute.CapacityReservation("capacityReservation", new()
{
CapacityReservationGroupName = "myCapacityReservationGroup",
CapacityReservationName = "myCapacityReservation",
Location = "westus",
ResourceGroupName = "myResourceGroup",
Sku = new AzureNative.Compute.Inputs.SkuArgs
{
Capacity = 4,
Name = "Standard_DS1_v2",
},
Tags =
{
{ "department", "HR" },
},
Zones = new[]
{
"1",
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewCapacityReservation(ctx, "capacityReservation", &compute.CapacityReservationArgs{
CapacityReservationGroupName: pulumi.String("myCapacityReservationGroup"),
CapacityReservationName: pulumi.String("myCapacityReservation"),
Location: pulumi.String("westus"),
ResourceGroupName: pulumi.String("myResourceGroup"),
Sku: &compute.SkuArgs{
Capacity: pulumi.Float64(4),
Name: pulumi.String("Standard_DS1_v2"),
},
Tags: pulumi.StringMap{
"department": pulumi.String("HR"),
},
Zones: pulumi.StringArray{
pulumi.String("1"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.CapacityReservation;
import com.pulumi.azurenative.compute.CapacityReservationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var capacityReservation = new CapacityReservation("capacityReservation", CapacityReservationArgs.builder()
.capacityReservationGroupName("myCapacityReservationGroup")
.capacityReservationName("myCapacityReservation")
.location("westus")
.resourceGroupName("myResourceGroup")
.sku(Map.ofEntries(
Map.entry("capacity", 4),
Map.entry("name", "Standard_DS1_v2")
))
.tags(Map.of("department", "HR"))
.zones("1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
capacity_reservation = azure_native.compute.CapacityReservation("capacityReservation",
capacity_reservation_group_name="myCapacityReservationGroup",
capacity_reservation_name="myCapacityReservation",
location="westus",
resource_group_name="myResourceGroup",
sku=azure_native.compute.SkuArgs(
capacity=4,
name="Standard_DS1_v2",
),
tags={
"department": "HR",
},
zones=["1"])
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const capacityReservation = new azure_native.compute.CapacityReservation("capacityReservation", {
capacityReservationGroupName: "myCapacityReservationGroup",
capacityReservationName: "myCapacityReservation",
location: "westus",
resourceGroupName: "myResourceGroup",
sku: {
capacity: 4,
name: "Standard_DS1_v2",
},
tags: {
department: "HR",
},
zones: ["1"],
});
resources:
capacityReservation:
type: azure-native:compute:CapacityReservation
properties:
capacityReservationGroupName: myCapacityReservationGroup
capacityReservationName: myCapacityReservation
location: westus
resourceGroupName: myResourceGroup
sku:
capacity: 4
name: Standard_DS1_v2
tags:
department: HR
zones:
- '1'
Create CapacityReservation Resource
new CapacityReservation(name: string, args: CapacityReservationArgs, opts?: CustomResourceOptions);
@overload
def CapacityReservation(resource_name: str,
opts: Optional[ResourceOptions] = None,
capacity_reservation_group_name: Optional[str] = None,
capacity_reservation_name: Optional[str] = None,
location: Optional[str] = None,
resource_group_name: Optional[str] = None,
sku: Optional[SkuArgs] = None,
tags: Optional[Mapping[str, str]] = None,
zones: Optional[Sequence[str]] = None)
@overload
def CapacityReservation(resource_name: str,
args: CapacityReservationArgs,
opts: Optional[ResourceOptions] = None)
func NewCapacityReservation(ctx *Context, name string, args CapacityReservationArgs, opts ...ResourceOption) (*CapacityReservation, error)
public CapacityReservation(string name, CapacityReservationArgs args, CustomResourceOptions? opts = null)
public CapacityReservation(String name, CapacityReservationArgs args)
public CapacityReservation(String name, CapacityReservationArgs args, CustomResourceOptions options)
type: azure-native:compute:CapacityReservation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CapacityReservationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CapacityReservationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CapacityReservationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CapacityReservationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CapacityReservationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CapacityReservation Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The CapacityReservation resource accepts the following input properties:
- Capacity
Reservation stringGroup Name The name of the capacity reservation group.
- Resource
Group stringName The name of the resource group.
- Sku
Pulumi.
Azure Native. Compute. Inputs. Sku SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
- Capacity
Reservation stringName The name of the capacity reservation.
- Location string
Resource location
- Dictionary<string, string>
Resource tags
- Zones List<string>
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.
- Capacity
Reservation stringGroup Name The name of the capacity reservation group.
- Resource
Group stringName The name of the resource group.
- Sku
Sku
Args SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
- Capacity
Reservation stringName The name of the capacity reservation.
- Location string
Resource location
- map[string]string
Resource tags
- Zones []string
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.
- capacity
Reservation StringGroup Name The name of the capacity reservation group.
- resource
Group StringName The name of the resource group.
- sku Sku
SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
- capacity
Reservation StringName The name of the capacity reservation.
- location String
Resource location
- Map<String,String>
Resource tags
- zones List<String>
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.
- capacity
Reservation stringGroup Name The name of the capacity reservation group.
- resource
Group stringName The name of the resource group.
- sku Sku
SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
- capacity
Reservation stringName The name of the capacity reservation.
- location string
Resource location
- {[key: string]: string}
Resource tags
- zones string[]
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.
- capacity_
reservation_ strgroup_ name The name of the capacity reservation group.
- resource_
group_ strname The name of the resource group.
- sku
Sku
Args SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
- capacity_
reservation_ strname The name of the capacity reservation.
- location str
Resource location
- Mapping[str, str]
Resource tags
- zones Sequence[str]
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.
- capacity
Reservation StringGroup Name The name of the capacity reservation group.
- resource
Group StringName The name of the resource group.
- sku Property Map
SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
- capacity
Reservation StringName The name of the capacity reservation.
- location String
Resource location
- Map<String>
Resource tags
- zones List<String>
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.
Outputs
All input properties are implicitly available as output properties. Additionally, the CapacityReservation resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
View Pulumi.Azure Native. Compute. Outputs. Capacity Reservation Instance View Response The Capacity reservation instance view.
- Name string
Resource name
- Platform
Fault intDomain Count 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.
- Provisioning
State string The provisioning state, which only appears in the response.
- Provisioning
Time string The date time when the capacity reservation was last updated.
- Reservation
Id string A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
- Time
Created string Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
- Type string
Resource type
- Virtual
Machines List<Pulumi.Associated Azure Native. Compute. Outputs. Sub Resource Read Only Response> A list of all virtual machine resource ids that are associated with the capacity reservation.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
View CapacityReservation Instance View Response The Capacity reservation instance view.
- Name string
Resource name
- Platform
Fault intDomain Count 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.
- Provisioning
State string The provisioning state, which only appears in the response.
- Provisioning
Time string The date time when the capacity reservation was last updated.
- Reservation
Id string A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
- Time
Created string Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
- Type string
Resource type
- Virtual
Machines []SubAssociated Resource Read Only Response A list of all virtual machine resource ids that are associated with the capacity reservation.
- id String
The provider-assigned unique ID for this managed resource.
- instance
View CapacityReservation Instance View Response The Capacity reservation instance view.
- name String
Resource name
- platform
Fault IntegerDomain Count 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.
- provisioning
State String The provisioning state, which only appears in the response.
- provisioning
Time String The date time when the capacity reservation was last updated.
- reservation
Id String A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
- time
Created String Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
- type String
Resource type
- virtual
Machines List<SubAssociated Resource Read Only Response> A list of all virtual machine resource ids that are associated with the capacity reservation.
- id string
The provider-assigned unique ID for this managed resource.
- instance
View CapacityReservation Instance View Response The Capacity reservation instance view.
- name string
Resource name
- platform
Fault numberDomain Count 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.
- provisioning
State string The provisioning state, which only appears in the response.
- provisioning
Time string The date time when the capacity reservation was last updated.
- reservation
Id string A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
- time
Created string Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
- type string
Resource type
- virtual
Machines SubAssociated Resource Read Only Response[] A list of all virtual machine resource ids that are associated with the capacity reservation.
- id str
The provider-assigned unique ID for this managed resource.
- instance_
view CapacityReservation Instance View Response The Capacity reservation instance view.
- name str
Resource name
- platform_
fault_ intdomain_ count 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.
- provisioning_
state str The provisioning state, which only appears in the response.
- provisioning_
time str The date time when the capacity reservation was last updated.
- reservation_
id str A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
- time_
created str Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
- type str
Resource type
- virtual_
machines_ Sequence[Subassociated Resource Read Only Response] A list of all virtual machine resource ids that are associated with the capacity reservation.
- id String
The provider-assigned unique ID for this managed resource.
- instance
View Property Map The Capacity reservation instance view.
- name String
Resource name
- platform
Fault NumberDomain Count 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.
- provisioning
State String The provisioning state, which only appears in the response.
- provisioning
Time String The date time when the capacity reservation was last updated.
- reservation
Id String A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
- time
Created String Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
- type String
Resource type
- virtual
Machines List<Property Map>Associated A list of all virtual machine resource ids that are associated with the capacity reservation.
Supporting Types
CapacityReservationInstanceViewResponse, CapacityReservationInstanceViewResponseArgs
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> The resource status information.
- Utilization
Info Pulumi.Azure Native. Compute. Inputs. Capacity Reservation Utilization Response Unutilized capacity of the capacity reservation.
- Statuses
[]Instance
View Status Response The resource status information.
- Utilization
Info CapacityReservation Utilization Response Unutilized capacity of the capacity reservation.
- statuses
List<Instance
View Status Response> The resource status information.
- utilization
Info CapacityReservation Utilization Response Unutilized capacity of the capacity reservation.
- statuses
Instance
View Status Response[] The resource status information.
- utilization
Info CapacityReservation Utilization Response Unutilized capacity of the capacity reservation.
- statuses
Sequence[Instance
View Status Response] The resource status information.
- utilization_
info CapacityReservation Utilization Response Unutilized capacity of the capacity reservation.
- statuses List<Property Map>
The resource status information.
- utilization
Info Property Map Unutilized capacity of the capacity reservation.
CapacityReservationUtilizationResponse, CapacityReservationUtilizationResponseArgs
- Current
Capacity int 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.
- Virtual
Machines List<Pulumi.Allocated Azure Native. Compute. Inputs. Sub Resource Read Only Response> A list of all virtual machines resource ids allocated against the capacity reservation.
- Current
Capacity int 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.
- Virtual
Machines []SubAllocated Resource Read Only Response A list of all virtual machines resource ids allocated against the capacity reservation.
- current
Capacity Integer 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.
- virtual
Machines List<SubAllocated Resource Read Only Response> A list of all virtual machines resource ids allocated against the capacity reservation.
- current
Capacity number 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.
- virtual
Machines SubAllocated Resource Read Only Response[] A list of all virtual machines resource ids allocated against the capacity reservation.
- current_
capacity int 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.
- virtual_
machines_ Sequence[Suballocated Resource Read Only Response] A list of all virtual machines resource ids allocated against the capacity reservation.
- current
Capacity Number 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.
- virtual
Machines List<Property Map>Allocated A list of all virtual machines resource ids allocated against the capacity reservation.
InstanceViewStatusResponse, InstanceViewStatusResponseArgs
- Code string
The status code.
- Display
Status string The short localizable label for the status.
- Level string
The level code.
- Message string
The detailed status message, including for alerts and error messages.
- Time string
The time of the status.
- Code string
The status code.
- Display
Status string The short localizable label for the status.
- Level string
The level code.
- Message string
The detailed status message, including for alerts and error messages.
- Time string
The time of the status.
- code String
The status code.
- display
Status String The short localizable label for the status.
- level String
The level code.
- message String
The detailed status message, including for alerts and error messages.
- time String
The time of the status.
- code string
The status code.
- display
Status string The short localizable label for the status.
- level string
The level code.
- message string
The detailed status message, including for alerts and error messages.
- time string
The time of the status.
- code str
The status code.
- display_
status str The short localizable label for the status.
- level str
The level code.
- message str
The detailed status message, including for alerts and error messages.
- time str
The time of the status.
- code String
The status code.
- display
Status String The short localizable label for the status.
- level String
The level code.
- message String
The detailed status message, including for alerts and error messages.
- time String
The time of the status.
Sku, SkuArgs
SkuResponse, SkuResponseArgs
SubResourceReadOnlyResponse, SubResourceReadOnlyResponseArgs
- Id string
Resource Id
- Id string
Resource Id
- id String
Resource Id
- id string
Resource Id
- id str
Resource Id
- id String
Resource Id
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:compute:CapacityReservation myCapacityReservation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0