1. Packages
  2. Packages
  3. Freebox
  4. API Docs
  5. virtual
  6. Disk
Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien
freebox logo
Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien

    Create Disk Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Disk(name: string, args: DiskArgs, opts?: CustomResourceOptions);
    @overload
    def Disk(resource_name: str,
             args: DiskArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Disk(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             path: Optional[str] = None,
             virtual_size: Optional[int] = None,
             polling: Optional[_root_inputs.VirtualDiskPollingArgs] = None,
             resize_from: Optional[str] = None,
             type: Optional[str] = None)
    func NewDisk(ctx *Context, name string, args DiskArgs, opts ...ResourceOption) (*Disk, error)
    public Disk(string name, DiskArgs args, CustomResourceOptions? opts = null)
    public Disk(String name, DiskArgs args)
    public Disk(String name, DiskArgs args, CustomResourceOptions options)
    
    type: freebox:virtual:Disk
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "freebox_virtual_disk" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DiskArgs
    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 DiskArgs
    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 DiskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DiskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DiskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var diskResource = new Freebox.Virtual.Disk("diskResource", new()
    {
        Path = "string",
        VirtualSize = 0,
        Polling = new Freebox.Inputs.VirtualDiskPollingArgs
        {
            Checksum = new Freebox.Inputs.PollingSpecArgs
            {
                Interval = 0,
                Timeout = 0,
            },
            Copy = new Freebox.Inputs.PollingSpecArgs
            {
                Interval = 0,
                Timeout = 0,
            },
            Create = new Freebox.Inputs.PollingSpecArgs
            {
                Interval = 0,
                Timeout = 0,
            },
            Delete = new Freebox.Inputs.PollingSpecArgs
            {
                Interval = 0,
                Timeout = 0,
            },
            Move = new Freebox.Inputs.PollingSpecArgs
            {
                Interval = 0,
                Timeout = 0,
            },
            Resize = new Freebox.Inputs.PollingSpecArgs
            {
                Interval = 0,
                Timeout = 0,
            },
        },
        ResizeFrom = "string",
        Type = "string",
    });
    
    example, err := virtual.NewDisk(ctx, "diskResource", &virtual.DiskArgs{
    	Path:        pulumi.String("string"),
    	VirtualSize: pulumi.Int(0),
    	Polling: &freebox.VirtualDiskPollingArgs{
    		Checksum: &freebox.PollingSpecArgs{
    			Interval: pulumi.Int(0),
    			Timeout:  pulumi.Int(0),
    		},
    		Copy: &freebox.PollingSpecArgs{
    			Interval: pulumi.Int(0),
    			Timeout:  pulumi.Int(0),
    		},
    		Create: &freebox.PollingSpecArgs{
    			Interval: pulumi.Int(0),
    			Timeout:  pulumi.Int(0),
    		},
    		Delete: &freebox.PollingSpecArgs{
    			Interval: pulumi.Int(0),
    			Timeout:  pulumi.Int(0),
    		},
    		Move: &freebox.PollingSpecArgs{
    			Interval: pulumi.Int(0),
    			Timeout:  pulumi.Int(0),
    		},
    		Resize: &freebox.PollingSpecArgs{
    			Interval: pulumi.Int(0),
    			Timeout:  pulumi.Int(0),
    		},
    	},
    	ResizeFrom: pulumi.String("string"),
    	Type:       pulumi.String("string"),
    })
    
    resource "freebox_virtual_disk" "diskResource" {
      path         = "string"
      virtual_size = 0
      polling = {
        checksum = {
          interval = 0
          timeout  = 0
        }
        copy = {
          interval = 0
          timeout  = 0
        }
        create = {
          interval = 0
          timeout  = 0
        }
        delete = {
          interval = 0
          timeout  = 0
        }
        move = {
          interval = 0
          timeout  = 0
        }
        resize = {
          interval = 0
          timeout  = 0
        }
      }
      resize_from = "string"
      type        = "string"
    }
    
    var diskResource = new Disk("diskResource", DiskArgs.builder()
        .path("string")
        .virtualSize(0)
        .polling(VirtualDiskPollingArgs.builder()
            .checksum(PollingSpecArgs.builder()
                .interval(0)
                .timeout(0)
                .build())
            .copy(PollingSpecArgs.builder()
                .interval(0)
                .timeout(0)
                .build())
            .create(PollingSpecArgs.builder()
                .interval(0)
                .timeout(0)
                .build())
            .delete(PollingSpecArgs.builder()
                .interval(0)
                .timeout(0)
                .build())
            .move(PollingSpecArgs.builder()
                .interval(0)
                .timeout(0)
                .build())
            .resize(PollingSpecArgs.builder()
                .interval(0)
                .timeout(0)
                .build())
            .build())
        .resizeFrom("string")
        .type("string")
        .build());
    
    disk_resource = freebox.virtual.Disk("diskResource",
        path="string",
        virtual_size=0,
        polling={
            "checksum": {
                "interval": 0,
                "timeout": 0,
            },
            "copy": {
                "interval": 0,
                "timeout": 0,
            },
            "create": {
                "interval": 0,
                "timeout": 0,
            },
            "delete": {
                "interval": 0,
                "timeout": 0,
            },
            "move": {
                "interval": 0,
                "timeout": 0,
            },
            "resize": {
                "interval": 0,
                "timeout": 0,
            },
        },
        resize_from="string",
        type="string")
    
    const diskResource = new freebox.virtual.Disk("diskResource", {
        path: "string",
        virtualSize: 0,
        polling: {
            checksum: {
                interval: 0,
                timeout: 0,
            },
            copy: {
                interval: 0,
                timeout: 0,
            },
            create: {
                interval: 0,
                timeout: 0,
            },
            "delete": {
                interval: 0,
                timeout: 0,
            },
            move: {
                interval: 0,
                timeout: 0,
            },
            resize: {
                interval: 0,
                timeout: 0,
            },
        },
        resizeFrom: "string",
        type: "string",
    });
    
    type: freebox:virtual:Disk
    properties:
        path: string
        polling:
            checksum:
                interval: 0
                timeout: 0
            copy:
                interval: 0
                timeout: 0
            create:
                interval: 0
                timeout: 0
            delete:
                interval: 0
                timeout: 0
            move:
                interval: 0
                timeout: 0
            resize:
                interval: 0
                timeout: 0
        resizeFrom: string
        type: string
        virtualSize: 0
    

    Disk Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Disk resource accepts the following input properties:

    Path string
    Path to the virtual disk on the Freebox.
    VirtualSize int
    Size in bytes of the virtual disk (as seen inside the VM).
    Polling OlivierPaquien.Pulumi.Freebox.Inputs.VirtualDiskPolling
    ResizeFrom string
    Path to an existing disk to copy and resize from.
    Type string
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.
    Path string
    Path to the virtual disk on the Freebox.
    VirtualSize int
    Size in bytes of the virtual disk (as seen inside the VM).
    Polling VirtualDiskPollingArgs
    ResizeFrom string
    Path to an existing disk to copy and resize from.
    Type string
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.
    path string
    Path to the virtual disk on the Freebox.
    virtual_size number
    Size in bytes of the virtual disk (as seen inside the VM).
    polling object
    resize_from string
    Path to an existing disk to copy and resize from.
    type string
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.
    path String
    Path to the virtual disk on the Freebox.
    virtualSize Integer
    Size in bytes of the virtual disk (as seen inside the VM).
    polling VirtualDiskPolling
    resizeFrom String
    Path to an existing disk to copy and resize from.
    type String
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.
    path string
    Path to the virtual disk on the Freebox.
    virtualSize number
    Size in bytes of the virtual disk (as seen inside the VM).
    polling VirtualDiskPolling
    resizeFrom string
    Path to an existing disk to copy and resize from.
    type string
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.
    path str
    Path to the virtual disk on the Freebox.
    virtual_size int
    Size in bytes of the virtual disk (as seen inside the VM).
    polling VirtualDiskPollingArgs
    resize_from str
    Path to an existing disk to copy and resize from.
    type str
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.
    path String
    Path to the virtual disk on the Freebox.
    virtualSize Number
    Size in bytes of the virtual disk (as seen inside the VM).
    polling Property Map
    resizeFrom String
    Path to an existing disk to copy and resize from.
    type String
    Type of virtual disk (qcow2 or raw). Defaults to qcow2.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Disk resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    SizeOnDisk int
    Space in bytes used on disk.
    ResizeFromChecksum string
    SHA512 checksum of resizeFrom source (internal).
    Id string
    The provider-assigned unique ID for this managed resource.
    SizeOnDisk int
    Space in bytes used on disk.
    ResizeFromChecksum string
    SHA512 checksum of resizeFrom source (internal).
    id string
    The provider-assigned unique ID for this managed resource.
    size_on_disk number
    Space in bytes used on disk.
    resize_from_checksum string
    SHA512 checksum of resizeFrom source (internal).
    id String
    The provider-assigned unique ID for this managed resource.
    sizeOnDisk Integer
    Space in bytes used on disk.
    resizeFromChecksum String
    SHA512 checksum of resizeFrom source (internal).
    id string
    The provider-assigned unique ID for this managed resource.
    sizeOnDisk number
    Space in bytes used on disk.
    resizeFromChecksum string
    SHA512 checksum of resizeFrom source (internal).
    id str
    The provider-assigned unique ID for this managed resource.
    size_on_disk int
    Space in bytes used on disk.
    resize_from_checksum str
    SHA512 checksum of resizeFrom source (internal).
    id String
    The provider-assigned unique ID for this managed resource.
    sizeOnDisk Number
    Space in bytes used on disk.
    resizeFromChecksum String
    SHA512 checksum of resizeFrom source (internal).

    Supporting Types

    PollingSpec, PollingSpecArgs

    interval number
    timeout number
    interval Integer
    timeout Integer
    interval number
    timeout number
    interval Number
    timeout Number

    VirtualDiskPolling, VirtualDiskPollingArgs

    Package Details

    Repository
    freebox
    License
    freebox logo
    Viewing docs for Freebox v0.3.11
    published on Friday, Jul 3, 2026 by OlivierPaquien

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial