Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. getVolumes
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.getVolumes

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Provides information about volumes.

    For more information on this resource, see the User Guide.
    For more information on this resource actions, see the API documentation.

    Example Usage

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

const outscaleVolumes01 = outscale.getVolumes({
    filters: [
        {
            name: "volume_states",
            values: ["in-use"],
        },
        {
            name: "volume_types",
            values: [
                "gp2",
                "io1",
            ],
        },
    ],
});

    import pulumi
import pulumi_outscale as outscale

outscale_volumes01 = outscale.get_volumes(filters=[
    {
        "name": "volume_states",
        "values": ["in-use"],
    },
    {
        "name": "volume_types",
        "values": [
            "gp2",
            "io1",
        ],
    },
])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.GetVolumes(ctx, &outscale.GetVolumesArgs{
			Filters: []outscale.GetVolumesFilter{
				{
					Name: "volume_states",
					Values: []string{
						"in-use",
					},
				},
				{
					Name: "volume_types",
					Values: []string{
						"gp2",
						"io1",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var outscaleVolumes01 = Outscale.GetVolumes.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVolumesFilterInputArgs
            {
                Name = "volume_states",
                Values = new[]
                {
                    "in-use",
                },
            },
            new Outscale.Inputs.GetVolumesFilterInputArgs
            {
                Name = "volume_types",
                Values = new[]
                {
                    "gp2",
                    "io1",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetVolumesArgs;
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 outscaleVolumes01 = OutscaleFunctions.getVolumes(GetVolumesArgs.builder()
            .filters(            
                GetVolumesFilterArgs.builder()
                    .name("volume_states")
                    .values("in-use")
                    .build(),
                GetVolumesFilterArgs.builder()
                    .name("volume_types")
                    .values(                    
                        "gp2",
                        "io1")
                    .build())
            .build());

    }
}

    variables:
  outscaleVolumes01:
    fn::invoke:
      function: outscale:getVolumes
      arguments:
        filters:
          - name: volume_states
            values:
              - in-use
          - name: volume_types
            values:
              - gp2
              - io1

    Using getVolumes

    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 getVolumes(args: GetVolumesArgs, opts?: InvokeOptions): Promise<GetVolumesResult>
function getVolumesOutput(args: GetVolumesOutputArgs, opts?: InvokeOptions): Output<GetVolumesResult>
    def get_volumes(filters: Optional[Sequence[GetVolumesFilter]] = None,
                id: Optional[str] = None,
                request_id: Optional[str] = None,
                volume_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetVolumesResult
def get_volumes_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVolumesFilterArgs]]]] = None,
                id: Optional[pulumi.Input[str]] = None,
                request_id: Optional[pulumi.Input[str]] = None,
                volume_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetVolumesResult]
    func GetVolumes(ctx *Context, args *GetVolumesArgs, opts ...InvokeOption) (*GetVolumesResult, error)
func GetVolumesOutput(ctx *Context, args *GetVolumesOutputArgs, opts ...InvokeOption) GetVolumesResultOutput

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

    public static class GetVolumes 
{
    public static Task<GetVolumesResult> InvokeAsync(GetVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumesResult> Invoke(GetVolumesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumesResult> getVolumes(GetVolumesArgs args, InvokeOptions options)
public static Output<GetVolumesResult> getVolumes(GetVolumesArgs args, InvokeOptions options)

    fn::invoke:
  function: outscale:index/getVolumes:getVolumes
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filters List<GetVolumesFilter>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    Id string
    RequestId string
    VolumeId string
    The ID of the volume.
    Filters []GetVolumesFilter
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    Id string
    RequestId string
    VolumeId string
    The ID of the volume.
    filters List<GetVolumesFilter>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id String
    requestId String
    volumeId String
    The ID of the volume.
    filters GetVolumesFilter[]
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id string
    requestId string
    volumeId string
    The ID of the volume.
    filters Sequence[GetVolumesFilter]
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id str
    request_id str
    volume_id str
    The ID of the volume.
    filters List<Property Map>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id String
    requestId String
    volumeId String
    The ID of the volume.

    getVolumes Result

    The following output properties are available:

    Id string
    Volumes List<GetVolumesVolume>
    Information about one or more volumes.
    Filters List<GetVolumesFilter>
    RequestId string
    VolumeId string
    The ID of the volume.
    Id string
    Volumes []GetVolumesVolume
    Information about one or more volumes.
    Filters []GetVolumesFilter
    RequestId string
    VolumeId string
    The ID of the volume.
    id String
    volumes List<GetVolumesVolume>
    Information about one or more volumes.
    filters List<GetVolumesFilter>
    requestId String
    volumeId String
    The ID of the volume.
    id string
    volumes GetVolumesVolume[]
    Information about one or more volumes.
    filters GetVolumesFilter[]
    requestId string
    volumeId string
    The ID of the volume.
    id str
    volumes Sequence[GetVolumesVolume]
    Information about one or more volumes.
    filters Sequence[GetVolumesFilter]
    request_id str
    volume_id str
    The ID of the volume.
    id String
    volumes List<Property Map>
    Information about one or more volumes.
    filters List<Property Map>
    requestId String
    volumeId String
    The ID of the volume.

    Supporting Types

    GetVolumesFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    GetVolumesVolume

    CreationDate string
    The date and time (UTC) at which the volume was created.
    Iops double
    The number of I/O operations per second (IOPS):- For io1 volumes, the number of provisioned IOPS.- For gp2 volumes, the baseline performance of the volume.
    LinkedVolumes List<GetVolumesVolumeLinkedVolume>
    Information about your volume attachment.
    Size double
    The size of the volume, in gibibytes (GiB).
    SnapshotId string
    The snapshot from which the volume was created.
    State string
    The state of the volume (creating | available | in-use | updating | deleting | error).
    SubregionName string
    The Subregion in which the volume was created.
    Tags List<GetVolumesVolumeTag>
    One or more tags associated with the volume.
    VolumeId string
    The ID of the volume.
    VolumeType string
    The type of the volume (standard | gp2 | io1).
    CreationDate string
    The date and time (UTC) at which the volume was created.
    Iops float64
    The number of I/O operations per second (IOPS):- For io1 volumes, the number of provisioned IOPS.- For gp2 volumes, the baseline performance of the volume.
    LinkedVolumes []GetVolumesVolumeLinkedVolume
    Information about your volume attachment.
    Size float64
    The size of the volume, in gibibytes (GiB).
    SnapshotId string
    The snapshot from which the volume was created.
    State string
    The state of the volume (creating | available | in-use | updating | deleting | error).
    SubregionName string
    The Subregion in which the volume was created.
    Tags []GetVolumesVolumeTag
    One or more tags associated with the volume.
    VolumeId string
    The ID of the volume.
    VolumeType string
    The type of the volume (standard | gp2 | io1).
    creationDate String
    The date and time (UTC) at which the volume was created.
    iops Double
    The number of I/O operations per second (IOPS):- For io1 volumes, the number of provisioned IOPS.- For gp2 volumes, the baseline performance of the volume.
    linkedVolumes List<GetVolumesVolumeLinkedVolume>
    Information about your volume attachment.
    size Double
    The size of the volume, in gibibytes (GiB).
    snapshotId String
    The snapshot from which the volume was created.
    state String
    The state of the volume (creating | available | in-use | updating | deleting | error).
    subregionName String
    The Subregion in which the volume was created.
    tags List<GetVolumesVolumeTag>
    One or more tags associated with the volume.
    volumeId String
    The ID of the volume.
    volumeType String
    The type of the volume (standard | gp2 | io1).
    creationDate string
    The date and time (UTC) at which the volume was created.
    iops number
    The number of I/O operations per second (IOPS):- For io1 volumes, the number of provisioned IOPS.- For gp2 volumes, the baseline performance of the volume.
    linkedVolumes GetVolumesVolumeLinkedVolume[]
    Information about your volume attachment.
    size number
    The size of the volume, in gibibytes (GiB).
    snapshotId string
    The snapshot from which the volume was created.
    state string
    The state of the volume (creating | available | in-use | updating | deleting | error).
    subregionName string
    The Subregion in which the volume was created.
    tags GetVolumesVolumeTag[]
    One or more tags associated with the volume.
    volumeId string
    The ID of the volume.
    volumeType string
    The type of the volume (standard | gp2 | io1).
    creation_date str
    The date and time (UTC) at which the volume was created.
    iops float
    The number of I/O operations per second (IOPS):- For io1 volumes, the number of provisioned IOPS.- For gp2 volumes, the baseline performance of the volume.
    linked_volumes Sequence[GetVolumesVolumeLinkedVolume]
    Information about your volume attachment.
    size float
    The size of the volume, in gibibytes (GiB).
    snapshot_id str
    The snapshot from which the volume was created.
    state str
    The state of the volume (creating | available | in-use | updating | deleting | error).
    subregion_name str
    The Subregion in which the volume was created.
    tags Sequence[GetVolumesVolumeTag]
    One or more tags associated with the volume.
    volume_id str
    The ID of the volume.
    volume_type str
    The type of the volume (standard | gp2 | io1).
    creationDate String
    The date and time (UTC) at which the volume was created.
    iops Number
    The number of I/O operations per second (IOPS):- For io1 volumes, the number of provisioned IOPS.- For gp2 volumes, the baseline performance of the volume.
    linkedVolumes List<Property Map>
    Information about your volume attachment.
    size Number
    The size of the volume, in gibibytes (GiB).
    snapshotId String
    The snapshot from which the volume was created.
    state String
    The state of the volume (creating | available | in-use | updating | deleting | error).
    subregionName String
    The Subregion in which the volume was created.
    tags List<Property Map>
    One or more tags associated with the volume.
    volumeId String
    The ID of the volume.
    volumeType String
    The type of the volume (standard | gp2 | io1).

    GetVolumesVolumeLinkedVolume

    DeleteOnVmDeletion bool
    If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
    DeviceName string
    The name of the device.
    State string
    The state of the volume (creating | available | in-use | updating | deleting | error).
    VmId string
    The ID of the VM.
    VolumeId string
    The ID of the volume.
    DeleteOnVmDeletion bool
    If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
    DeviceName string
    The name of the device.
    State string
    The state of the volume (creating | available | in-use | updating | deleting | error).
    VmId string
    The ID of the VM.
    VolumeId string
    The ID of the volume.
    deleteOnVmDeletion Boolean
    If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
    deviceName String
    The name of the device.
    state String
    The state of the volume (creating | available | in-use | updating | deleting | error).
    vmId String
    The ID of the VM.
    volumeId String
    The ID of the volume.
    deleteOnVmDeletion boolean
    If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
    deviceName string
    The name of the device.
    state string
    The state of the volume (creating | available | in-use | updating | deleting | error).
    vmId string
    The ID of the VM.
    volumeId string
    The ID of the volume.
    delete_on_vm_deletion bool
    If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
    device_name str
    The name of the device.
    state str
    The state of the volume (creating | available | in-use | updating | deleting | error).
    vm_id str
    The ID of the VM.
    volume_id str
    The ID of the volume.
    deleteOnVmDeletion Boolean
    If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
    deviceName String
    The name of the device.
    state String
    The state of the volume (creating | available | in-use | updating | deleting | error).
    vmId String
    The ID of the VM.
    volumeId String
    The ID of the volume.

    GetVolumesVolumeTag

    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.
    key string
    The key of the tag, with a minimum of 1 character.
    value string
    The value of the tag, between 0 and 255 characters.
    key str
    The key of the tag, with a minimum of 1 character.
    value str
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale