@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
90 lines (89 loc) • 3.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/virtualization/virtualdisk/):
*
* > A virtual disk is used to model discrete virtual hard disks assigned to virtual machines.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* // Assumes vmw-cluster-01 exists in Netbox
* const vmwCluster01 = netbox.virt.getCluster({
* name: "vmw-cluster-01",
* });
* const baseVm = new netbox.virt.VirtualMachine("base_vm", {
* clusterId: vmwCluster01.then(vmwCluster01 => vmwCluster01.id),
* name: "myvm-1",
* });
* const example = new netbox.virt.VirtualDisk("example", {
* name: "disk-01",
* description: "Main disk",
* sizeMb: 50,
* virtualMachineId: baseVm.id,
* });
* ```
*/
export declare class VirtualDisk extends pulumi.CustomResource {
/**
* Get an existing VirtualDisk 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VirtualDiskState, opts?: pulumi.CustomResourceOptions): VirtualDisk;
/**
* Returns true if the given object is an instance of VirtualDisk. 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 VirtualDisk;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly sizeMb: pulumi.Output<number>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tagsAlls: pulumi.Output<string[]>;
readonly virtualMachineId: pulumi.Output<number>;
/**
* Create a VirtualDisk 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: VirtualDiskArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering VirtualDisk resources.
*/
export interface VirtualDiskState {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
sizeMb?: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tagsAlls?: pulumi.Input<pulumi.Input<string>[]>;
virtualMachineId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a VirtualDisk resource.
*/
export interface VirtualDiskArgs {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
sizeMb: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
virtualMachineId: pulumi.Input<number>;
}