Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Desktops.getDesktop

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testDesktop = oci.Desktops.getDesktop({
    desktopId: testDesktopOciDesktopsDesktop.id,
});

import pulumi
import pulumi_oci as oci

test_desktop = oci.Desktops.get_desktop(desktop_id=test_desktop_oci_desktops_desktop["id"])

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.GetDesktop(ctx, &desktops.GetDesktopArgs{
			DesktopId: testDesktopOciDesktopsDesktop.Id,
		}, 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 testDesktop = Oci.Desktops.GetDesktop.Invoke(new()
    {
        DesktopId = testDesktopOciDesktopsDesktop.Id,
    });

});

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.GetDesktopArgs;
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 testDesktop = DesktopsFunctions.getDesktop(GetDesktopArgs.builder()
            .desktopId(testDesktopOciDesktopsDesktop.id())
            .build());

    }
}

variables:
  testDesktop:
    fn::invoke:
      function: oci:Desktops:getDesktop
      arguments:
        desktopId: ${testDesktopOciDesktopsDesktop.id}

Using getDesktop

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.

TypeScript
Python
Go
C#
Java
YAML

function getDesktop(args: GetDesktopArgs, opts?: InvokeOptions): Promise<GetDesktopResult>
function getDesktopOutput(args: GetDesktopOutputArgs, opts?: InvokeOptions): Output<GetDesktopResult>

