Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Desktops.getDesktops

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Returns a list of desktops filtered by the specified parameters. You can limit the results to an availability domain, desktop name, desktop OCID, desktop state, pool OCID, or compartment OCID. 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 testDesktops = oci.Desktops.getDesktops({
    compartmentId: compartmentId,
    availabilityDomain: desktopAvailabilityDomain,
    desktopPoolId: testDesktopPool.id,
    displayName: desktopDisplayName,
    id: desktopId,
    state: desktopState,
});

import pulumi
import pulumi_oci as oci

test_desktops = oci.Desktops.get_desktops(compartment_id=compartment_id,
    availability_domain=desktop_availability_domain,
    desktop_pool_id=test_desktop_pool["id"],
    display_name=desktop_display_name,
    id=desktop_id,
    state=desktop_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.GetDesktops(ctx, &desktops.GetDesktopsArgs{
			CompartmentId:      compartmentId,
			AvailabilityDomain: pulumi.StringRef(desktopAvailabilityDomain),
			DesktopPoolId:      pulumi.StringRef(testDesktopPool.Id),
			DisplayName:        pulumi.StringRef(desktopDisplayName),
			Id:                 pulumi.StringRef(desktopId),
			State:              pulumi.StringRef(desktopState),
		}, 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 testDesktops = Oci.Desktops.GetDesktops.Invoke(new()
    {
        CompartmentId = compartmentId,
        AvailabilityDomain = desktopAvailabilityDomain,
        DesktopPoolId = testDesktopPool.Id,
        DisplayName = desktopDisplayName,
        Id = desktopId,
        State = desktopState,
    });

});

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.GetDesktopsArgs;
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 testDesktops = DesktopsFunctions.getDesktops(GetDesktopsArgs.builder()
            .compartmentId(compartmentId)
            .availabilityDomain(desktopAvailabilityDomain)
            .desktopPoolId(testDesktopPool.id())
            .displayName(desktopDisplayName)
            .id(desktopId)
            .state(desktopState)
            .build());

    }
}

variables:
  testDesktops:
    fn::invoke:
      function: oci:Desktops:getDesktops
      arguments:
        compartmentId: ${compartmentId}
        availabilityDomain: ${desktopAvailabilityDomain}
        desktopPoolId: ${testDesktopPool.id}
        displayName: ${desktopDisplayName}
        id: ${desktopId}
        state: ${desktopState}

Using getDesktops

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 getDesktops(args: GetDesktopsArgs, opts?: InvokeOptions): Promise<GetDesktopsResult>
function getDesktopsOutput(args: GetDesktopsOutputArgs, opts?: InvokeOptions): Output<GetDesktopsResult>

def get_desktops(availability_domain: Optional[str] = None,
                 compartment_id: Optional[str] = None,
                 desktop_pool_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[GetDesktopsFilter]] = None,
                 id: Optional[str] = None,
                 state: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDesktopsResult
def get_desktops_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[GetDesktopsFilterArgs]]]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDesktopsResult]

func GetDesktops(ctx *Context, args *GetDesktopsArgs, opts ...InvokeOption) (*GetDesktopsResult, error)
func GetDesktopsOutput(ctx *Context, args *GetDesktopsOutputArgs, opts ...InvokeOption) GetDesktopsResultOutput

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

