Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DesktopPool

Provides information about a desktop pool including all configuration parameters.

Properties

arePrivilegedUsers

arePrivilegedUsers: boolean

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

availabilityDomain

availabilityDomain: string

The availability domain of the desktop pool.

availabilityPolicy

availabilityPolicy: DesktopAvailabilityPolicy

compartmentId

compartmentId: string

The OCID of the compartment of the desktop pool.

contactDetails

contactDetails: string

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

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

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

devicePolicy

devicePolicy: DesktopDevicePolicy

displayName

displayName: string

A user friendly display name. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the desktop pool.

image

isStorageEnabled

isStorageEnabled: boolean

Indicates whether storage is enabled for the desktop pool.

lifecycleState

lifecycleState: LifecycleState

The current state of the desktop pool.

maximumSize

maximumSize: number

The maximum number of desktops permitted in the desktop pool. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

networkConfiguration

networkConfiguration: DesktopNetworkConfiguration

Optional nsgIds

nsgIds: Array<string>

A list of network security groups for the desktop pool.

shapeName

shapeName: string

The shape of the desktop pool.

standbySize

standbySize: number

The maximum number of standby desktops available in the desktop pool. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

storageBackupPolicyId

storageBackupPolicyId: string

The backup policy OCID of the storage.

storageSizeInGBs

storageSizeInGBs: number

The size in GBs of the storage for the desktop pool. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeCreated

timeCreated: Date

The date and time the resource was created.

Optional timeStartScheduled

timeStartScheduled: Date

The start time of the desktop pool.

Optional timeStopScheduled

timeStopScheduled: Date

The stop time of the desktop pool.

Functions

getDeserializedJsonObj

getJsonObj