Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Desktops
  5. getDesktopPoolVolumes
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Desktops.getDesktopPoolVolumes

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Desktop Pool Volumes in Oracle Cloud Infrastructure Desktops service.

    Returns a list of volumes within the given desktop pool. You can limit the results to an availability domain, volume name, or volume state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

    Example Usage

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

const testDesktopPoolVolumes = oci.Desktops.getDesktopPoolVolumes({
    compartmentId: compartmentId,
    desktopPoolId: testDesktopPool.id,
    availabilityDomain: desktopPoolVolumeAvailabilityDomain,
    displayName: desktopPoolVolumeDisplayName,
    id: desktopPoolVolumeId,
    state: desktopPoolVolumeState,
});

    import pulumi
import pulumi_oci as oci

test_desktop_pool_volumes = oci.Desktops.get_desktop_pool_volumes(compartment_id=compartment_id,
    desktop_pool_id=test_desktop_pool["id"],
    availability_domain=desktop_pool_volume_availability_domain,
    display_name=desktop_pool_volume_display_name,
    id=desktop_pool_volume_id,
    state=desktop_pool_volume_state)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Desktops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Desktops.GetDesktopPoolVolumes(ctx, &desktops.GetDesktopPoolVolumesArgs{
			CompartmentId:      compartmentId,
			DesktopPoolId:      testDesktopPool.Id,
			AvailabilityDomain: pulumi.StringRef(desktopPoolVolumeAvailabilityDomain),
			DisplayName:        pulumi.StringRef(desktopPoolVolumeDisplayName),
			Id:                 pulumi.StringRef(desktopPoolVolumeId),
			State:              pulumi.StringRef(desktopPoolVolumeState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDesktopPoolVolumes = Oci.Desktops.GetDesktopPoolVolumes.Invoke(new()
    {
        CompartmentId = compartmentId,
        DesktopPoolId = testDesktopPool.Id,
        AvailabilityDomain = desktopPoolVolumeAvailabilityDomain,
        DisplayName = desktopPoolVolumeDisplayName,
        Id = desktopPoolVolumeId,
        State = desktopPoolVolumeState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Desktops.DesktopsFunctions;
import com.pulumi.oci.Desktops.inputs.GetDesktopPoolVolumesArgs;
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 testDesktopPoolVolumes = DesktopsFunctions.getDesktopPoolVolumes(GetDesktopPoolVolumesArgs.builder()
            .compartmentId(compartmentId)
            .desktopPoolId(testDesktopPool.id())
            .availabilityDomain(desktopPoolVolumeAvailabilityDomain)
            .displayName(desktopPoolVolumeDisplayName)
            .id(desktopPoolVolumeId)
            .state(desktopPoolVolumeState)
            .build());

    }
}

    variables:
  testDesktopPoolVolumes:
    fn::invoke:
      Function: oci:Desktops:getDesktopPoolVolumes
      Arguments:
        compartmentId: ${compartmentId}
        desktopPoolId: ${testDesktopPool.id}
        availabilityDomain: ${desktopPoolVolumeAvailabilityDomain}
        displayName: ${desktopPoolVolumeDisplayName}
        id: ${desktopPoolVolumeId}
        state: ${desktopPoolVolumeState}

    Using getDesktopPoolVolumes

    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 getDesktopPoolVolumes(args: GetDesktopPoolVolumesArgs, opts?: InvokeOptions): Promise<GetDesktopPoolVolumesResult>
function getDesktopPoolVolumesOutput(args: GetDesktopPoolVolumesOutputArgs, opts?: InvokeOptions): Output<GetDesktopPoolVolumesResult>
    def get_desktop_pool_volumes(availability_domain: Optional[str] = None,
                             compartment_id: Optional[str] = None,
                             desktop_pool_id: Optional[str] = None,
                             display_name: Optional[str] = None,
                             filters: Optional[Sequence[_desktops.GetDesktopPoolVolumesFilter]] = None,
                             id: Optional[str] = None,
                             state: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDesktopPoolVolumesResult
def get_desktop_pool_volumes_output(availability_domain: Optional[pulumi.Input[str]] = None,
                             compartment_id: Optional[pulumi.Input[str]] = None,
                             desktop_pool_id: Optional[pulumi.Input[str]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             filters: Optional[pulumi.Input[Sequence[pulumi.Input[_desktops.GetDesktopPoolVolumesFilterArgs]]]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             state: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDesktopPoolVolumesResult]
    func GetDesktopPoolVolumes(ctx *Context, args *GetDesktopPoolVolumesArgs, opts ...InvokeOption) (*GetDesktopPoolVolumesResult, error)
func GetDesktopPoolVolumesOutput(ctx *Context, args *GetDesktopPoolVolumesOutputArgs, opts ...InvokeOption) GetDesktopPoolVolumesResultOutput

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

    public static class GetDesktopPoolVolumes 
{
    public static Task<GetDesktopPoolVolumesResult> InvokeAsync(GetDesktopPoolVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetDesktopPoolVolumesResult> Invoke(GetDesktopPoolVolumesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDesktopPoolVolumesResult> getDesktopPoolVolumes(GetDesktopPoolVolumesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Desktops/getDesktopPoolVolumes:getDesktopPoolVolumes
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment of the desktop pool.
    DesktopPoolId string
    The OCID of the desktop pool.
    AvailabilityDomain string
    The name of the availability domain.
    DisplayName string
    A filter to return only results with the given displayName.
    Filters List<GetDesktopPoolVolumesFilter>
    Id string
    A filter to return only results with the given OCID.
    State string
    A filter to return only results with the given lifecycleState.
    CompartmentId string
    The OCID of the compartment of the desktop pool.
    DesktopPoolId string
    The OCID of the desktop pool.
    AvailabilityDomain string
    The name of the availability domain.
    DisplayName string
    A filter to return only results with the given displayName.
    Filters []GetDesktopPoolVolumesFilter
    Id string
    A filter to return only results with the given OCID.
    State string
    A filter to return only results with the given lifecycleState.
    compartmentId String
    The OCID of the compartment of the desktop pool.
    desktopPoolId String
    The OCID of the desktop pool.
    availabilityDomain String
    The name of the availability domain.
    displayName String
    A filter to return only results with the given displayName.
    filters List<GetDesktopPoolVolumesFilter>
    id String
    A filter to return only results with the given OCID.
    state String
    A filter to return only results with the given lifecycleState.
    compartmentId string
    The OCID of the compartment of the desktop pool.
    desktopPoolId string
    The OCID of the desktop pool.
    availabilityDomain string
    The name of the availability domain.
    displayName string
    A filter to return only results with the given displayName.
    filters GetDesktopPoolVolumesFilter[]
    id string
    A filter to return only results with the given OCID.
    state string
    A filter to return only results with the given lifecycleState.
    compartment_id str
    The OCID of the compartment of the desktop pool.
    desktop_pool_id str
    The OCID of the desktop pool.
    availability_domain str
    The name of the availability domain.
    display_name str
    A filter to return only results with the given displayName.
    filters Sequence[desktops.GetDesktopPoolVolumesFilter]
    id str
    A filter to return only results with the given OCID.
    state str
    A filter to return only results with the given lifecycleState.
    compartmentId String
    The OCID of the compartment of the desktop pool.
    desktopPoolId String
    The OCID of the desktop pool.
    availabilityDomain String
    The name of the availability domain.
    displayName String
    A filter to return only results with the given displayName.
    filters List<Property Map>
    id String
    A filter to return only results with the given OCID.
    state String
    A filter to return only results with the given lifecycleState.

    getDesktopPoolVolumes Result

    The following output properties are available:

    CompartmentId string
    DesktopPoolId string
    DesktopPoolVolumeCollections List<GetDesktopPoolVolumesDesktopPoolVolumeCollection>
    The list of desktop_pool_volume_collection.
    AvailabilityDomain string
    The availability domain of the desktop pool.
    DisplayName string
    Filters List<GetDesktopPoolVolumesFilter>
    Id string
    The OCID of the desktop pool volume.
    State string
    The state of the desktop pool volume.
    CompartmentId string
    DesktopPoolId string
    DesktopPoolVolumeCollections []GetDesktopPoolVolumesDesktopPoolVolumeCollection
    The list of desktop_pool_volume_collection.
    AvailabilityDomain string
    The availability domain of the desktop pool.
    DisplayName string
    Filters []GetDesktopPoolVolumesFilter
    Id string
    The OCID of the desktop pool volume.
    State string
    The state of the desktop pool volume.
    compartmentId String
    desktopPoolId String
    desktopPoolVolumeCollections List<GetDesktopPoolVolumesDesktopPoolVolumeCollection>
    The list of desktop_pool_volume_collection.
    availabilityDomain String
    The availability domain of the desktop pool.
    displayName String
    filters List<GetDesktopPoolVolumesFilter>
    id String
    The OCID of the desktop pool volume.
    state String
    The state of the desktop pool volume.
    compartmentId string
    desktopPoolId string
    desktopPoolVolumeCollections GetDesktopPoolVolumesDesktopPoolVolumeCollection[]
    The list of desktop_pool_volume_collection.
    availabilityDomain string
    The availability domain of the desktop pool.
    displayName string
    filters GetDesktopPoolVolumesFilter[]
    id string
    The OCID of the desktop pool volume.
    state string
    The state of the desktop pool volume.
    compartment_id str
    desktop_pool_id str
    desktop_pool_volume_collections Sequence[desktops.GetDesktopPoolVolumesDesktopPoolVolumeCollection]
    The list of desktop_pool_volume_collection.
    availability_domain str
    The availability domain of the desktop pool.
    display_name str
    filters Sequence[desktops.GetDesktopPoolVolumesFilter]
    id str
    The OCID of the desktop pool volume.
    state str
    The state of the desktop pool volume.
    compartmentId String
    desktopPoolId String
    desktopPoolVolumeCollections List<Property Map>
    The list of desktop_pool_volume_collection.
    availabilityDomain String
    The availability domain of the desktop pool.
    displayName String
    filters List<Property Map>
    id String
    The OCID of the desktop pool volume.
    state String
    The state of the desktop pool volume.

    Supporting Types

    GetDesktopPoolVolumesDesktopPoolVolumeCollection

    items List<Property Map>
    A list of desktop pool volumes.

    GetDesktopPoolVolumesDesktopPoolVolumeCollectionItem

    AvailabilityDomain string
    The name of the availability domain.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    A filter to return only results with the given OCID.
    Name string
    The name of the desktop pool volume.
    PoolId string
    The OCID of the desktop pool to which this volume belongs.
    State string
    A filter to return only results with the given lifecycleState.
    UserName string
    The owner of the desktop pool volume.
    AvailabilityDomain string
    The name of the availability domain.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    A filter to return only results with the given OCID.
    Name string
    The name of the desktop pool volume.
    PoolId string
    The OCID of the desktop pool to which this volume belongs.
    State string
    A filter to return only results with the given lifecycleState.
    UserName string
    The owner of the desktop pool volume.
    availabilityDomain String
    The name of the availability domain.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    A filter to return only results with the given OCID.
    name String
    The name of the desktop pool volume.
    poolId String
    The OCID of the desktop pool to which this volume belongs.
    state String
    A filter to return only results with the given lifecycleState.
    userName String
    The owner of the desktop pool volume.
    availabilityDomain string
    The name of the availability domain.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    A filter to return only results with the given OCID.
    name string
    The name of the desktop pool volume.
    poolId string
    The OCID of the desktop pool to which this volume belongs.
    state string
    A filter to return only results with the given lifecycleState.
    userName string
    The owner of the desktop pool volume.
    availability_domain str
    The name of the availability domain.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    A filter to return only results with the given OCID.
    name str
    The name of the desktop pool volume.
    pool_id str
    The OCID of the desktop pool to which this volume belongs.
    state str
    A filter to return only results with the given lifecycleState.
    user_name str
    The owner of the desktop pool volume.
    availabilityDomain String
    The name of the availability domain.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    A filter to return only results with the given OCID.
    name String
    The name of the desktop pool volume.
    poolId String
    The OCID of the desktop pool to which this volume belongs.
    state String
    A filter to return only results with the given lifecycleState.
    userName String
    The owner of the desktop pool volume.

    GetDesktopPoolVolumesFilter

    Name string
    The name of the desktop pool volume.
    Values List<string>
    Regex bool
    Name string
    The name of the desktop pool volume.
    Values []string
    Regex bool
    name String
    The name of the desktop pool volume.
    values List<String>
    regex Boolean
    name string
    The name of the desktop pool volume.
    values string[]
    regex boolean
    name str
    The name of the desktop pool volume.
    values Sequence[str]
    regex bool
    name String
    The name of the desktop pool volume.
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci