Cloud Desktop API, REST: DesktopGroup.Update

Field

Description

desktopGroupId

string

Required field.

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

desktopImageId

string

name

string

description

string

labels

object (map<string, string>)

resourcesSpec

ResourcesSpec

groupConfig

DesktopGroupConfiguration

Configuration of the desktop group.

bootDiskSpec

DiskSpec

Boot disk specification of the desktop group.

dataDiskSpec

DiskSpec

Data disk specification of the desktop group.

autoUpdatePolicy

object

Includes only one of the fields autoUpdatePolicy, manualUpdatePolicy.

Update policy of the desktop group.

manualUpdatePolicy

object

Includes only one of the fields autoUpdatePolicy, manualUpdatePolicy.

Update policy of the desktop group.

Field

Description

memory

string (int64)

RAM volume, in bytes.

cores

string (int64)

Number of CPU cores.

coreFraction

string (int64)

Baseline level of CPU performance with the ability to burst performance above that baseline level.
This field sets baseline performance for each core.

Field

Description

minReadyDesktops

string (int64)

Minimum number of ready desktops.

maxDesktopsAmount

string (int64)

Maximum number of desktops.

desktopType

enum (DesktopType)

Type of the desktop.

• DESKTOP_TYPE_UNSPECIFIED
• PERSISTENT
• NON_PERSISTENT

members[]

Subject

List of members of the desktop group.

Field

Description

id

string

Required field. ID of the subject.

It can contain one of the following values:

• allAuthenticatedUsers: A special public group that represents anyone
  who is authenticated. It can be used only if the type is system.
• allUsers: A special public group that represents anyone. No authentication is required.
  For example, you don't need to specify the IAM token in an API query.
  It can be used only if the type is system.
• group:organization:<id>:users: A special system group that represents all members of organization
  with given <id>. It can be used only if the type is system.
• group:federation:<id>:users: A special system group that represents all users of federation
  with given <id>. It can be used only if the type is system.
• <cloud generated id>: An identifier that represents a user account.
  It can be used only if the type is userAccount, federatedUser or serviceAccount.

type

string

Required field. Type of the subject.

It can contain one of the following values:

• userAccount: An account on Yandex or Yandex Connect, added to Yandex Cloud.
• serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
• federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
• system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned.

Field

Description

type

enum (Type)

Required field. Type of disk.

• TYPE_UNSPECIFIED: Disk type is not specified.
• HDD: HDD disk type.
• SSD: SSD disk type.

size

string (int64)

Size of disk.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateDesktopGroupMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

desktopGroupId

string

ID of the desktop group that is being updated.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.