[Yandex Cloud documentation](../../../index.md) > [Yandex Cloud Desktop](../../index.md) > API reference > [REST](../index.md) > [DesktopGroup](index.md) > Update # Cloud Desktop API, REST: DesktopGroup.Update Updates desktop group properties ## HTTP request ``` PATCH https://clouddesktops.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups/{desktopGroupId} ``` ## Path parameters #| ||Field | Description || || desktopGroupId | **string** Required field. ID of the desktop group to update. The maximum string length in characters is 50. || |# ## Body parameters {#yandex.cloud.clouddesktop.v1.api.UpdateDesktopGroupRequest} ```json { "updateMask": "string", "desktopImageId": "string", "name": "string", "description": "string", "labels": "object", "resourcesSpec": { "memory": "string", "cores": "string", "coreFraction": "string" }, "bootDiskSpec": { "size": "string", "type": "string" }, "dataDiskSpec": { "size": "string", "type": "string" }, "groupConfig": { "minReadyDesktops": "string", "maxDesktopsAmount": "string", "desktopType": "string", "members": [ { "id": "string", "type": "string" } ] }, // Includes only one of the fields `autoUpdatePolicy`, `manualUpdatePolicy` "autoUpdatePolicy": "object", "manualUpdatePolicy": "object" // end of the list of possible fields } ``` #| ||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** New desktop image ID. The maximum string length in characters is 50. || || name | **string** New desktop group name. Value must match the regular expression ``` |[a-z]([-a-z0-9]{0,61}[a-z0-9]) ```. || || description | **string** New desktop group description. The maximum string length in characters is 1024. || || labels | **object** (map<**string**, **string**>) New desktop group labels. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression ` [a-z][-_0-9a-z]* `. Each value must match the regular expression ` [-_0-9a-z]* `. No more than 64 per resource. || || resourcesSpec | **[ResourcesSpec](#yandex.cloud.clouddesktop.v1.api.ResourcesSpec)** Resources specification of the desktop group. || || bootDiskSpec | **[DiskSpec](#yandex.cloud.clouddesktop.v1.api.DiskSpec)** Boot disk specification of the desktop group. || || dataDiskSpec | **[DiskSpec](#yandex.cloud.clouddesktop.v1.api.DiskSpec)** Data disk specification of the desktop group. || || groupConfig | **[DesktopGroupConfiguration](#yandex.cloud.clouddesktop.v1.api.DesktopGroupConfiguration)** Configuration of the desktop group. || || autoUpdatePolicy | **object** Update automatically Includes only one of the fields `autoUpdatePolicy`, `manualUpdatePolicy`. Update policy of the desktop group. || || manualUpdatePolicy | **object** Update manually Includes only one of the fields `autoUpdatePolicy`, `manualUpdatePolicy`. Update policy of the desktop group. || |# ## ResourcesSpec {#yandex.cloud.clouddesktop.v1.api.ResourcesSpec} #| ||Field | Description || || memory | **string** (int64) RAM volume, in bytes. The minimum value is 1. || || cores | **string** (int64) Number of CPU cores. The minimum value is 1. || || 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. Acceptable values are 0 to 100, inclusive. || |# ## DiskSpec {#yandex.cloud.clouddesktop.v1.api.DiskSpec} Disk specificaton. #| ||Field | Description || || size | **string** (int64) Size of disk. Value must be greater than 0. || || type | **enum** (Type) Required field. Type of disk. - `HDD`: HDD disk type. - `SSD`: SSD disk type. || |# ## DesktopGroupConfiguration {#yandex.cloud.clouddesktop.v1.api.DesktopGroupConfiguration} #| ||Field | Description || || minReadyDesktops | **string** (int64) Minimum number of ready desktops. Acceptable values are 0 to 512, inclusive. || || maxDesktopsAmount | **string** (int64) Maximum number of desktops. Acceptable values are 0 to 512, inclusive. || || desktopType | **enum** (DesktopType) Type of the desktop. - `PERSISTENT`: Persistent desktop. - `NON_PERSISTENT`: Non persistent desktop. || || members[] | **[Subject](#yandex.cloud.access.Subject)** List of members of the desktop group. The number of elements must be in the range 0-10. || |# ## Subject {#yandex.cloud.access.Subject} #| ||Field | Description || || id | **string** Required field. ID of the subject. It can contain one of the following values:oauth * `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::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::users`: A special system group that represents all users of federation with given <id>. It can be used only if the `type` is `system`. * ``: An identifier that represents a user account. It can be used only if the `type` is `userAccount`, `federatedUser` or `serviceAccount`. The maximum string length in characters is 100. || || 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](../../../iam/api-ref/ServiceAccount/get.md#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](../../../iam/concepts/access-control/index.md#subject). The maximum string length in characters is 100. || |# ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** ```json { "id": "string", "description": "string", "createdAt": "string", "createdBy": "string", "modifiedAt": "string", "done": "boolean", "metadata": { "desktopGroupId": "string" }, // Includes only one of the fields `error` "error": { "code": "integer", "message": "string", "details": [ "object" ] } // end of the list of possible fields } ``` An Operation resource. For more information, see [Operation](../../../api-design-guide/concepts/operation.md). #| ||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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). 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](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). 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](#yandex.cloud.clouddesktop.v1.api.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](#google.rpc.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. || |# ## UpdateDesktopGroupMetadata {#yandex.cloud.clouddesktop.v1.api.UpdateDesktopGroupMetadata} #| ||Field | Description || || desktopGroupId | **string** ID of the desktop group that is being updated. || |# ## Status {#google.rpc.Status} The error result of the operation in case of failure or cancellation. #| ||Field | Description || || code | **integer** (int32) Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || || message | **string** An error message. || || details[] | **object** A list of messages that carry the error details. || |#