@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Specifies information about the capacity reservation.
*
* Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01.
*
* Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class CapacityReservation extends pulumi.CustomResource {
/**
* Get an existing CapacityReservation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): CapacityReservation;
/**
* Returns true if the given object is an instance of CapacityReservation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CapacityReservation;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The Capacity reservation instance view.
*/
readonly instanceView: pulumi.Output<outputs.compute.CapacityReservationInstanceViewResponse>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* 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.
*/
readonly platformFaultDomainCount: pulumi.Output<number>;
/**
* The provisioning state, which only appears in the response.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The date time when the capacity reservation was last updated.
*/
readonly provisioningTime: pulumi.Output<string>;
/**
* A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.
*/
readonly reservationId: pulumi.Output<string>;
/**
* 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.
*/
readonly sku: pulumi.Output<outputs.compute.SkuResponse>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.compute.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
*/
readonly timeCreated: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* A list of all virtual machine resource ids that are associated with the capacity reservation.
*/
readonly virtualMachinesAssociated: pulumi.Output<outputs.compute.SubResourceReadOnlyResponse[]>;
/**
* The availability zones.
*/
readonly zones: pulumi.Output<string[] | undefined>;
/**
* Create a CapacityReservation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CapacityReservationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a CapacityReservation resource.
*/
export interface CapacityReservationArgs {
/**
* The name of the capacity reservation group.
*/
capacityReservationGroupName: pulumi.Input<string>;
/**
* The name of the capacity reservation.
*/
capacityReservationName?: pulumi.Input<string>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* 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.
*/
sku: pulumi.Input<inputs.compute.SkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The availability zones.
*/
zones?: pulumi.Input<pulumi.Input<string>[]>;
}