Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getMicrovms
Viewing docs for DigitalOcean v4.84.1
published on Tuesday, Oct 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

digitalocean.getMicrovms

digitalocean logo
Viewing docs for DigitalOcean v4.84.1
published on Tuesday, Oct 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

    Get information on MicroVMs for use in other resources, with the ability to filter and sort the results. If no filters are specified, all MicroVMs are returned.

    The region, name, and tagName arguments are applied by the API and combine with logical AND. The filter and sort blocks are applied to the results afterwards.

    Note: You can use the digitalocean.Microvm data source to obtain metadata about a single MicroVM if you already know its id or unique name.

    Note: MicroVMs are in public preview.

    Example Usage

    Get all MicroVMs in a region that carry a tag:

    import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";

const web = digitalocean.getMicrovms({
    region: "nyc3",
    tagName: "web",
});
export const names = web.then(web => web.microVms.map(__item => __item.name));

    import pulumi
import pulumi_digitalocean as digitalocean

web = digitalocean.get_microvms(region="nyc3",
    tag_name="web")
pulumi.export("names", [__item.name for __item in web.micro_vms])

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
web, err := digitalocean.GetMicrovms(ctx, &digitalocean.GetMicrovmsArgs{
Region: pulumi.StringRef("nyc3"),
TagName: pulumi.StringRef("web"),
}, nil);
if err != nil {
return err
}
ctx.Export("names", pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:6,11-31)))
return nil
})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    var web = DigitalOcean.GetMicrovms.Invoke(new()
    {
        Region = "nyc3",
        TagName = "web",
    });

    return new Dictionary<string, object?>
    {
        ["names"] = web.Apply(getMicrovmsResult => getMicrovmsResult.MicroVms).Select(__item => __item.Name).ToList(),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetMicrovmsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 web = DigitaloceanFunctions.getMicrovms(GetMicrovmsArgs.builder()
            .region("nyc3")
            .tagName("web")
            .build());

        ctx.export("names", web.microVms().stream().map(element -> element.name()).collect(toList()));
    }
}

    Example coming soon!

    terraform {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

data "digitalocean_microvms" "web" {
  region   = "nyc3"
  tag_name = "web"
}

output "names" {
  value = data.digitalocean_microvms.web.micro_vms[*].name
}

    Get all running MicroVMs, sorted by creation time:

    import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";

const running = digitalocean.getMicrovms({
    filters: [{
        key: "current_state",
        values: ["running"],
    }],
    sorts: [{
        key: "created_at",
        direction: "desc",
    }],
});

    import pulumi
import pulumi_digitalocean as digitalocean

running = digitalocean.get_microvms(filters=[{
        "key": "current_state",
        "values": ["running"],
    }],
    sorts=[{
        "key": "created_at",
        "direction": "desc",
    }])

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.GetMicrovms(ctx, &digitalocean.GetMicrovmsArgs{
			Filters: []digitalocean.GetMicrovmsFilter{
				{
					Key: "current_state",
					Values: []string{
						"running",
					},
				},
			},
			Sorts: []digitalocean.GetMicrovmsSort{
				{
					Key:       "created_at",
					Direction: pulumi.StringRef("desc"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    var running = DigitalOcean.GetMicrovms.Invoke(new()
    {
        Filters = new[]
        {
            new DigitalOcean.Inputs.GetMicrovmsFilterInputArgs
            {
                Key = "current_state",
                Values = new[]
                {
                    "running",
                },
            },
        },
        Sorts = new[]
        {
            new DigitalOcean.Inputs.GetMicrovmsSortInputArgs
            {
                Key = "created_at",
                Direction = "desc",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetMicrovmsArgs;
import com.pulumi.digitalocean.inputs.GetMicrovmsFilterArgs;
import com.pulumi.digitalocean.inputs.GetMicrovmsSortArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 running = DigitaloceanFunctions.getMicrovms(GetMicrovmsArgs.builder()
            .filters(GetMicrovmsFilterArgs.builder()
                .key("current_state")
                .values("running")
                .build())
            .sorts(GetMicrovmsSortArgs.builder()
                .key("created_at")
                .direction("desc")
                .build())
            .build());

    }
}

    variables:
  running:
    fn::invoke:
      function: digitalocean:getMicrovms
      arguments:
        filters:
          - key: current_state
            values:
              - running
        sorts:
          - key: created_at
            direction: desc

    terraform {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

data "digitalocean_microvms" "running" {
  filters {
    key    = "current_state"
    values = ["running"]
  }
  sorts {
    key       = "created_at"
    direction = "desc"
  }
}

    Using getMicrovms

    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 getMicrovms(args: GetMicrovmsArgs, opts?: InvokeOptions): Promise<GetMicrovmsResult>
function getMicrovmsOutput(args: GetMicrovmsOutputArgs, opts?: InvokeOutputOptions): Output<GetMicrovmsResult>
    def get_microvms(filters: Optional[Sequence[GetMicrovmsFilter]] = None,
                 name: Optional[str] = None,
                 region: Optional[str] = None,
                 sorts: Optional[Sequence[GetMicrovmsSort]] = None,
                 tag_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetMicrovmsResult
def get_microvms_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetMicrovmsFilterArgs]]]] = None,
                 name: pulumi.Input[Optional[str]] = None,
                 region: pulumi.Input[Optional[str]] = None,
                 sorts: pulumi.Input[Optional[Sequence[pulumi.Input[GetMicrovmsSortArgs]]]] = None,
                 tag_name: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetMicrovmsResult]
    func GetMicrovms(ctx *Context, args *GetMicrovmsArgs, opts ...InvokeOption) (*GetMicrovmsResult, error)
func GetMicrovmsOutput(ctx *Context, args *GetMicrovmsOutputArgs, opts ...InvokeOption) GetMicrovmsResultOutput

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

    public static class GetMicrovms 
{
    public static Task<GetMicrovmsResult> InvokeAsync(GetMicrovmsArgs args, InvokeOptions? opts = null)
    public static Output<GetMicrovmsResult> Invoke(GetMicrovmsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetMicrovmsResult> Invoke(GetMicrovmsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetMicrovmsResult> getMicrovms(GetMicrovmsArgs args, InvokeOptions options)
public static Output<GetMicrovmsResult> getMicrovms(GetMicrovmsArgs args, InvokeOptions options)
public static Output<GetMicrovmsResult> getMicrovms(GetMicrovmsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: digitalocean:index/getMicrovms:getMicrovms
  arguments:
    # arguments dictionary
    data "digitalocean_get_microvms" "name" {
    # arguments
}

    The following arguments are supported:

    Filters List<Pulumi.DigitalOcean.Inputs.GetMicrovmsFilter>
    Filter the results. The filter block is documented below.
    Name string
    Only return MicroVMs with this exact name.
    Region string
    Only return MicroVMs in this region.
    Sorts List<Pulumi.DigitalOcean.Inputs.GetMicrovmsSort>
    Sort the results. The sort block is documented below.
    TagName string
    Only return MicroVMs that carry this tag.
    Filters []GetMicrovmsFilter
    Filter the results. The filter block is documented below.
    Name string
    Only return MicroVMs with this exact name.
    Region string
    Only return MicroVMs in this region.
    Sorts []GetMicrovmsSort
    Sort the results. The sort block is documented below.
    TagName string
    Only return MicroVMs that carry this tag.
    filters list(object)
    Filter the results. The filter block is documented below.
    name string
    Only return MicroVMs with this exact name.
    region string
    Only return MicroVMs in this region.
    sorts list(object)
    Sort the results. The sort block is documented below.
    tag_name string
    Only return MicroVMs that carry this tag.
    filters List<GetMicrovmsFilter>
    Filter the results. The filter block is documented below.
    name String
    Only return MicroVMs with this exact name.
    region String
    Only return MicroVMs in this region.
    sorts List<GetMicrovmsSort>
    Sort the results. The sort block is documented below.
    tagName String
    Only return MicroVMs that carry this tag.
    filters GetMicrovmsFilter[]
    Filter the results. The filter block is documented below.
    name string
    Only return MicroVMs with this exact name.
    region string
    Only return MicroVMs in this region.
    sorts GetMicrovmsSort[]
    Sort the results. The sort block is documented below.
    tagName string
    Only return MicroVMs that carry this tag.
    filters Sequence[GetMicrovmsFilter]
    Filter the results. The filter block is documented below.
    name str
    Only return MicroVMs with this exact name.
    region str
    Only return MicroVMs in this region.
    sorts Sequence[GetMicrovmsSort]
    Sort the results. The sort block is documented below.
    tag_name str
    Only return MicroVMs that carry this tag.
    filters List<Property Map>
    Filter the results. The filter block is documented below.
    name String
    Only return MicroVMs with this exact name.
    region String
    Only return MicroVMs in this region.
    sorts List<Property Map>
    Sort the results. The sort block is documented below.
    tagName String
    Only return MicroVMs that carry this tag.

    getMicrovms Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    MicroVms List<Pulumi.DigitalOcean.Outputs.GetMicrovmsMicroVm>
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    Filters List<Pulumi.DigitalOcean.Outputs.GetMicrovmsFilter>
    Name string
    Region string
    Sorts List<Pulumi.DigitalOcean.Outputs.GetMicrovmsSort>
    TagName string
    Id string
    The provider-assigned unique ID for this managed resource.
    MicroVms []GetMicrovmsMicroVm
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    Filters []GetMicrovmsFilter
    Name string
    Region string
    Sorts []GetMicrovmsSort
    TagName string
    id string
    The provider-assigned unique ID for this managed resource.
    micro_vms list(object)
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    filters list(object)
    name string
    region string
    sorts list(object)
    tag_name string
    id String
    The provider-assigned unique ID for this managed resource.
    microVms List<GetMicrovmsMicroVm>
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    filters List<GetMicrovmsFilter>
    name String
    region String
    sorts List<GetMicrovmsSort>
    tagName String
    id string
    The provider-assigned unique ID for this managed resource.
    microVms GetMicrovmsMicroVm[]
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    filters GetMicrovmsFilter[]
    name string
    region string
    sorts GetMicrovmsSort[]
    tagName string
    id str
    The provider-assigned unique ID for this managed resource.
    micro_vms Sequence[GetMicrovmsMicroVm]
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    filters Sequence[GetMicrovmsFilter]
    name str
    region str
    sorts Sequence[GetMicrovmsSort]
    tag_name str
    id String
    The provider-assigned unique ID for this managed resource.
    microVms List<Property Map>
    A list of MicroVMs satisfying any filter and sort criteria. Each MicroVM has the same attributes as the digitalocean.Microvm data source.
    filters List<Property Map>
    name String
    region String
    sorts List<Property Map>
    tagName String

    Supporting Types

    GetMicrovmsFilter

    Key string
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    Values List<string>
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    Key string
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    Values []string
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key string
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    values list(string)
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    all bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    match_by string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    values List<String>
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key string
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    values string[]
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    all boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key str
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    values Sequence[str]
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    all bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    match_by str
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, failureReason, autoResume, ports, tags, urn, or createdAt.
    values List<String>
    A list of values to match against the key field. Only retrieves MicroVMs where the key field takes on one or more of the values provided here.
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

    GetMicrovmsMicroVm

    AutoPauses List<Pulumi.DigitalOcean.Inputs.GetMicrovmsMicroVmAutoPause>
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    AutoResume bool
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    CreatedAt string
    The creation timestamp for the MicroVM
    CurrentState string
    Observed lifecycle state of the MicroVM
    Environment Dictionary<string, string>
    Environment variables passed to the MicroVM
    FailureReason string
    Human-readable explanation when currentState is failed
    HttpPort int
    Port the MicroVM exposes over HTTP
    HttpProtocol string
    HTTP protocol: 'http' or 'http2'
    Id string
    MicroVM ID
    Name string
    Only return MicroVMs with this exact name.
    Networking string
    Networking mode: 'public' or 'vpc'
    Ports List<int>
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    Region string
    Only return MicroVMs in this region.
    Sizes List<Pulumi.DigitalOcean.Inputs.GetMicrovmsMicroVmSize>
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    Sources List<Pulumi.DigitalOcean.Inputs.GetMicrovmsMicroVmSource>
    Workload source. Exactly one of ociRef or checkpointId must be set.
    State string
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    Tags List<string>
    Urls List<Pulumi.DigitalOcean.Inputs.GetMicrovmsMicroVmUrl>
    Ingress URLs for the MicroVM
    Urn string
    The uniform resource name (URN) for the MicroVM
    VpcUuid string
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.
    AutoPauses []GetMicrovmsMicroVmAutoPause
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    AutoResume bool
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    CreatedAt string
    The creation timestamp for the MicroVM
    CurrentState string
    Observed lifecycle state of the MicroVM
    Environment map[string]string
    Environment variables passed to the MicroVM
    FailureReason string
    Human-readable explanation when currentState is failed
    HttpPort int
    Port the MicroVM exposes over HTTP
    HttpProtocol string
    HTTP protocol: 'http' or 'http2'
    Id string
    MicroVM ID
    Name string
    Only return MicroVMs with this exact name.
    Networking string
    Networking mode: 'public' or 'vpc'
    Ports []int
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    Region string
    Only return MicroVMs in this region.
    Sizes []GetMicrovmsMicroVmSize
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    Sources []GetMicrovmsMicroVmSource
    Workload source. Exactly one of ociRef or checkpointId must be set.
    State string
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    Tags []string
    Urls []GetMicrovmsMicroVmUrl
    Ingress URLs for the MicroVM
    Urn string
    The uniform resource name (URN) for the MicroVM
    VpcUuid string
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.
    auto_pauses list(object)
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    auto_resume bool
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    created_at string
    The creation timestamp for the MicroVM
    current_state string
    Observed lifecycle state of the MicroVM
    environment map(string)
    Environment variables passed to the MicroVM
    failure_reason string
    Human-readable explanation when currentState is failed
    http_port number
    Port the MicroVM exposes over HTTP
    http_protocol string
    HTTP protocol: 'http' or 'http2'
    id string
    MicroVM ID
    name string
    Only return MicroVMs with this exact name.
    networking string
    Networking mode: 'public' or 'vpc'
    ports list(number)
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    region string
    Only return MicroVMs in this region.
    sizes list(object)
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    sources list(object)
    Workload source. Exactly one of ociRef or checkpointId must be set.
    state string
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    tags list(string)
    urls list(object)
    Ingress URLs for the MicroVM
    urn string
    The uniform resource name (URN) for the MicroVM
    vpc_uuid string
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.
    autoPauses List<GetMicrovmsMicroVmAutoPause>
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    autoResume Boolean
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    createdAt String
    The creation timestamp for the MicroVM
    currentState String
    Observed lifecycle state of the MicroVM
    environment Map<String,String>
    Environment variables passed to the MicroVM
    failureReason String
    Human-readable explanation when currentState is failed
    httpPort Integer
    Port the MicroVM exposes over HTTP
    httpProtocol String
    HTTP protocol: 'http' or 'http2'
    id String
    MicroVM ID
    name String
    Only return MicroVMs with this exact name.
    networking String
    Networking mode: 'public' or 'vpc'
    ports List<Integer>
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    region String
    Only return MicroVMs in this region.
    sizes List<GetMicrovmsMicroVmSize>
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    sources List<GetMicrovmsMicroVmSource>
    Workload source. Exactly one of ociRef or checkpointId must be set.
    state String
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    tags List<String>
    urls List<GetMicrovmsMicroVmUrl>
    Ingress URLs for the MicroVM
    urn String
    The uniform resource name (URN) for the MicroVM
    vpcUuid String
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.
    autoPauses GetMicrovmsMicroVmAutoPause[]
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    autoResume boolean
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    createdAt string
    The creation timestamp for the MicroVM
    currentState string
    Observed lifecycle state of the MicroVM
    environment {[key: string]: string}
    Environment variables passed to the MicroVM
    failureReason string
    Human-readable explanation when currentState is failed
    httpPort number
    Port the MicroVM exposes over HTTP
    httpProtocol string
    HTTP protocol: 'http' or 'http2'
    id string
    MicroVM ID
    name string
    Only return MicroVMs with this exact name.
    networking string
    Networking mode: 'public' or 'vpc'
    ports number[]
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    region string
    Only return MicroVMs in this region.
    sizes GetMicrovmsMicroVmSize[]
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    sources GetMicrovmsMicroVmSource[]
    Workload source. Exactly one of ociRef or checkpointId must be set.
    state string
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    tags string[]
    urls GetMicrovmsMicroVmUrl[]
    Ingress URLs for the MicroVM
    urn string
    The uniform resource name (URN) for the MicroVM
    vpcUuid string
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.
    auto_pauses Sequence[GetMicrovmsMicroVmAutoPause]
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    auto_resume bool
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    created_at str
    The creation timestamp for the MicroVM
    current_state str
    Observed lifecycle state of the MicroVM
    environment Mapping[str, str]
    Environment variables passed to the MicroVM
    failure_reason str
    Human-readable explanation when currentState is failed
    http_port int
    Port the MicroVM exposes over HTTP
    http_protocol str
    HTTP protocol: 'http' or 'http2'
    id str
    MicroVM ID
    name str
    Only return MicroVMs with this exact name.
    networking str
    Networking mode: 'public' or 'vpc'
    ports Sequence[int]
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    region str
    Only return MicroVMs in this region.
    sizes Sequence[GetMicrovmsMicroVmSize]
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    sources Sequence[GetMicrovmsMicroVmSource]
    Workload source. Exactly one of ociRef or checkpointId must be set.
    state str
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    tags Sequence[str]
    urls Sequence[GetMicrovmsMicroVmUrl]
    Ingress URLs for the MicroVM
    urn str
    The uniform resource name (URN) for the MicroVM
    vpc_uuid str
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.
    autoPauses List<Property Map>
    Auto-pause configuration. Forces recreation on change: the MicroVMs API has no in-place update path for auto_pause.
    autoResume Boolean
    Whether the MicroVM should auto-resume on request. Forces recreation on change: the MicroVMs API has no in-place update path for auto_resume.
    createdAt String
    The creation timestamp for the MicroVM
    currentState String
    Observed lifecycle state of the MicroVM
    environment Map<String>
    Environment variables passed to the MicroVM
    failureReason String
    Human-readable explanation when currentState is failed
    httpPort Number
    Port the MicroVM exposes over HTTP
    httpProtocol String
    HTTP protocol: 'http' or 'http2'
    id String
    MicroVM ID
    name String
    Only return MicroVMs with this exact name.
    networking String
    Networking mode: 'public' or 'vpc'
    ports List<Number>
    Guest ports open for ingress. Defaults to just httpPort when omitted.
    region String
    Only return MicroVMs in this region.
    sizes List<Property Map>
    Compute size. Required when creating from oci_ref; optional when restoring from a checkpoint (inherited).
    sources List<Property Map>
    Workload source. Exactly one of ociRef or checkpointId must be set.
    state String
    Desired lifecycle state: 'running' or 'paused'. Changes are applied by calling the microvm pause / resume action endpoints.
    tags List<String>
    urls List<Property Map>
    Ingress URLs for the MicroVM
    urn String
    The uniform resource name (URN) for the MicroVM
    vpcUuid String
    UUID of the VPC to attach the MicroVM to. Only valid when networking is 'vpc'.

    GetMicrovmsMicroVmAutoPause

    Enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    IdleTimeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    Enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    IdleTimeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idle_timeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled Boolean
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idleTimeout String
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled boolean
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idleTimeout string
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled bool
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idle_timeout str
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).
    enabled Boolean
    Whether auto-pause is enabled. Forces recreation on change (no in-place API path).
    idleTimeout String
    Idle timeout as a Go duration string (e.g. '5m', '30s'). Forces recreation on change (no in-place API path).

    GetMicrovmsMicroVmSize

    Cpu int
    Number of vCPUs
    Disk int
    Attached disk in GB (provisioned with the size)
    Memory int
    Memory in MiB
    Cpu int
    Number of vCPUs
    Disk int
    Attached disk in GB (provisioned with the size)
    Memory int
    Memory in MiB
    cpu number
    Number of vCPUs
    disk number
    Attached disk in GB (provisioned with the size)
    memory number
    Memory in MiB
    cpu Integer
    Number of vCPUs
    disk Integer
    Attached disk in GB (provisioned with the size)
    memory Integer
    Memory in MiB
    cpu number
    Number of vCPUs
    disk number
    Attached disk in GB (provisioned with the size)
    memory number
    Memory in MiB
    cpu int
    Number of vCPUs
    disk int
    Attached disk in GB (provisioned with the size)
    memory int
    Memory in MiB
    cpu Number
    Number of vCPUs
    disk Number
    Attached disk in GB (provisioned with the size)
    memory Number
    Memory in MiB

    GetMicrovmsMicroVmSource

    CheckpointId string
    Checkpoint UUID to restore
    OciRef string
    OCI reference for the workload container
    CheckpointId string
    Checkpoint UUID to restore
    OciRef string
    OCI reference for the workload container
    checkpoint_id string
    Checkpoint UUID to restore
    oci_ref string
    OCI reference for the workload container
    checkpointId String
    Checkpoint UUID to restore
    ociRef String
    OCI reference for the workload container
    checkpointId string
    Checkpoint UUID to restore
    ociRef string
    OCI reference for the workload container
    checkpoint_id str
    Checkpoint UUID to restore
    oci_ref str
    OCI reference for the workload container
    checkpointId String
    Checkpoint UUID to restore
    ociRef String
    OCI reference for the workload container

    GetMicrovmsMicroVmUrl

    Default bool
    Whether this is the system default URL
    Hostname string
    Hostname (no scheme)
    Port int
    Guest port this URL forwards to
    Status string
    URL lifecycle status (PENDING or ACTIVE)
    Default bool
    Whether this is the system default URL
    Hostname string
    Hostname (no scheme)
    Port int
    Guest port this URL forwards to
    Status string
    URL lifecycle status (PENDING or ACTIVE)
    default bool
    Whether this is the system default URL
    hostname string
    Hostname (no scheme)
    port number
    Guest port this URL forwards to
    status string
    URL lifecycle status (PENDING or ACTIVE)
    default_ Boolean
    Whether this is the system default URL
    hostname String
    Hostname (no scheme)
    port Integer
    Guest port this URL forwards to
    status String
    URL lifecycle status (PENDING or ACTIVE)
    default boolean
    Whether this is the system default URL
    hostname string
    Hostname (no scheme)
    port number
    Guest port this URL forwards to
    status string
    URL lifecycle status (PENDING or ACTIVE)
    default bool
    Whether this is the system default URL
    hostname str
    Hostname (no scheme)
    port int
    Guest port this URL forwards to
    status str
    URL lifecycle status (PENDING or ACTIVE)
    default Boolean
    Whether this is the system default URL
    hostname String
    Hostname (no scheme)
    port Number
    Guest port this URL forwards to
    status String
    URL lifecycle status (PENDING or ACTIVE)

    GetMicrovmsSort

    Key string
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    Direction string
    The sort direction. This may be either asc or desc.
    Key string
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    Direction string
    The sort direction. This may be either asc or desc.
    key string
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    direction string
    The sort direction. This may be either asc or desc.
    key String
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    direction String
    The sort direction. This may be either asc or desc.
    key string
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    direction string
    The sort direction. This may be either asc or desc.
    key str
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    direction str
    The sort direction. This may be either asc or desc.
    key String
    Sort the MicroVMs by this key. This may be one of id, name, region, networking, httpProtocol, currentState, autoResume, urn, or createdAt.
    direction String
    The sort direction. This may be either asc or desc.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    Viewing docs for DigitalOcean v4.84.1
    published on Tuesday, Oct 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-digitalocean

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial