1. Packages
  2. Netbox Provider
  3. API Docs
  4. getVirtualDisk
netbox 4.1.0 published on Wednesday, Jul 2, 2025 by e-breuninger

netbox.getVirtualDisk

Explore with Pulumi AI

netbox logo
netbox 4.1.0 published on Wednesday, Jul 2, 2025 by e-breuninger

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netbox from "@pulumi/netbox";
    
    const diskByName = netbox.getVirtualDisk({
        filters: [{
            name: "name",
            value: "disk1",
        }],
    });
    const diskByTag = netbox.getVirtualDisk({
        filters: [{
            name: "tag",
            value: "production",
        }],
    });
    const diskFiltered = netbox.getVirtualDisk({
        filters: [
            {
                name: "name",
                value: "disk1",
            },
            {
                name: "tag",
                value: "production",
            },
        ],
    });
    const diskRegex = netbox.getVirtualDisk({
        limit: 10,
        nameRegex: "^disk[0-9]+",
    });
    
    import pulumi
    import pulumi_netbox as netbox
    
    disk_by_name = netbox.get_virtual_disk(filters=[{
        "name": "name",
        "value": "disk1",
    }])
    disk_by_tag = netbox.get_virtual_disk(filters=[{
        "name": "tag",
        "value": "production",
    }])
    disk_filtered = netbox.get_virtual_disk(filters=[
        {
            "name": "name",
            "value": "disk1",
        },
        {
            "name": "tag",
            "value": "production",
        },
    ])
    disk_regex = netbox.get_virtual_disk(limit=10,
        name_regex="^disk[0-9]+")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v4/netbox"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := netbox.LookupVirtualDisk(ctx, &netbox.LookupVirtualDiskArgs{
    			Filters: []netbox.GetVirtualDiskFilter{
    				{
    					Name:  "name",
    					Value: "disk1",
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = netbox.LookupVirtualDisk(ctx, &netbox.LookupVirtualDiskArgs{
    			Filters: []netbox.GetVirtualDiskFilter{
    				{
    					Name:  "tag",
    					Value: "production",
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = netbox.LookupVirtualDisk(ctx, &netbox.LookupVirtualDiskArgs{
    			Filters: []netbox.GetVirtualDiskFilter{
    				{
    					Name:  "name",
    					Value: "disk1",
    				},
    				{
    					Name:  "tag",
    					Value: "production",
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = netbox.LookupVirtualDisk(ctx, &netbox.LookupVirtualDiskArgs{
    			Limit:     pulumi.Float64Ref(10),
    			NameRegex: pulumi.StringRef("^disk[0-9]+"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netbox = Pulumi.Netbox;
    
    return await Deployment.RunAsync(() => 
    {
        var diskByName = Netbox.GetVirtualDisk.Invoke(new()
        {
            Filters = new[]
            {
                new Netbox.Inputs.GetVirtualDiskFilterInputArgs
                {
                    Name = "name",
                    Value = "disk1",
                },
            },
        });
    
        var diskByTag = Netbox.GetVirtualDisk.Invoke(new()
        {
            Filters = new[]
            {
                new Netbox.Inputs.GetVirtualDiskFilterInputArgs
                {
                    Name = "tag",
                    Value = "production",
                },
            },
        });
    
        var diskFiltered = Netbox.GetVirtualDisk.Invoke(new()
        {
            Filters = new[]
            {
                new Netbox.Inputs.GetVirtualDiskFilterInputArgs
                {
                    Name = "name",
                    Value = "disk1",
                },
                new Netbox.Inputs.GetVirtualDiskFilterInputArgs
                {
                    Name = "tag",
                    Value = "production",
                },
            },
        });
    
        var diskRegex = Netbox.GetVirtualDisk.Invoke(new()
        {
            Limit = 10,
            NameRegex = "^disk[0-9]+",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netbox.NetboxFunctions;
    import com.pulumi.netbox.inputs.GetVirtualDiskArgs;
    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) {
            final var diskByName = NetboxFunctions.getVirtualDisk(GetVirtualDiskArgs.builder()
                .filters(GetVirtualDiskFilterArgs.builder()
                    .name("name")
                    .value("disk1")
                    .build())
                .build());
    
            final var diskByTag = NetboxFunctions.getVirtualDisk(GetVirtualDiskArgs.builder()
                .filters(GetVirtualDiskFilterArgs.builder()
                    .name("tag")
                    .value("production")
                    .build())
                .build());
    
            final var diskFiltered = NetboxFunctions.getVirtualDisk(GetVirtualDiskArgs.builder()
                .filters(            
                    GetVirtualDiskFilterArgs.builder()
                        .name("name")
                        .value("disk1")
                        .build(),
                    GetVirtualDiskFilterArgs.builder()
                        .name("tag")
                        .value("production")
                        .build())
                .build());
    
            final var diskRegex = NetboxFunctions.getVirtualDisk(GetVirtualDiskArgs.builder()
                .limit(10)
                .nameRegex("^disk[0-9]+")
                .build());
    
        }
    }
    
    variables:
      diskByName:
        fn::invoke:
          function: netbox:getVirtualDisk
          arguments:
            filters:
              - name: name
                value: disk1
      diskByTag:
        fn::invoke:
          function: netbox:getVirtualDisk
          arguments:
            filters:
              - name: tag
                value: production
      diskFiltered:
        fn::invoke:
          function: netbox:getVirtualDisk
          arguments:
            filters:
              - name: name
                value: disk1
              - name: tag
                value: production
      diskRegex:
        fn::invoke:
          function: netbox:getVirtualDisk
          arguments:
            limit: 10
            nameRegex: ^disk[0-9]+
    

    Using getVirtualDisk

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVirtualDisk(args: GetVirtualDiskArgs, opts?: InvokeOptions): Promise<GetVirtualDiskResult>
    function getVirtualDiskOutput(args: GetVirtualDiskOutputArgs, opts?: InvokeOptions): Output<GetVirtualDiskResult>
    def get_virtual_disk(filters: Optional[Sequence[GetVirtualDiskFilter]] = None,
                         id: Optional[str] = None,
                         limit: Optional[float] = None,
                         name_regex: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVirtualDiskResult
    def get_virtual_disk_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualDiskFilterArgs]]]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         limit: Optional[pulumi.Input[float]] = None,
                         name_regex: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetVirtualDiskResult]
    func LookupVirtualDisk(ctx *Context, args *LookupVirtualDiskArgs, opts ...InvokeOption) (*LookupVirtualDiskResult, error)
    func LookupVirtualDiskOutput(ctx *Context, args *LookupVirtualDiskOutputArgs, opts ...InvokeOption) LookupVirtualDiskResultOutput

    > Note: This function is named LookupVirtualDisk in the Go SDK.

    public static class GetVirtualDisk 
    {
        public static Task<GetVirtualDiskResult> InvokeAsync(GetVirtualDiskArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualDiskResult> Invoke(GetVirtualDiskInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualDiskResult> getVirtualDisk(GetVirtualDiskArgs args, InvokeOptions options)
    public static Output<GetVirtualDiskResult> getVirtualDisk(GetVirtualDiskArgs args, InvokeOptions options)
    
    fn::invoke:
      function: netbox:index/getVirtualDisk:getVirtualDisk
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<GetVirtualDiskFilter>
    Id string
    The ID of this resource.
    Limit double
    NameRegex string
    Filters []GetVirtualDiskFilter
    Id string
    The ID of this resource.
    Limit float64
    NameRegex string
    filters List<GetVirtualDiskFilter>
    id String
    The ID of this resource.
    limit Double
    nameRegex String
    filters GetVirtualDiskFilter[]
    id string
    The ID of this resource.
    limit number
    nameRegex string
    filters Sequence[GetVirtualDiskFilter]
    id str
    The ID of this resource.
    limit float
    name_regex str
    filters List<Property Map>
    id String
    The ID of this resource.
    limit Number
    nameRegex String

    getVirtualDisk Result

    The following output properties are available:

    Supporting Types

    GetVirtualDiskFilter

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GetVirtualDiskVirtualDisk

    CustomFields Dictionary<string, string>
    Description string
    Id double
    Name string
    SizeMb double
    Tags List<string>
    VirtualMachineId double
    CustomFields map[string]string
    Description string
    Id float64
    Name string
    SizeMb float64
    Tags []string
    VirtualMachineId float64
    customFields Map<String,String>
    description String
    id Double
    name String
    sizeMb Double
    tags List<String>
    virtualMachineId Double
    customFields {[key: string]: string}
    description string
    id number
    name string
    sizeMb number
    tags string[]
    virtualMachineId number
    custom_fields Mapping[str, str]
    description str
    id float
    name str
    size_mb float
    tags Sequence[str]
    virtual_machine_id float
    customFields Map<String>
    description String
    id Number
    name String
    sizeMb Number
    tags List<String>
    virtualMachineId Number

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    netbox logo
    netbox 4.1.0 published on Wednesday, Jul 2, 2025 by e-breuninger