def get_desktop(desktop_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDesktopResult
def get_desktop_output(desktop_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDesktopResult]

func GetDesktop(ctx *Context, args *GetDesktopArgs, opts ...InvokeOption) (*GetDesktopResult, error)
func GetDesktopOutput(ctx *Context, args *GetDesktopOutputArgs, opts ...InvokeOption) GetDesktopResultOutput

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

public static class GetDesktop 
{
    public static Task<GetDesktopResult> InvokeAsync(GetDesktopArgs args, InvokeOptions? opts = null)
    public static Output<GetDesktopResult> Invoke(GetDesktopInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDesktopResult> getDesktop(GetDesktopArgs args, InvokeOptions options)
public static Output<GetDesktopResult> getDesktop(GetDesktopArgs args, InvokeOptions options)

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

The following arguments are supported:

DesktopId string: The OCID of the desktop.

DesktopId string: The OCID of the desktop.

desktopId String: The OCID of the desktop.

desktopId string: The OCID of the desktop.

desktop_id str: The OCID of the desktop.

desktopId String: The OCID of the desktop.

getDesktop Result

The following output properties are available:

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"}
DesktopId string
DevicePolicies List<GetDesktopDevicePolicy>: Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
DisplayName string: A user friendly display name. Avoid entering confidential information.
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"}
HostingOptions List<GetDesktopHostingOption>: Provides information about where a desktop is hosted.
Id string: The provider-assigned unique ID for this managed resource.
PoolId string: The OCID of the desktop pool the desktop is a member of.
State string: The state of the desktop.
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"}
DesktopId string
DevicePolicies []GetDesktopDevicePolicy: Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
DisplayName string: A user friendly display name. Avoid entering confidential information.
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"}
HostingOptions []GetDesktopHostingOption: Provides information about where a desktop is hosted.
Id string: The provider-assigned unique ID for this managed resource.
PoolId string: The OCID of the desktop pool the desktop is a member of.
State string: The state of the desktop.
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"}
desktopId String
devicePolicies List<GetDesktopDevicePolicy>: Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
displayName String: A user friendly display name. Avoid entering confidential information.
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"}
hostingOptions List<GetDesktopHostingOption>: Provides information about where a desktop is hosted.
id String: The provider-assigned unique ID for this managed resource.
poolId String: The OCID of the desktop pool the desktop is a member of.
state String: The state of the desktop.
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"}
desktopId string
devicePolicies GetDesktopDevicePolicy[]: Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
displayName string: A user friendly display name. Avoid entering confidential information.
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"}
hostingOptions GetDesktopHostingOption[]: Provides information about where a desktop is hosted.
id string: The provider-assigned unique ID for this managed resource.
poolId string: The OCID of the desktop pool the desktop is a member of.
state string: The state of the desktop.
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"}
desktop_id str
device_policies Sequence[desktops.GetDesktopDevicePolicy]: Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
display_name str: A user friendly display name. Avoid entering confidential information.
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"}
hosting_options Sequence[desktops.GetDesktopHostingOption]: Provides information about where a desktop is hosted.
id str: The provider-assigned unique ID for this managed resource.
pool_id str: The OCID of the desktop pool the desktop is a member of.
state str: The state of the desktop.
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"}
desktopId String
devicePolicies List<Property Map>: Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
displayName String: A user friendly display name. Avoid entering confidential information.
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"}
hostingOptions List<Property Map>: Provides information about where a desktop is hosted.
id String: The provider-assigned unique ID for this managed resource.
poolId String: The OCID of the desktop pool the desktop is a member of.
state String: The state of the desktop.
timeCreated String: The date and time the resource was created.
userName String: The owner of the desktop.

Supporting Types

GetDesktopDevicePolicy

AudioMode string: The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
CdmMode string: The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
ClipboardMode string: The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
IsDisplayEnabled bool: Indicates whether the display is enabled.
IsKeyboardEnabled bool: Indicates whether the keyboard is enabled.
IsPointerEnabled bool: Indicates whether the pointer is enabled.
IsPrintingEnabled bool: Indicates whether printing is enabled.

AudioMode string: The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
CdmMode string: The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
ClipboardMode string: The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
IsDisplayEnabled bool: Indicates whether the display is enabled.
IsKeyboardEnabled bool: Indicates whether the keyboard is enabled.
IsPointerEnabled bool: Indicates whether the pointer is enabled.
IsPrintingEnabled bool: Indicates whether printing is enabled.

audioMode String: The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
cdmMode String: The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
clipboardMode String: The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
isDisplayEnabled Boolean: Indicates whether the display is enabled.
isKeyboardEnabled Boolean: Indicates whether the keyboard is enabled.
isPointerEnabled Boolean: Indicates whether the pointer is enabled.
isPrintingEnabled Boolean: Indicates whether printing is enabled.

audioMode string: The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
cdmMode string: The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
clipboardMode string: The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
isDisplayEnabled boolean: Indicates whether the display is enabled.
isKeyboardEnabled boolean: Indicates whether the keyboard is enabled.
isPointerEnabled boolean: Indicates whether the pointer is enabled.
isPrintingEnabled boolean: Indicates whether printing is enabled.

audio_mode str: The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
cdm_mode str: The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
clipboard_mode str: The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
is_display_enabled bool: Indicates whether the display is enabled.
is_keyboard_enabled bool: Indicates whether the keyboard is enabled.
is_pointer_enabled bool: Indicates whether the pointer is enabled.
is_printing_enabled bool: Indicates whether printing is enabled.

audioMode String: The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop.
cdmMode String: The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop.
clipboardMode String: The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop.
isDisplayEnabled Boolean: Indicates whether the display is enabled.
isKeyboardEnabled Boolean: Indicates whether the keyboard is enabled.
isPointerEnabled Boolean: Indicates whether the pointer is enabled.
isPrintingEnabled Boolean: Indicates whether printing is enabled.

GetDesktopHostingOption

ConnectAddress string: The connection address of the desktop.
Images List<GetDesktopHostingOptionImage>: Provides information about the desktop image.

ConnectAddress string: The connection address of the desktop.
Images []GetDesktopHostingOptionImage: Provides information about the desktop image.

connectAddress String: The connection address of the desktop.
images List<GetDesktopHostingOptionImage>: Provides information about the desktop image.

connectAddress string: The connection address of the desktop.
images GetDesktopHostingOptionImage[]: Provides information about the desktop image.

connect_address str: The connection address of the desktop.
images Sequence[desktops.GetDesktopHostingOptionImage]: Provides information about the desktop image.

connectAddress String: The connection address of the desktop.
images List<Property Map>: Provides information about the desktop image.

GetDesktopHostingOptionImage

ImageId string: The OCID of the desktop image.
ImageName string: The name of the desktop image.
OperatingSystem string: The operating system of the desktop image, e.g. "Oracle Linux", "Windows".

ImageId string: The OCID of the desktop image.
ImageName string: The name of the desktop image.
OperatingSystem string: The operating system of the desktop image, e.g. "Oracle Linux", "Windows".

imageId String: The OCID of the desktop image.
imageName String: The name of the desktop image.
operatingSystem String: The operating system of the desktop image, e.g. "Oracle Linux", "Windows".

imageId string: The OCID of the desktop image.
imageName string: The name of the desktop image.
operatingSystem string: The operating system of the desktop image, e.g. "Oracle Linux", "Windows".

image_id str: The OCID of the desktop image.
image_name str: The name of the desktop image.
operating_system str: The operating system of the desktop image, e.g. "Oracle Linux", "Windows".

imageId String: The OCID of the desktop image.
imageName String: The name of the desktop image.
operatingSystem String: The operating system of the desktop image, e.g. "Oracle Linux", "Windows".

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Desktops.getDesktop

On this page

On this page

Example Usage

Using getDesktop

getDesktop Result

Supporting Types

GetDesktopDevicePolicy

GetDesktopHostingOption

GetDesktopHostingOptionImage

Package Details

On this page

On this page