oci.Desktops.DesktopPool
Explore with Pulumi AI
This resource provides the Desktop Pool resource in Oracle Cloud Infrastructure Desktops service.
Creates a desktop pool with the given configuration parameters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDesktopPool = new oci.desktops.DesktopPool("test_desktop_pool", {
arePrivilegedUsers: desktopPoolArePrivilegedUsers,
availabilityDomain: desktopPoolAvailabilityDomain,
availabilityPolicy: {
startSchedule: {
cronExpression: "0 10 8 ? * 2",
timezone: "America/Denver",
},
stopSchedule: {
cronExpression: "0 20 18 ? * 6",
timezone: "America/Denver",
},
},
compartmentId: compartmentId,
contactDetails: desktopPoolContactDetails,
devicePolicy: {
audioMode: desktopPoolDevicePolicyAudioMode,
cdmMode: desktopPoolDevicePolicyCdmMode,
clipboardMode: desktopPoolDevicePolicyClipboardMode,
isDisplayEnabled: desktopPoolDevicePolicyIsDisplayEnabled,
isKeyboardEnabled: desktopPoolDevicePolicyIsKeyboardEnabled,
isPointerEnabled: desktopPoolDevicePolicyIsPointerEnabled,
isPrintingEnabled: desktopPoolDevicePolicyIsPrintingEnabled,
},
displayName: desktopPoolDisplayName,
image: {
imageId: testImage.id,
imageName: desktopPoolImageImageName,
},
isStorageEnabled: desktopPoolIsStorageEnabled,
maximumSize: desktopPoolMaximumSize,
networkConfiguration: {
subnetId: testSubnet.id,
vcnId: testVcn.id,
},
shapeName: "VM.Standard.E4.Flex",
standbySize: desktopPoolStandbySize,
storageBackupPolicyId: "ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz",
storageSizeInGbs: desktopPoolStorageSizeInGbs,
definedTags: {
"Operations.CostCenter": "42",
},
description: desktopPoolDescription,
freeformTags: {
Department: "Finance",
},
nsgIds: desktopPoolNsgIds,
timeStartScheduled: desktopPoolTimeStartScheduled,
timeStopScheduled: desktopPoolTimeStopScheduled,
});
import pulumi
import pulumi_oci as oci
test_desktop_pool = oci.desktops.DesktopPool("test_desktop_pool",
are_privileged_users=desktop_pool_are_privileged_users,
availability_domain=desktop_pool_availability_domain,
availability_policy={
"start_schedule": {
"cron_expression": "0 10 8 ? * 2",
"timezone": "America/Denver",
},
"stop_schedule": {
"cron_expression": "0 20 18 ? * 6",
"timezone": "America/Denver",
},
},
compartment_id=compartment_id,
contact_details=desktop_pool_contact_details,
device_policy={
"audio_mode": desktop_pool_device_policy_audio_mode,
"cdm_mode": desktop_pool_device_policy_cdm_mode,
"clipboard_mode": desktop_pool_device_policy_clipboard_mode,
"is_display_enabled": desktop_pool_device_policy_is_display_enabled,
"is_keyboard_enabled": desktop_pool_device_policy_is_keyboard_enabled,
"is_pointer_enabled": desktop_pool_device_policy_is_pointer_enabled,
"is_printing_enabled": desktop_pool_device_policy_is_printing_enabled,
},
display_name=desktop_pool_display_name,
image={
"image_id": test_image["id"],
"image_name": desktop_pool_image_image_name,
},
is_storage_enabled=desktop_pool_is_storage_enabled,
maximum_size=desktop_pool_maximum_size,
network_configuration={
"subnet_id": test_subnet["id"],
"vcn_id": test_vcn["id"],
},
shape_name="VM.Standard.E4.Flex",
standby_size=desktop_pool_standby_size,
storage_backup_policy_id="ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz",
storage_size_in_gbs=desktop_pool_storage_size_in_gbs,
defined_tags={
"Operations.CostCenter": "42",
},
description=desktop_pool_description,
freeform_tags={
"Department": "Finance",
},
nsg_ids=desktop_pool_nsg_ids,
time_start_scheduled=desktop_pool_time_start_scheduled,
time_stop_scheduled=desktop_pool_time_stop_scheduled)
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.NewDesktopPool(ctx, "test_desktop_pool", &Desktops.DesktopPoolArgs{
ArePrivilegedUsers: pulumi.Any(desktopPoolArePrivilegedUsers),
AvailabilityDomain: pulumi.Any(desktopPoolAvailabilityDomain),
AvailabilityPolicy: &desktops.DesktopPoolAvailabilityPolicyArgs{
StartSchedule: &desktops.DesktopPoolAvailabilityPolicyStartScheduleArgs{
CronExpression: pulumi.String("0 10 8 ? * 2"),
Timezone: pulumi.String("America/Denver"),
},
StopSchedule: &desktops.DesktopPoolAvailabilityPolicyStopScheduleArgs{
CronExpression: pulumi.String("0 20 18 ? * 6"),
Timezone: pulumi.String("America/Denver"),
},
},
CompartmentId: pulumi.Any(compartmentId),
ContactDetails: pulumi.Any(desktopPoolContactDetails),
DevicePolicy: &desktops.DesktopPoolDevicePolicyArgs{
AudioMode: pulumi.Any(desktopPoolDevicePolicyAudioMode),
CdmMode: pulumi.Any(desktopPoolDevicePolicyCdmMode),
ClipboardMode: pulumi.Any(desktopPoolDevicePolicyClipboardMode),
IsDisplayEnabled: pulumi.Any(desktopPoolDevicePolicyIsDisplayEnabled),
IsKeyboardEnabled: pulumi.Any(desktopPoolDevicePolicyIsKeyboardEnabled),
IsPointerEnabled: pulumi.Any(desktopPoolDevicePolicyIsPointerEnabled),
IsPrintingEnabled: pulumi.Any(desktopPoolDevicePolicyIsPrintingEnabled),
},
DisplayName: pulumi.Any(desktopPoolDisplayName),
Image: &desktops.DesktopPoolImageArgs{
ImageId: pulumi.Any(testImage.Id),
ImageName: pulumi.Any(desktopPoolImageImageName),
},
IsStorageEnabled: pulumi.Any(desktopPoolIsStorageEnabled),
MaximumSize: pulumi.Any(desktopPoolMaximumSize),
NetworkConfiguration: &desktops.DesktopPoolNetworkConfigurationArgs{
SubnetId: pulumi.Any(testSubnet.Id),
VcnId: pulumi.Any(testVcn.Id),
},
ShapeName: pulumi.String("VM.Standard.E4.Flex"),
StandbySize: pulumi.Any(desktopPoolStandbySize),
StorageBackupPolicyId: pulumi.String("ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz"),
StorageSizeInGbs: pulumi.Any(desktopPoolStorageSizeInGbs),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
Description: pulumi.Any(desktopPoolDescription),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
NsgIds: pulumi.Any(desktopPoolNsgIds),
TimeStartScheduled: pulumi.Any(desktopPoolTimeStartScheduled),
TimeStopScheduled: pulumi.Any(desktopPoolTimeStopScheduled),
})
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 testDesktopPool = new Oci.Desktops.DesktopPool("test_desktop_pool", new()
{
ArePrivilegedUsers = desktopPoolArePrivilegedUsers,
AvailabilityDomain = desktopPoolAvailabilityDomain,
AvailabilityPolicy = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyArgs
{
StartSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStartScheduleArgs
{
CronExpression = "0 10 8 ? * 2",
Timezone = "America/Denver",
},
StopSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStopScheduleArgs
{
CronExpression = "0 20 18 ? * 6",
Timezone = "America/Denver",
},
},
CompartmentId = compartmentId,
ContactDetails = desktopPoolContactDetails,
DevicePolicy = new Oci.Desktops.Inputs.DesktopPoolDevicePolicyArgs
{
AudioMode = desktopPoolDevicePolicyAudioMode,
CdmMode = desktopPoolDevicePolicyCdmMode,
ClipboardMode = desktopPoolDevicePolicyClipboardMode,
IsDisplayEnabled = desktopPoolDevicePolicyIsDisplayEnabled,
IsKeyboardEnabled = desktopPoolDevicePolicyIsKeyboardEnabled,
IsPointerEnabled = desktopPoolDevicePolicyIsPointerEnabled,
IsPrintingEnabled = desktopPoolDevicePolicyIsPrintingEnabled,
},
DisplayName = desktopPoolDisplayName,
Image = new Oci.Desktops.Inputs.DesktopPoolImageArgs
{
ImageId = testImage.Id,
ImageName = desktopPoolImageImageName,
},
IsStorageEnabled = desktopPoolIsStorageEnabled,
MaximumSize = desktopPoolMaximumSize,
NetworkConfiguration = new Oci.Desktops.Inputs.DesktopPoolNetworkConfigurationArgs
{
SubnetId = testSubnet.Id,
VcnId = testVcn.Id,
},
ShapeName = "VM.Standard.E4.Flex",
StandbySize = desktopPoolStandbySize,
StorageBackupPolicyId = "ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz",
StorageSizeInGbs = desktopPoolStorageSizeInGbs,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
Description = desktopPoolDescription,
FreeformTags =
{
{ "Department", "Finance" },
},
NsgIds = desktopPoolNsgIds,
TimeStartScheduled = desktopPoolTimeStartScheduled,
TimeStopScheduled = desktopPoolTimeStopScheduled,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Desktops.DesktopPool;
import com.pulumi.oci.Desktops.DesktopPoolArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolAvailabilityPolicyArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolAvailabilityPolicyStartScheduleArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolAvailabilityPolicyStopScheduleArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolDevicePolicyArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolImageArgs;
import com.pulumi.oci.Desktops.inputs.DesktopPoolNetworkConfigurationArgs;
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) {
var testDesktopPool = new DesktopPool("testDesktopPool", DesktopPoolArgs.builder()
.arePrivilegedUsers(desktopPoolArePrivilegedUsers)
.availabilityDomain(desktopPoolAvailabilityDomain)
.availabilityPolicy(DesktopPoolAvailabilityPolicyArgs.builder()
.startSchedule(DesktopPoolAvailabilityPolicyStartScheduleArgs.builder()
.cronExpression("0 10 8 ? * 2")
.timezone("America/Denver")
.build())
.stopSchedule(DesktopPoolAvailabilityPolicyStopScheduleArgs.builder()
.cronExpression("0 20 18 ? * 6")
.timezone("America/Denver")
.build())
.build())
.compartmentId(compartmentId)
.contactDetails(desktopPoolContactDetails)
.devicePolicy(DesktopPoolDevicePolicyArgs.builder()
.audioMode(desktopPoolDevicePolicyAudioMode)
.cdmMode(desktopPoolDevicePolicyCdmMode)
.clipboardMode(desktopPoolDevicePolicyClipboardMode)
.isDisplayEnabled(desktopPoolDevicePolicyIsDisplayEnabled)
.isKeyboardEnabled(desktopPoolDevicePolicyIsKeyboardEnabled)
.isPointerEnabled(desktopPoolDevicePolicyIsPointerEnabled)
.isPrintingEnabled(desktopPoolDevicePolicyIsPrintingEnabled)
.build())
.displayName(desktopPoolDisplayName)
.image(DesktopPoolImageArgs.builder()
.imageId(testImage.id())
.imageName(desktopPoolImageImageName)
.build())
.isStorageEnabled(desktopPoolIsStorageEnabled)
.maximumSize(desktopPoolMaximumSize)
.networkConfiguration(DesktopPoolNetworkConfigurationArgs.builder()
.subnetId(testSubnet.id())
.vcnId(testVcn.id())
.build())
.shapeName("VM.Standard.E4.Flex")
.standbySize(desktopPoolStandbySize)
.storageBackupPolicyId("ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz")
.storageSizeInGbs(desktopPoolStorageSizeInGbs)
.definedTags(Map.of("Operations.CostCenter", "42"))
.description(desktopPoolDescription)
.freeformTags(Map.of("Department", "Finance"))
.nsgIds(desktopPoolNsgIds)
.timeStartScheduled(desktopPoolTimeStartScheduled)
.timeStopScheduled(desktopPoolTimeStopScheduled)
.build());
}
}
resources:
testDesktopPool:
type: oci:Desktops:DesktopPool
name: test_desktop_pool
properties:
arePrivilegedUsers: ${desktopPoolArePrivilegedUsers}
availabilityDomain: ${desktopPoolAvailabilityDomain}
availabilityPolicy:
startSchedule:
cronExpression: 0 10 8 ? * 2
timezone: America/Denver
stopSchedule:
cronExpression: 0 20 18 ? * 6
timezone: America/Denver
compartmentId: ${compartmentId}
contactDetails: ${desktopPoolContactDetails}
devicePolicy:
audioMode: ${desktopPoolDevicePolicyAudioMode}
cdmMode: ${desktopPoolDevicePolicyCdmMode}
clipboardMode: ${desktopPoolDevicePolicyClipboardMode}
isDisplayEnabled: ${desktopPoolDevicePolicyIsDisplayEnabled}
isKeyboardEnabled: ${desktopPoolDevicePolicyIsKeyboardEnabled}
isPointerEnabled: ${desktopPoolDevicePolicyIsPointerEnabled}
isPrintingEnabled: ${desktopPoolDevicePolicyIsPrintingEnabled}
displayName: ${desktopPoolDisplayName}
image:
imageId: ${testImage.id}
imageName: ${desktopPoolImageImageName}
isStorageEnabled: ${desktopPoolIsStorageEnabled}
maximumSize: ${desktopPoolMaximumSize}
networkConfiguration:
subnetId: ${testSubnet.id}
vcnId: ${testVcn.id}
shapeName: VM.Standard.E4.Flex
standbySize: ${desktopPoolStandbySize}
storageBackupPolicyId: ocid1.volumebackuppolicy.oc1.xxxxyyyyyzzzz
storageSizeInGbs: ${desktopPoolStorageSizeInGbs}
definedTags:
Operations.CostCenter: '42'
description: ${desktopPoolDescription}
freeformTags:
Department: Finance
nsgIds: ${desktopPoolNsgIds}
timeStartScheduled: ${desktopPoolTimeStartScheduled}
timeStopScheduled: ${desktopPoolTimeStopScheduled}
Create DesktopPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DesktopPool(name: string, args: DesktopPoolArgs, opts?: CustomResourceOptions);
@overload
def DesktopPool(resource_name: str,
args: DesktopPoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DesktopPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
shape_name: Optional[str] = None,
standby_size: Optional[int] = None,
image: Optional[_desktops.DesktopPoolImageArgs] = None,
maximum_size: Optional[int] = None,
is_storage_enabled: Optional[bool] = None,
storage_size_in_gbs: Optional[int] = None,
storage_backup_policy_id: Optional[str] = None,
device_policy: Optional[_desktops.DesktopPoolDevicePolicyArgs] = None,
display_name: Optional[str] = None,
availability_domain: Optional[str] = None,
availability_policy: Optional[_desktops.DesktopPoolAvailabilityPolicyArgs] = None,
contact_details: Optional[str] = None,
compartment_id: Optional[str] = None,
network_configuration: Optional[_desktops.DesktopPoolNetworkConfigurationArgs] = None,
are_privileged_users: Optional[bool] = None,
nsg_ids: Optional[Sequence[str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
time_start_scheduled: Optional[str] = None,
time_stop_scheduled: Optional[str] = None)
func NewDesktopPool(ctx *Context, name string, args DesktopPoolArgs, opts ...ResourceOption) (*DesktopPool, error)
public DesktopPool(string name, DesktopPoolArgs args, CustomResourceOptions? opts = null)
public DesktopPool(String name, DesktopPoolArgs args)
public DesktopPool(String name, DesktopPoolArgs args, CustomResourceOptions options)
type: oci:Desktops:DesktopPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DesktopPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var desktopPoolResource = new Oci.Desktops.DesktopPool("desktopPoolResource", new()
{
ShapeName = "string",
StandbySize = 0,
Image = new Oci.Desktops.Inputs.DesktopPoolImageArgs
{
ImageId = "string",
ImageName = "string",
},
MaximumSize = 0,
IsStorageEnabled = false,
StorageSizeInGbs = 0,
StorageBackupPolicyId = "string",
DevicePolicy = new Oci.Desktops.Inputs.DesktopPoolDevicePolicyArgs
{
AudioMode = "string",
CdmMode = "string",
ClipboardMode = "string",
IsDisplayEnabled = false,
IsKeyboardEnabled = false,
IsPointerEnabled = false,
IsPrintingEnabled = false,
},
DisplayName = "string",
AvailabilityDomain = "string",
AvailabilityPolicy = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyArgs
{
StartSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStartScheduleArgs
{
CronExpression = "string",
Timezone = "string",
},
StopSchedule = new Oci.Desktops.Inputs.DesktopPoolAvailabilityPolicyStopScheduleArgs
{
CronExpression = "string",
Timezone = "string",
},
},
ContactDetails = "string",
CompartmentId = "string",
NetworkConfiguration = new Oci.Desktops.Inputs.DesktopPoolNetworkConfigurationArgs
{
SubnetId = "string",
VcnId = "string",
},
ArePrivilegedUsers = false,
NsgIds = new[]
{
"string",
},
FreeformTags =
{
{ "string", "string" },
},
Description = "string",
DefinedTags =
{
{ "string", "string" },
},
TimeStartScheduled = "string",
TimeStopScheduled = "string",
});
example, err := Desktops.NewDesktopPool(ctx, "desktopPoolResource", &Desktops.DesktopPoolArgs{
ShapeName: pulumi.String("string"),
StandbySize: pulumi.Int(0),
Image: &desktops.DesktopPoolImageArgs{
ImageId: pulumi.String("string"),
ImageName: pulumi.String("string"),
},
MaximumSize: pulumi.Int(0),
IsStorageEnabled: pulumi.Bool(false),
StorageSizeInGbs: pulumi.Int(0),
StorageBackupPolicyId: pulumi.String("string"),
DevicePolicy: &desktops.DesktopPoolDevicePolicyArgs{
AudioMode: pulumi.String("string"),
CdmMode: pulumi.String("string"),
ClipboardMode: pulumi.String("string"),
IsDisplayEnabled: pulumi.Bool(false),
IsKeyboardEnabled: pulumi.Bool(false),
IsPointerEnabled: pulumi.Bool(false),
IsPrintingEnabled: pulumi.Bool(false),
},
DisplayName: pulumi.String("string"),
AvailabilityDomain: pulumi.String("string"),
AvailabilityPolicy: &desktops.DesktopPoolAvailabilityPolicyArgs{
StartSchedule: &desktops.DesktopPoolAvailabilityPolicyStartScheduleArgs{
CronExpression: pulumi.String("string"),
Timezone: pulumi.String("string"),
},
StopSchedule: &desktops.DesktopPoolAvailabilityPolicyStopScheduleArgs{
CronExpression: pulumi.String("string"),
Timezone: pulumi.String("string"),
},
},
ContactDetails: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
NetworkConfiguration: &desktops.DesktopPoolNetworkConfigurationArgs{
SubnetId: pulumi.String("string"),
VcnId: pulumi.String("string"),
},
ArePrivilegedUsers: pulumi.Bool(false),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TimeStartScheduled: pulumi.String("string"),
TimeStopScheduled: pulumi.String("string"),
})
var desktopPoolResource = new DesktopPool("desktopPoolResource", DesktopPoolArgs.builder()
.shapeName("string")
.standbySize(0)
.image(DesktopPoolImageArgs.builder()
.imageId("string")
.imageName("string")
.build())
.maximumSize(0)
.isStorageEnabled(false)
.storageSizeInGbs(0)
.storageBackupPolicyId("string")
.devicePolicy(DesktopPoolDevicePolicyArgs.builder()
.audioMode("string")
.cdmMode("string")
.clipboardMode("string")
.isDisplayEnabled(false)
.isKeyboardEnabled(false)
.isPointerEnabled(false)
.isPrintingEnabled(false)
.build())
.displayName("string")
.availabilityDomain("string")
.availabilityPolicy(DesktopPoolAvailabilityPolicyArgs.builder()
.startSchedule(DesktopPoolAvailabilityPolicyStartScheduleArgs.builder()
.cronExpression("string")
.timezone("string")
.build())
.stopSchedule(DesktopPoolAvailabilityPolicyStopScheduleArgs.builder()
.cronExpression("string")
.timezone("string")
.build())
.build())
.contactDetails("string")
.compartmentId("string")
.networkConfiguration(DesktopPoolNetworkConfigurationArgs.builder()
.subnetId("string")
.vcnId("string")
.build())
.arePrivilegedUsers(false)
.nsgIds("string")
.freeformTags(Map.of("string", "string"))
.description("string")
.definedTags(Map.of("string", "string"))
.timeStartScheduled("string")
.timeStopScheduled("string")
.build());
desktop_pool_resource = oci.desktops.DesktopPool("desktopPoolResource",
shape_name="string",
standby_size=0,
image=oci.desktops.DesktopPoolImageArgs(
image_id="string",
image_name="string",
),
maximum_size=0,
is_storage_enabled=False,
storage_size_in_gbs=0,
storage_backup_policy_id="string",
device_policy=oci.desktops.DesktopPoolDevicePolicyArgs(
audio_mode="string",
cdm_mode="string",
clipboard_mode="string",
is_display_enabled=False,
is_keyboard_enabled=False,
is_pointer_enabled=False,
is_printing_enabled=False,
),
display_name="string",
availability_domain="string",
availability_policy=oci.desktops.DesktopPoolAvailabilityPolicyArgs(
start_schedule=oci.desktops.DesktopPoolAvailabilityPolicyStartScheduleArgs(
cron_expression="string",
timezone="string",
),
stop_schedule=oci.desktops.DesktopPoolAvailabilityPolicyStopScheduleArgs(
cron_expression="string",
timezone="string",
),
),
contact_details="string",
compartment_id="string",
network_configuration=oci.desktops.DesktopPoolNetworkConfigurationArgs(
subnet_id="string",
vcn_id="string",
),
are_privileged_users=False,
nsg_ids=["string"],
freeform_tags={
"string": "string",
},
description="string",
defined_tags={
"string": "string",
},
time_start_scheduled="string",
time_stop_scheduled="string")
const desktopPoolResource = new oci.desktops.DesktopPool("desktopPoolResource", {
shapeName: "string",
standbySize: 0,
image: {
imageId: "string",
imageName: "string",
},
maximumSize: 0,
isStorageEnabled: false,
storageSizeInGbs: 0,
storageBackupPolicyId: "string",
devicePolicy: {
audioMode: "string",
cdmMode: "string",
clipboardMode: "string",
isDisplayEnabled: false,
isKeyboardEnabled: false,
isPointerEnabled: false,
isPrintingEnabled: false,
},
displayName: "string",
availabilityDomain: "string",
availabilityPolicy: {
startSchedule: {
cronExpression: "string",
timezone: "string",
},
stopSchedule: {
cronExpression: "string",
timezone: "string",
},
},
contactDetails: "string",
compartmentId: "string",
networkConfiguration: {
subnetId: "string",
vcnId: "string",
},
arePrivilegedUsers: false,
nsgIds: ["string"],
freeformTags: {
string: "string",
},
description: "string",
definedTags: {
string: "string",
},
timeStartScheduled: "string",
timeStopScheduled: "string",
});
type: oci:Desktops:DesktopPool
properties:
arePrivilegedUsers: false
availabilityDomain: string
availabilityPolicy:
startSchedule:
cronExpression: string
timezone: string
stopSchedule:
cronExpression: string
timezone: string
compartmentId: string
contactDetails: string
definedTags:
string: string
description: string
devicePolicy:
audioMode: string
cdmMode: string
clipboardMode: string
isDisplayEnabled: false
isKeyboardEnabled: false
isPointerEnabled: false
isPrintingEnabled: false
displayName: string
freeformTags:
string: string
image:
imageId: string
imageName: string
isStorageEnabled: false
maximumSize: 0
networkConfiguration:
subnetId: string
vcnId: string
nsgIds:
- string
shapeName: string
standbySize: 0
storageBackupPolicyId: string
storageSizeInGbs: 0
timeStartScheduled: string
timeStopScheduled: string
DesktopPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DesktopPool resource accepts the following input properties:
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- Image
Desktop
Pool Image - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- Nsg
Ids List<string> - A list of network security groups for the desktop pool.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- Image
Desktop
Pool Image Args - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- map[string]string
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- Nsg
Ids []string - A list of network security groups for the desktop pool.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Integer - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Integer - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size IntegerIn Gbs - The size in GBs of the storage for the desktop pool.
- Map<String,String>
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- nsg
Ids List<String> - A list of network security groups for the desktop pool.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- are
Privileged booleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain string - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage booleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- shape
Name string - The shape of the desktop pool.
- standby
Size number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- storage
Size numberIn Gbs - The size in GBs of the storage for the desktop pool.
- {[key: string]: string}
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- nsg
Ids string[] - A list of network security groups for the desktop pool.
- time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop stringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- are_
privileged_ boolusers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability_
domain str - The availability domain of the desktop pool.
- availability_
policy desktops.Desktop Pool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment_
id str - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact_
details str - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device_
policy desktops.Desktop Pool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display_
name str - (Updatable) A user friendly display name. Avoid entering confidential information.
- image
desktops.
Desktop Pool Image Args - Provides information about the desktop image.
- is_
storage_ boolenabled - Indicates whether storage is enabled for the desktop pool.
- maximum_
size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network_
configuration desktops.Desktop Pool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- shape_
name str - The shape of the desktop pool.
- standby_
size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage_
backup_ strpolicy_ id - The backup policy OCID of the storage.
- storage_
size_ intin_ gbs - The size in GBs of the storage for the desktop pool.
- Mapping[str, str]
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- nsg_
ids Sequence[str] - A list of network security groups for the desktop pool.
- time_
start_ strscheduled - (Updatable) The start time of the desktop pool.
- time_
stop_ strscheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy Property Map - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- device
Policy Property Map - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- image Property Map
- Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration Property Map - Provides information about the network configuration of the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size NumberIn Gbs - The size in GBs of the storage for the desktop pool.
- Map<String>
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
- nsg
Ids List<String> - A list of network security groups for the desktop pool.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the DesktopPool resource produces the following output properties:
- Active
Desktops int - The number of active desktops in the desktop pool.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the desktop pool.
- Time
Created string - The date and time the resource was created.
- Active
Desktops int - The number of active desktops in the desktop pool.
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The current state of the desktop pool.
- Time
Created string - The date and time the resource was created.
- active
Desktops Integer - The number of active desktops in the desktop pool.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the desktop pool.
- time
Created String - The date and time the resource was created.
- active
Desktops number - The number of active desktops in the desktop pool.
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The current state of the desktop pool.
- time
Created string - The date and time the resource was created.
- active_
desktops int - The number of active desktops in the desktop pool.
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The current state of the desktop pool.
- time_
created str - The date and time the resource was created.
- active
Desktops Number - The number of active desktops in the desktop pool.
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The current state of the desktop pool.
- time
Created String - The date and time the resource was created.
Look up Existing DesktopPool Resource
Get an existing DesktopPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DesktopPoolState, opts?: CustomResourceOptions): DesktopPool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
active_desktops: Optional[int] = None,
are_privileged_users: Optional[bool] = None,
availability_domain: Optional[str] = None,
availability_policy: Optional[_desktops.DesktopPoolAvailabilityPolicyArgs] = None,
compartment_id: Optional[str] = None,
contact_details: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
device_policy: Optional[_desktops.DesktopPoolDevicePolicyArgs] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
image: Optional[_desktops.DesktopPoolImageArgs] = None,
is_storage_enabled: Optional[bool] = None,
maximum_size: Optional[int] = None,
network_configuration: Optional[_desktops.DesktopPoolNetworkConfigurationArgs] = None,
nsg_ids: Optional[Sequence[str]] = None,
shape_name: Optional[str] = None,
standby_size: Optional[int] = None,
state: Optional[str] = None,
storage_backup_policy_id: Optional[str] = None,
storage_size_in_gbs: Optional[int] = None,
time_created: Optional[str] = None,
time_start_scheduled: Optional[str] = None,
time_stop_scheduled: Optional[str] = None) -> DesktopPool
func GetDesktopPool(ctx *Context, name string, id IDInput, state *DesktopPoolState, opts ...ResourceOption) (*DesktopPool, error)
public static DesktopPool Get(string name, Input<string> id, DesktopPoolState? state, CustomResourceOptions? opts = null)
public static DesktopPool get(String name, Output<String> id, DesktopPoolState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Active
Desktops int - The number of active desktops in the desktop pool.
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- Image
Desktop
Pool Image - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- Nsg
Ids List<string> - A list of network security groups for the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- State string
- The current state of the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Time
Created string - The date and time the resource was created.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Active
Desktops int - The number of active desktops in the desktop pool.
- Are
Privileged boolUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- Availability
Domain string - The availability domain of the desktop pool.
- Availability
Policy DesktopPool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- Compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- Contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- map[string]string
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- Device
Policy DesktopPool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- Display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- Image
Desktop
Pool Image Args - Provides information about the desktop image.
- Is
Storage boolEnabled - Indicates whether storage is enabled for the desktop pool.
- Maximum
Size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- Network
Configuration DesktopPool Network Configuration Args - Provides information about the network configuration of the desktop pool.
- Nsg
Ids []string - A list of network security groups for the desktop pool.
- Shape
Name string - The shape of the desktop pool.
- Standby
Size int - (Updatable) The maximum number of standby desktops available in the desktop pool.
- State string
- The current state of the desktop pool.
- Storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- Storage
Size intIn Gbs - The size in GBs of the storage for the desktop pool.
- Time
Created string - The date and time the resource was created.
- Time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- Time
Stop stringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- active
Desktops Integer - The number of active desktops in the desktop pool.
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Integer - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- nsg
Ids List<String> - A list of network security groups for the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Integer - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state String
- The current state of the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size IntegerIn Gbs - The size in GBs of the storage for the desktop pool.
- time
Created String - The date and time the resource was created.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- active
Desktops number - The number of active desktops in the desktop pool.
- are
Privileged booleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain string - The availability domain of the desktop pool.
- availability
Policy DesktopPool Availability Policy - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment
Id string - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details string - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device
Policy DesktopPool Device Policy - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name string - (Updatable) A user friendly display name. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- image
Desktop
Pool Image - Provides information about the desktop image.
- is
Storage booleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration DesktopPool Network Configuration - Provides information about the network configuration of the desktop pool.
- nsg
Ids string[] - A list of network security groups for the desktop pool.
- shape
Name string - The shape of the desktop pool.
- standby
Size number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state string
- The current state of the desktop pool.
- storage
Backup stringPolicy Id - The backup policy OCID of the storage.
- storage
Size numberIn Gbs - The size in GBs of the storage for the desktop pool.
- time
Created string - The date and time the resource was created.
- time
Start stringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop stringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- active_
desktops int - The number of active desktops in the desktop pool.
- are_
privileged_ boolusers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability_
domain str - The availability domain of the desktop pool.
- availability_
policy desktops.Desktop Pool Availability Policy Args - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment_
id str - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact_
details str - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device_
policy desktops.Desktop Pool Device Policy Args - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display_
name str - (Updatable) A user friendly display name. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- image
desktops.
Desktop Pool Image Args - Provides information about the desktop image.
- is_
storage_ boolenabled - Indicates whether storage is enabled for the desktop pool.
- maximum_
size int - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network_
configuration desktops.Desktop Pool Network Configuration Args - 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 - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state str
- The current state of the desktop pool.
- storage_
backup_ strpolicy_ id - The backup policy OCID of the storage.
- storage_
size_ intin_ gbs - The size in GBs of the storage for the desktop pool.
- time_
created str - The date and time the resource was created.
- time_
start_ strscheduled - (Updatable) The start time of the desktop pool.
- time_
stop_ strscheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- active
Desktops Number - The number of active desktops in the desktop pool.
- are
Privileged BooleanUsers - Indicates whether desktop pool users have administrative privileges on their desktop.
- availability
Domain String - The availability domain of the desktop pool.
- availability
Policy Property Map - (Updatable) Provides the start and stop schedule information for desktop availability of the desktop pool.
- compartment
Id String - (Updatable) The OCID of the compartment which will contain the desktop pool.
- contact
Details String - (Updatable) Contact information of the desktop pool administrator. Avoid entering confidential information.
- Map<String>
- (Updatable) 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
- (Updatable) A user friendly description providing additional information about the resource. Avoid entering confidential information.
- device
Policy Property Map - (Updatable) Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
- display
Name String - (Updatable) A user friendly display name. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
- image Property Map
- Provides information about the desktop image.
- is
Storage BooleanEnabled - Indicates whether storage is enabled for the desktop pool.
- maximum
Size Number - (Updatable) The maximum number of desktops permitted in the desktop pool.
- network
Configuration Property Map - Provides information about the network configuration of the desktop pool.
- nsg
Ids List<String> - A list of network security groups for the desktop pool.
- shape
Name String - The shape of the desktop pool.
- standby
Size Number - (Updatable) The maximum number of standby desktops available in the desktop pool.
- state String
- The current state of the desktop pool.
- storage
Backup StringPolicy Id - The backup policy OCID of the storage.
- storage
Size NumberIn Gbs - The size in GBs of the storage for the desktop pool.
- time
Created String - The date and time the resource was created.
- time
Start StringScheduled - (Updatable) The start time of the desktop pool.
- time
Stop StringScheduled (Updatable) The stop time of the desktop pool.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Supporting Types
DesktopPoolAvailabilityPolicy, DesktopPoolAvailabilityPolicyArgs
- Start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- Stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- Start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- Stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start
Schedule DesktopPool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- stop
Schedule DesktopPool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start_
schedule desktops.Desktop Pool Availability Policy Start Schedule - (Updatable) Provides the schedule information for a desktop.
- stop_
schedule desktops.Desktop Pool Availability Policy Stop Schedule - (Updatable) Provides the schedule information for a desktop.
- start
Schedule Property Map - (Updatable) Provides the schedule information for a desktop.
- stop
Schedule Property Map - (Updatable) Provides the schedule information for a desktop.
DesktopPoolAvailabilityPolicyStartSchedule, DesktopPoolAvailabilityPolicyStartScheduleArgs
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron_
expression str - (Updatable) A cron expression describing the desktop's schedule.
- timezone str
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
DesktopPoolAvailabilityPolicyStopSchedule, DesktopPoolAvailabilityPolicyStopScheduleArgs
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- Cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- Timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression string - (Updatable) A cron expression describing the desktop's schedule.
- timezone string
- (Updatable) The timezone of the desktop's schedule.
- cron_
expression str - (Updatable) A cron expression describing the desktop's schedule.
- timezone str
- (Updatable) The timezone of the desktop's schedule.
- cron
Expression String - (Updatable) A cron expression describing the desktop's schedule.
- timezone String
- (Updatable) The timezone of the desktop's schedule.
DesktopPoolDevicePolicy, DesktopPoolDevicePolicyArgs
- Audio
Mode string - (Updatable) 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 string - (Updatable) 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 string - (Updatable) 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 boolEnabled - (Updatable) Indicates whether the display is enabled.
- Is
Keyboard boolEnabled - (Updatable) Indicates whether the keyboard is enabled.
- Is
Pointer boolEnabled - (Updatable) Indicates whether the pointer is enabled.
- Is
Printing boolEnabled - (Updatable) Indicates whether printing is enabled.
- Audio
Mode string - (Updatable) 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 string - (Updatable) 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 string - (Updatable) 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 boolEnabled - (Updatable) Indicates whether the display is enabled.
- Is
Keyboard boolEnabled - (Updatable) Indicates whether the keyboard is enabled.
- Is
Pointer boolEnabled - (Updatable) Indicates whether the pointer is enabled.
- Is
Printing boolEnabled - (Updatable) Indicates whether printing is enabled.
- audio
Mode String - (Updatable) 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 String - (Updatable) 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 String - (Updatable) 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 BooleanEnabled - (Updatable) Indicates whether the display is enabled.
- is
Keyboard BooleanEnabled - (Updatable) Indicates whether the keyboard is enabled.
- is
Pointer BooleanEnabled - (Updatable) Indicates whether the pointer is enabled.
- is
Printing BooleanEnabled - (Updatable) Indicates whether printing is enabled.
- audio
Mode string - (Updatable) 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 string - (Updatable) 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 string - (Updatable) 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 booleanEnabled - (Updatable) Indicates whether the display is enabled.
- is
Keyboard booleanEnabled - (Updatable) Indicates whether the keyboard is enabled.
- is
Pointer booleanEnabled - (Updatable) Indicates whether the pointer is enabled.
- is
Printing booleanEnabled - (Updatable) Indicates whether printing is enabled.
- audio_
mode str - (Updatable) 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 - (Updatable) 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 - (Updatable) 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_ boolenabled - (Updatable) Indicates whether the display is enabled.
- is_
keyboard_ boolenabled - (Updatable) Indicates whether the keyboard is enabled.
- is_
pointer_ boolenabled - (Updatable) Indicates whether the pointer is enabled.
- is_
printing_ boolenabled - (Updatable) Indicates whether printing is enabled.
- audio
Mode String - (Updatable) 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 String - (Updatable) 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 String - (Updatable) 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 BooleanEnabled - (Updatable) Indicates whether the display is enabled.
- is
Keyboard BooleanEnabled - (Updatable) Indicates whether the keyboard is enabled.
- is
Pointer BooleanEnabled - (Updatable) Indicates whether the pointer is enabled.
- is
Printing BooleanEnabled - (Updatable) Indicates whether printing is enabled.
DesktopPoolImage, DesktopPoolImageArgs
- image_
id str - The OCID of the desktop image.
- image_
name str - The name of the desktop image.
DesktopPoolNetworkConfiguration, DesktopPoolNetworkConfigurationArgs
Import
DesktopPools can be imported using the id
, e.g.
$ pulumi import oci:Desktops/desktopPool:DesktopPool test_desktop_pool "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.