Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Desktops
  5. getDesktopPools
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Desktops.getDesktopPools

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

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

    Returns a list of desktop pools within the given compartment. You can limit the results to an availability domain, pool name, or pool 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 testDesktopPools = oci.Desktops.getDesktopPools({
    compartmentId: compartmentId,
    availabilityDomain: desktopPoolAvailabilityDomain,
    displayName: desktopPoolDisplayName,
    id: desktopPoolId,
    state: desktopPoolState,
});

    import pulumi
import pulumi_oci as oci

test_desktop_pools = oci.Desktops.get_desktop_pools(compartment_id=compartment_id,
    availability_domain=desktop_pool_availability_domain,
    display_name=desktop_pool_display_name,
    id=desktop_pool_id,
    state=desktop_pool_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.GetDesktopPools(ctx, &desktops.GetDesktopPoolsArgs{
			CompartmentId:      compartmentId,
			AvailabilityDomain: pulumi.StringRef(desktopPoolAvailabilityDomain),
			DisplayName:        pulumi.StringRef(desktopPoolDisplayName),
			Id:                 pulumi.StringRef(desktopPoolId),
			State:              pulumi.StringRef(desktopPoolState),
		}, 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 testDesktopPools = Oci.Desktops.GetDesktopPools.Invoke(new()
    {
        CompartmentId = compartmentId,
        AvailabilityDomain = desktopPoolAvailabilityDomain,
        DisplayName = desktopPoolDisplayName,
        Id = desktopPoolId,
        State = desktopPoolState,
    });

});

    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.GetDesktopPoolsArgs;
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 testDesktopPools = DesktopsFunctions.getDesktopPools(GetDesktopPoolsArgs.builder()
            .compartmentId(compartmentId)
            .availabilityDomain(desktopPoolAvailabilityDomain)
            .displayName(desktopPoolDisplayName)
            .id(desktopPoolId)
            .state(desktopPoolState)
            .build());

    }
}

    variables:
  testDesktopPools:
    fn::invoke:
      Function: oci:Desktops:getDesktopPools
      Arguments:
        compartmentId: ${compartmentId}
        availabilityDomain: ${desktopPoolAvailabilityDomain}
        displayName: ${desktopPoolDisplayName}
        id: ${desktopPoolId}
        state: ${desktopPoolState}

    Using getDesktopPools

    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 getDesktopPools(args: GetDesktopPoolsArgs, opts?: InvokeOptions): Promise<GetDesktopPoolsResult>
function getDesktopPoolsOutput(args: GetDesktopPoolsOutputArgs, opts?: InvokeOptions): Output<GetDesktopPoolsResult>
    def get_desktop_pools(availability_domain: Optional[str] = None,
                      compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      filters: Optional[Sequence[_desktops.GetDesktopPoolsFilter]] = None,
                      id: Optional[str] = None,
                      state: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDesktopPoolsResult
def get_desktop_pools_output(availability_domain: Optional[pulumi.Input[str]] = None,
                      compartment_id: Optional[pulumi.Input[str]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_desktops.GetDesktopPoolsFilterArgs]]]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDesktopPoolsResult]
    func GetDesktopPools(ctx *Context, args *GetDesktopPoolsArgs, opts ...InvokeOption) (*GetDesktopPoolsResult, error)
func GetDesktopPoolsOutput(ctx *Context, args *GetDesktopPoolsOutputArgs, opts ...InvokeOption) GetDesktopPoolsResultOutput

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

    public static class GetDesktopPools 
{
    public static Task<GetDesktopPoolsResult> InvokeAsync(GetDesktopPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetDesktopPoolsResult> Invoke(GetDesktopPoolsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDesktopPoolsResult> getDesktopPools(GetDesktopPoolsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Desktops/getDesktopPools:getDesktopPools
  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.
    DisplayName string
    A filter to return only results with the given displayName.
    Filters List<GetDesktopPoolsFilter>
    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.
    DisplayName string
    A filter to return only results with the given displayName.
    Filters []GetDesktopPoolsFilter
    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.
    displayName String
    A filter to return only results with the given displayName.
    filters List<GetDesktopPoolsFilter>
    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.
    displayName string
    A filter to return only results with the given displayName.
    filters GetDesktopPoolsFilter[]
    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.
    display_name str
    A filter to return only results with the given displayName.
    filters Sequence[desktops.GetDesktopPoolsFilter]
    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.
    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.

    getDesktopPools Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment of the desktop pool.
    DesktopPoolCollections List<GetDesktopPoolsDesktopPoolCollection>
    The list of desktop_pool_collection.
    AvailabilityDomain string
    The availability domain of the desktop pool.
    DisplayName string
    A user friendly display name. Avoid entering confidential information.
    Filters List<GetDesktopPoolsFilter>
    Id string
    The OCID of the desktop pool.
    State string
    The current state of the desktop pool.
    CompartmentId string
    The OCID of the compartment of the desktop pool.
    DesktopPoolCollections []GetDesktopPoolsDesktopPoolCollection
    The list of desktop_pool_collection.
    AvailabilityDomain string
    The availability domain of the desktop pool.
    DisplayName string
    A user friendly display name. Avoid entering confidential information.
    Filters []GetDesktopPoolsFilter
    Id string
    The OCID of the desktop pool.
    State string
    The current state of the desktop pool.
    compartmentId String
    The OCID of the compartment of the desktop pool.
    desktopPoolCollections List<GetDesktopPoolsDesktopPoolCollection>
    The list of desktop_pool_collection.
    availabilityDomain String
    The availability domain of the desktop pool.
    displayName String
    A user friendly display name. Avoid entering confidential information.
    filters List<GetDesktopPoolsFilter>
    id String
    The OCID of the desktop pool.
    state String
    The current state of the desktop pool.
    compartmentId string
    The OCID of the compartment of the desktop pool.
    desktopPoolCollections GetDesktopPoolsDesktopPoolCollection[]
    The list of desktop_pool_collection.
    availabilityDomain string
    The availability domain of the desktop pool.
    displayName string
    A user friendly display name. Avoid entering confidential information.
    filters GetDesktopPoolsFilter[]
    id string
    The OCID of the desktop pool.
    state string
    The current state of the desktop pool.
    compartment_id str
    The OCID of the compartment of the desktop pool.
    desktop_pool_collections Sequence[desktops.GetDesktopPoolsDesktopPoolCollection]
    The list of desktop_pool_collection.
    availability_domain str
    The availability domain of the desktop pool.
    display_name str
    A user friendly display name. Avoid entering confidential information.
    filters Sequence[desktops.GetDesktopPoolsFilter]
    id str
    The OCID of the desktop pool.
    state str
    The current state of the desktop pool.
    compartmentId String
    The OCID of the compartment of the desktop pool.
    desktopPoolCollections List<Property Map>
    The list of desktop_pool_collection.
    availabilityDomain String
    The availability domain of the desktop pool.
    displayName String
    A user friendly display name. Avoid entering confidential information.
    filters List<Property Map>
    id String
    The OCID of the desktop pool.
    state String
    The current state of the desktop pool.

    Supporting Types

    GetDesktopPoolsDesktopPoolCollection

    GetDesktopPoolsDesktopPoolCollectionItem

    ActiveDesktops int
    The number of active desktops in the desktop pool.
    ArePrivilegedUsers bool
    Indicates whether desktop pool users have administrative privileges on their desktop.
    AvailabilityDomain string
    The name of the availability domain.
    AvailabilityPolicies List<GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy>
    Provides the start and stop schedule information for desktop availability of the desktop pool.
    CompartmentId string
    The OCID of the compartment of the desktop pool.
    ContactDetails string
    Contact information of the desktop pool administrator. Avoid entering confidential information.
    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"}
    Description string
    A user friendly description providing additional information about the resource. Avoid entering confidential information.
    DevicePolicies List<GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy>
    Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
    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.
    Images List<GetDesktopPoolsDesktopPoolCollectionItemImage>
    Provides information about the desktop image.
    IsStorageEnabled bool
    Indicates whether storage is enabled for the desktop pool.
    MaximumSize int
    The maximum number of desktops permitted in the desktop pool.
    NetworkConfigurations List<GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration>
    Provides information about the network configuration of the desktop pool.
    NsgIds List<string>
    A list of network security groups for the desktop pool.
    ShapeName string
    The shape of the desktop pool.
    StandbySize int
    The maximum number of standby desktops available in the desktop pool.
    State string
    A filter to return only results with the given lifecycleState.
    StorageBackupPolicyId string
    The backup policy OCID of the storage.
    StorageSizeInGbs int
    The size in GBs of the storage for the desktop pool.
    TimeCreated string
    The date and time the resource was created.
    TimeStartScheduled string
    The start time of the desktop pool.
    TimeStopScheduled string
    The stop time of the desktop pool.
    ActiveDesktops int
    The number of active desktops in the desktop pool.
    ArePrivilegedUsers bool
    Indicates whether desktop pool users have administrative privileges on their desktop.
    AvailabilityDomain string
    The name of the availability domain.
    AvailabilityPolicies []GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy
    Provides the start and stop schedule information for desktop availability of the desktop pool.
    CompartmentId string
    The OCID of the compartment of the desktop pool.
    ContactDetails string
    Contact information of the desktop pool administrator. Avoid entering confidential information.
    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"}
    Description string
    A user friendly description providing additional information about the resource. Avoid entering confidential information.
    DevicePolicies []GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy
    Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
    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.
    Images []GetDesktopPoolsDesktopPoolCollectionItemImage
    Provides information about the desktop image.
    IsStorageEnabled bool
    Indicates whether storage is enabled for the desktop pool.
    MaximumSize int
    The maximum number of desktops permitted in the desktop pool.
    NetworkConfigurations []GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration
    Provides information about the network configuration of the desktop pool.
    NsgIds []string
    A list of network security groups for the desktop pool.
    ShapeName string
    The shape of the desktop pool.
    StandbySize int
    The maximum number of standby desktops available in the desktop pool.
    State string
    A filter to return only results with the given lifecycleState.
    StorageBackupPolicyId string
    The backup policy OCID of the storage.
    StorageSizeInGbs int
    The size in GBs of the storage for the desktop pool.
    TimeCreated string
    The date and time the resource was created.
    TimeStartScheduled string
    The start time of the desktop pool.
    TimeStopScheduled string
    The stop time of the desktop pool.
    activeDesktops Integer
    The number of active desktops in the desktop pool.
    arePrivilegedUsers Boolean
    Indicates whether desktop pool users have administrative privileges on their desktop.
    availabilityDomain String
    The name of the availability domain.
    availabilityPolicies List<GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy>
    Provides the start and stop schedule information for desktop availability of the desktop pool.
    compartmentId String
    The OCID of the compartment of the desktop pool.
    contactDetails String
    Contact information of the desktop pool administrator. Avoid entering confidential information.
    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"}
    description String
    A user friendly description providing additional information about the resource. Avoid entering confidential information.
    devicePolicies List<GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy>
    Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
    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.
    images List<GetDesktopPoolsDesktopPoolCollectionItemImage>
    Provides information about the desktop image.
    isStorageEnabled Boolean
    Indicates whether storage is enabled for the desktop pool.
    maximumSize Integer
    The maximum number of desktops permitted in the desktop pool.
    networkConfigurations List<GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration>
    Provides information about the network configuration of the desktop pool.
    nsgIds List<String>
    A list of network security groups for the desktop pool.
    shapeName String
    The shape of the desktop pool.
    standbySize Integer
    The maximum number of standby desktops available in the desktop pool.
    state String
    A filter to return only results with the given lifecycleState.
    storageBackupPolicyId String
    The backup policy OCID of the storage.
    storageSizeInGbs Integer
    The size in GBs of the storage for the desktop pool.
    timeCreated String
    The date and time the resource was created.
    timeStartScheduled String
    The start time of the desktop pool.
    timeStopScheduled String
    The stop time of the desktop pool.
    activeDesktops number
    The number of active desktops in the desktop pool.
    arePrivilegedUsers boolean
    Indicates whether desktop pool users have administrative privileges on their desktop.
    availabilityDomain string
    The name of the availability domain.
    availabilityPolicies GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy[]
    Provides the start and stop schedule information for desktop availability of the desktop pool.
    compartmentId string
    The OCID of the compartment of the desktop pool.
    contactDetails string
    Contact information of the desktop pool administrator. Avoid entering confidential information.
    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"}
    description string
    A user friendly description providing additional information about the resource. Avoid entering confidential information.
    devicePolicies GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy[]
    Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
    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.
    images GetDesktopPoolsDesktopPoolCollectionItemImage[]
    Provides information about the desktop image.
    isStorageEnabled boolean
    Indicates whether storage is enabled for the desktop pool.
    maximumSize number
    The maximum number of desktops permitted in the desktop pool.
    networkConfigurations GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration[]
    Provides information about the network configuration of the desktop pool.
    nsgIds string[]
    A list of network security groups for the desktop pool.
    shapeName string
    The shape of the desktop pool.
    standbySize number
    The maximum number of standby desktops available in the desktop pool.
    state string
    A filter to return only results with the given lifecycleState.
    storageBackupPolicyId string
    The backup policy OCID of the storage.
    storageSizeInGbs number
    The size in GBs of the storage for the desktop pool.
    timeCreated string
    The date and time the resource was created.
    timeStartScheduled string
    The start time of the desktop pool.
    timeStopScheduled string
    The stop time of the desktop pool.
    active_desktops int
    The number of active desktops in the desktop pool.
    are_privileged_users bool
    Indicates whether desktop pool users have administrative privileges on their desktop.
    availability_domain str
    The name of the availability domain.
    availability_policies Sequence[desktops.GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy]
    Provides the start and stop schedule information for desktop availability of the desktop pool.
    compartment_id str
    The OCID of the compartment of the desktop pool.
    contact_details str
    Contact information of the desktop pool administrator. Avoid entering confidential information.
    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"}
    description str
    A user friendly description providing additional information about the resource. Avoid entering confidential information.
    device_policies Sequence[desktops.GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy]
    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 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.
    images Sequence[desktops.GetDesktopPoolsDesktopPoolCollectionItemImage]
    Provides information about the desktop image.
    is_storage_enabled bool
    Indicates whether storage is enabled for the desktop pool.
    maximum_size int
    The maximum number of desktops permitted in the desktop pool.
    network_configurations Sequence[desktops.GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration]
    Provides information about the network configuration of the desktop pool.
    nsg_ids Sequence[str]
    A list of network security groups for the desktop pool.
    shape_name str
    The shape of the desktop pool.
    standby_size int
    The maximum number of standby desktops available in the desktop pool.
    state str
    A filter to return only results with the given lifecycleState.
    storage_backup_policy_id str
    The backup policy OCID of the storage.
    storage_size_in_gbs int
    The size in GBs of the storage for the desktop pool.
    time_created str
    The date and time the resource was created.
    time_start_scheduled str
    The start time of the desktop pool.
    time_stop_scheduled str
    The stop time of the desktop pool.
    activeDesktops Number
    The number of active desktops in the desktop pool.
    arePrivilegedUsers Boolean
    Indicates whether desktop pool users have administrative privileges on their desktop.
    availabilityDomain String
    The name of the availability domain.
    availabilityPolicies List<Property Map>
    Provides the start and stop schedule information for desktop availability of the desktop pool.
    compartmentId String
    The OCID of the compartment of the desktop pool.
    contactDetails String
    Contact information of the desktop pool administrator. Avoid entering confidential information.
    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"}
    description String
    A user friendly description providing additional information about the resource. Avoid entering confidential information.
    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 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.
    images List<Property Map>
    Provides information about the desktop image.
    isStorageEnabled Boolean
    Indicates whether storage is enabled for the desktop pool.
    maximumSize Number
    The maximum number of desktops permitted in the desktop pool.
    networkConfigurations List<Property Map>
    Provides information about the network configuration of the desktop pool.
    nsgIds List<String>
    A list of network security groups for the desktop pool.
    shapeName String
    The shape of the desktop pool.
    standbySize Number
    The maximum number of standby desktops available in the desktop pool.
    state String
    A filter to return only results with the given lifecycleState.
    storageBackupPolicyId String
    The backup policy OCID of the storage.
    storageSizeInGbs Number
    The size in GBs of the storage for the desktop pool.
    timeCreated String
    The date and time the resource was created.
    timeStartScheduled String
    The start time of the desktop pool.
    timeStopScheduled String
    The stop time of the desktop pool.

    GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy

    startSchedules List<Property Map>
    Provides the schedule information for a desktop.
    stopSchedules List<Property Map>
    Provides the schedule information for a desktop.

    GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicyStartSchedule

    CronExpression string
    A cron expression describing the desktop's schedule.
    Timezone string
    The timezone of the desktop's schedule.
    CronExpression string
    A cron expression describing the desktop's schedule.
    Timezone string
    The timezone of the desktop's schedule.
    cronExpression String
    A cron expression describing the desktop's schedule.
    timezone String
    The timezone of the desktop's schedule.
    cronExpression string
    A cron expression describing the desktop's schedule.
    timezone string
    The timezone of the desktop's schedule.
    cron_expression str
    A cron expression describing the desktop's schedule.
    timezone str
    The timezone of the desktop's schedule.
    cronExpression String
    A cron expression describing the desktop's schedule.
    timezone String
    The timezone of the desktop's schedule.

    GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicyStopSchedule

    CronExpression string
    A cron expression describing the desktop's schedule.
    Timezone string
    The timezone of the desktop's schedule.
    CronExpression string
    A cron expression describing the desktop's schedule.
    Timezone string
    The timezone of the desktop's schedule.
    cronExpression String
    A cron expression describing the desktop's schedule.
    timezone String
    The timezone of the desktop's schedule.
    cronExpression string
    A cron expression describing the desktop's schedule.
    timezone string
    The timezone of the desktop's schedule.
    cron_expression str
    A cron expression describing the desktop's schedule.
    timezone str
    The timezone of the desktop's schedule.
    cronExpression String
    A cron expression describing the desktop's schedule.
    timezone String
    The timezone of the desktop's schedule.

    GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy

    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.

    GetDesktopPoolsDesktopPoolCollectionItemImage

    ImageId string
    The OCID of the desktop image.
    ImageName string
    The name of the desktop image.
    ImageId string
    The OCID of the desktop image.
    ImageName string
    The name of the desktop image.
    imageId String
    The OCID of the desktop image.
    imageName String
    The name of the desktop image.
    imageId string
    The OCID of the desktop image.
    imageName string
    The name of the desktop image.
    image_id str
    The OCID of the desktop image.
    image_name str
    The name of the desktop image.
    imageId String
    The OCID of the desktop image.
    imageName String
    The name of the desktop image.

    GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration

    SubnetId string
    The OCID of the subnet to use for the desktop pool.
    VcnId string
    The OCID of the VCN used by the desktop pool.
    SubnetId string
    The OCID of the subnet to use for the desktop pool.
    VcnId string
    The OCID of the VCN used by the desktop pool.
    subnetId String
    The OCID of the subnet to use for the desktop pool.
    vcnId String
    The OCID of the VCN used by the desktop pool.
    subnetId string
    The OCID of the subnet to use for the desktop pool.
    vcnId string
    The OCID of the VCN used by the desktop pool.
    subnet_id str
    The OCID of the subnet to use for the desktop pool.
    vcn_id str
    The OCID of the VCN used by the desktop pool.
    subnetId String
    The OCID of the subnet to use for the desktop pool.
    vcnId String
    The OCID of the VCN used by the desktop pool.

    GetDesktopPoolsFilter

    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.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci