Show / Hide Table of Contents

Class DesktopPool

Provides information about a desktop pool including all configuration parameters.

Inheritance
object
DesktopPool
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DesktopsService.Models
Assembly: OCI.DotNetSDK.Desktops.dll
Syntax
public class DesktopPool

Properties

ArePrivilegedUsers

Declaration
[Required(ErrorMessage = "ArePrivilegedUsers is required.")]
[JsonProperty(PropertyName = "arePrivilegedUsers")]
public bool? ArePrivilegedUsers { get; set; }
Property Value
Type Description
bool?

Indicates whether desktop pool users have administrative privileges on their desktop.

Remarks

Required

AvailabilityDomain

Declaration
[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type Description
string

The availability domain of the desktop pool.

Remarks

Required

AvailabilityPolicy

Declaration
[Required(ErrorMessage = "AvailabilityPolicy is required.")]
[JsonProperty(PropertyName = "availabilityPolicy")]
public DesktopAvailabilityPolicy AvailabilityPolicy { get; set; }
Property Value
Type Description
DesktopAvailabilityPolicy
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment of the desktop pool.

Remarks

Required

ContactDetails

Declaration
[Required(ErrorMessage = "ContactDetails is required.")]
[JsonProperty(PropertyName = "contactDetails")]
public string ContactDetails { get; set; }
Property Value
Type Description
string

Contact information of the desktop pool administrator. Avoid entering confidential information.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A user friendly description providing additional information about the resource. Avoid entering confidential information.

DevicePolicy

Declaration
[Required(ErrorMessage = "DevicePolicy is required.")]
[JsonProperty(PropertyName = "devicePolicy")]
public DesktopDevicePolicy DevicePolicy { get; set; }
Property Value
Type Description
DesktopDevicePolicy
Remarks

Required

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user friendly display name. Avoid entering confidential information.

Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
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

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the desktop pool.

Remarks

Required

Image

Declaration
[Required(ErrorMessage = "Image is required.")]
[JsonProperty(PropertyName = "image")]
public DesktopImage Image { get; set; }
Property Value
Type Description
DesktopImage
Remarks

Required

IsStorageEnabled

Declaration
[Required(ErrorMessage = "IsStorageEnabled is required.")]
[JsonProperty(PropertyName = "isStorageEnabled")]
public bool? IsStorageEnabled { get; set; }
Property Value
Type Description
bool?

Indicates whether storage is enabled for the desktop pool.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current state of the desktop pool.

Remarks

Required

MaximumSize

Declaration
[Required(ErrorMessage = "MaximumSize is required.")]
[JsonProperty(PropertyName = "maximumSize")]
public int? MaximumSize { get; set; }
Property Value
Type Description
int?

The maximum number of desktops permitted in the desktop pool.

Remarks

Required

NetworkConfiguration

Declaration
[Required(ErrorMessage = "NetworkConfiguration is required.")]
[JsonProperty(PropertyName = "networkConfiguration")]
public DesktopNetworkConfiguration NetworkConfiguration { get; set; }
Property Value
Type Description
DesktopNetworkConfiguration
Remarks

Required

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

A list of network security groups for the network.

PrivateAccessDetails

Declaration
[JsonProperty(PropertyName = "privateAccessDetails")]
public DesktopPoolPrivateAccessDetails PrivateAccessDetails { get; set; }
Property Value
Type Description
DesktopPoolPrivateAccessDetails

SessionLifecycleActions

Declaration
[JsonProperty(PropertyName = "sessionLifecycleActions")]
public DesktopSessionLifecycleActions SessionLifecycleActions { get; set; }
Property Value
Type Description
DesktopSessionLifecycleActions

ShapeConfig

Declaration
[JsonProperty(PropertyName = "shapeConfig")]
public DesktopPoolShapeConfig ShapeConfig { get; set; }
Property Value
Type Description
DesktopPoolShapeConfig

ShapeName

Declaration
[Required(ErrorMessage = "ShapeName is required.")]
[JsonProperty(PropertyName = "shapeName")]
public string ShapeName { get; set; }
Property Value
Type Description
string

The shape of the desktop pool.

Remarks

Required

StandbySize

Declaration
[Required(ErrorMessage = "StandbySize is required.")]
[JsonProperty(PropertyName = "standbySize")]
public int? StandbySize { get; set; }
Property Value
Type Description
int?

The maximum number of standby desktops available in the desktop pool.

Remarks

Required

StorageBackupPolicyId

Declaration
[Required(ErrorMessage = "StorageBackupPolicyId is required.")]
[JsonProperty(PropertyName = "storageBackupPolicyId")]
public string StorageBackupPolicyId { get; set; }
Property Value
Type Description
string

The backup policy OCID of the storage.

Remarks

Required

StorageSizeInGBs

Declaration
[Required(ErrorMessage = "StorageSizeInGBs is required.")]
[JsonProperty(PropertyName = "storageSizeInGBs")]
public int? StorageSizeInGBs { get; set; }
Property Value
Type Description
int?

The size in GBs of the storage for the desktop pool.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the resource was created.

Remarks

Required

TimeStartScheduled

Declaration
[JsonProperty(PropertyName = "timeStartScheduled")]
public DateTime? TimeStartScheduled { get; set; }
Property Value
Type Description
DateTime?

The start time of the desktop pool.

TimeStopScheduled

Declaration
[JsonProperty(PropertyName = "timeStopScheduled")]
public DateTime? TimeStopScheduled { get; set; }
Property Value
Type Description
DateTime?

The stop time of the desktop pool.

UseDedicatedVmHost

Declaration
[JsonProperty(PropertyName = "useDedicatedVmHost")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DesktopPool.UseDedicatedVmHostEnum? UseDedicatedVmHost { get; set; }
Property Value
Type Description
DesktopPool.UseDedicatedVmHostEnum?

Indicates whether the desktop pool uses dedicated virtual machine hosts.

In this article
Back to top