public static class GetDesktops 
{
    public static Task<GetDesktopsResult> InvokeAsync(GetDesktopsArgs args, InvokeOptions? opts = null)
    public static Output<GetDesktopsResult> Invoke(GetDesktopsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDesktopsResult> getDesktops(GetDesktopsArgs args, InvokeOptions options)
public static Output<GetDesktopsResult> getDesktops(GetDesktopsArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: The OCID of the compartment of the desktop pool.
AvailabilityDomain string: The name of the availability domain.
DesktopPoolId string: The OCID of the desktop pool.
DisplayName string: A filter to return only results with the given displayName.
Filters List<GetDesktopsFilter>
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.
AvailabilityDomain string: The name of the availability domain.
DesktopPoolId string: The OCID of the desktop pool.
DisplayName string: A filter to return only results with the given displayName.
Filters []GetDesktopsFilter
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.
availabilityDomain String: The name of the availability domain.
desktopPoolId String: The OCID of the desktop pool.
displayName String: A filter to return only results with the given displayName.
filters List<GetFilter>
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.
availabilityDomain string: The name of the availability domain.
desktopPoolId string: The OCID of the desktop pool.
displayName string: A filter to return only results with the given displayName.
filters GetDesktopsFilter[]
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.
availability_domain str: The name of the availability domain.
desktop_pool_id str: The OCID of the desktop pool.
display_name str: A filter to return only results with the given displayName.
filters Sequence[GetDesktopsFilter]
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.
availabilityDomain String: The name of the availability domain.
desktopPoolId String: The OCID of the desktop pool.
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.

getDesktops Result

The following output properties are available:

CompartmentId string
DesktopCollections List<GetDesktopsDesktopCollection>: The list of desktop_collection.
AvailabilityDomain string
DesktopPoolId string
DisplayName string: A user friendly display name. Avoid entering confidential information.
Filters List<GetDesktopsFilter>
Id string: The OCID of the desktop.
State string: The state of the desktop.

CompartmentId string
DesktopCollections []GetDesktopsDesktopCollection: The list of desktop_collection.
AvailabilityDomain string
DesktopPoolId string
DisplayName string: A user friendly display name. Avoid entering confidential information.
Filters []GetDesktopsFilter
Id string: The OCID of the desktop.
State string: The state of the desktop.

compartmentId String
desktopCollections List<GetDesktopCollection>: The list of desktop_collection.
availabilityDomain String
desktopPoolId String
displayName String: A user friendly display name. Avoid entering confidential information.
filters List<GetFilter>
id String: The OCID of the desktop.
state String: The state of the desktop.

compartmentId string
desktopCollections GetDesktopsDesktopCollection[]: The list of desktop_collection.
availabilityDomain string
desktopPoolId string
displayName string: A user friendly display name. Avoid entering confidential information.
filters GetDesktopsFilter[]
id string: The OCID of the desktop.
state string: The state of the desktop.

compartment_id str
desktop_collections Sequence[GetDesktopsDesktopCollection]: The list of desktop_collection.
availability_domain str
desktop_pool_id str
display_name str: A user friendly display name. Avoid entering confidential information.
filters Sequence[GetDesktopsFilter]
id str: The OCID of the desktop.
state str: The state of the desktop.

compartmentId String
desktopCollections List<Property Map>: The list of desktop_collection.
availabilityDomain String
desktopPoolId String
displayName String: A user friendly display name. Avoid entering confidential information.
filters List<Property Map>
id String: The OCID of the desktop.
state String: The state of the desktop.

Supporting Types

GetDesktopsDesktopCollection

Items List<GetDesktopsDesktopCollectionItem>

Items []GetDesktopsDesktopCollectionItem

items List<GetDesktopCollectionItem>

items GetDesktopsDesktopCollectionItem[]

items Sequence[GetDesktopsDesktopCollectionItem]

items List<Property Map>

GetDesktopsDesktopCollectionItem

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"}
DisplayName string: A filter to return only results with the given displayName.
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.
PoolId string: The OCID of the desktop pool the desktop is a member of.
State string: A filter to return only results with the given lifecycleState.
TimeCreated string: The date and time the resource was created.
UserName string: The owner of the desktop.

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"}
DisplayName string: A filter to return only results with the given displayName.
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.
PoolId string: The OCID of the desktop pool the desktop is a member of.
State string: A filter to return only results with the given lifecycleState.
TimeCreated string: The date and time the resource was created.
UserName string: The owner of the desktop.

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"}
displayName String: A filter to return only results with the given displayName.
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.
poolId String: The OCID of the desktop pool the desktop is a member of.
state String: A filter to return only results with the given lifecycleState.
timeCreated String: The date and time the resource was created.
userName String: The owner of the desktop.

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"}
displayName string: A filter to return only results with the given displayName.
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.
poolId string: The OCID of the desktop pool the desktop is a member of.
state string: A filter to return only results with the given lifecycleState.
timeCreated string: The date and time the resource was created.
userName string: The owner of the desktop.

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"}
display_name str: A filter to return only results with the given displayName.
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.
pool_id str: The OCID of the desktop pool the desktop is a member of.
state str: A filter to return only results with the given lifecycleState.
time_created str: The date and time the resource was created.
user_name str: The owner of the desktop.

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"}
displayName String: A filter to return only results with the given displayName.
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.
poolId String: The OCID of the desktop pool the desktop is a member of.
state String: A filter to return only results with the given lifecycleState.
timeCreated String: The date and time the resource was created.
userName String: The owner of the desktop.

GetDesktopsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
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.

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Desktops.getDesktops

On this page

On this page

Example Usage

Using getDesktops

getDesktops Result

Supporting Types

GetDesktopsDesktopCollection

GetDesktopsDesktopCollectionItem

GetDesktopsFilter

Package Details

On this page

On this page