Cloud Desktop API, gRPC: DesktopGroupService

A set of methods for managing desktop group resources.

Call	Description
Get	Returns the specified desktop group resource.
List	Retrieves the list of desktop group resources.
ListDesktops	Retrieves the list of desktops resources.
ListOperations	Returns list of the operations for the specified desktop group.
Create	Creates desktop group in the specified folder.
Delete	Deletes the specified desktop group.
ListAccessBindings	Returns a list of the access bindings for the specified desktop group.
SetAccessBindings	Sets access bindings for the specified desktop group.
UpdateAccessBindings	Updates access bindings of the specified desktop group.

Calls DesktopGroupServiceCalls DesktopGroupService

GetGet

Returns the specified desktop group resource.
To get the list of available desktop groups, make a List request.

rpc Get (GetDesktopGroupRequest) returns (DesktopGroup)

GetDesktopGroupRequestGetDesktopGroupRequest

Field	Description
desktop_group_id	string Required. ID of the desktop group resource to return. To get the desktop group ID use a DesktopGroupService.List request. The maximum string length in characters is 50.

DesktopGroupDesktopGroup

Field	Description
id	string Desktop group ID.
folder_id	string ID of the folder that the desktop group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
status	enum Status Status of the desktop group. CREATING: Desktop group is being created. ACTIVE: Desktop group is ready to use. DELETING: Desktop group is being deleted.
name	string Name of the desktop group.
description	string Description of the desktop group.
resources_spec	ResourcesSpec Resource specification of the desktop group.
network_interface_spec	NetworkInterfaceSpec Network interface specification of the desktop group.

ResourcesSpecResourcesSpec

Field	Description
memory	int64 RAM volume, in bytes. The minimum value is 1.
cores	int64 Number of CPU cores. The minimum value is 1.
core_fraction	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.

NetworkInterfaceSpecNetworkInterfaceSpec

Field	Description
network_id	string Required. ID of the network interface specification. The maximum string length in characters is 50.
subnet_ids[]	string List of subnet IDs. The number of elements must be greater than 0. The maximum string length in characters for each value is 50.

ListList

Retrieves the list of desktop group resources.

rpc List (ListDesktopGroupsRequest) returns (ListDesktopGroupsResponse)

ListDesktopGroupsRequestListDesktopGroupsRequest

Field	Description
folder_id	string Required. ID of the folder to list desktop groups in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListDesktopGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListDesktopGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can use filtering only on DesktopGroup.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. Value or a list of values to compare against the values of the field. The maximum string length in characters is 1000.
order_by	string Sorting the list by DesktopGroup.name, DesktopGroup.created_at and DesktopGroup.status fields. The default sorting order is ascending. The maximum string length in characters is 100.

ListDesktopGroupsResponseListDesktopGroupsResponse

Field	Description
desktop_groups[]	DesktopGroup List of desktop groups.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListDesktopGroupsRequest.page_size, use the next_page_token as the value for the ListDesktopGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

DesktopGroupDesktopGroup

Field	Description
id	string Desktop group ID.
folder_id	string ID of the folder that the desktop group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
status	enum Status Status of the desktop group. CREATING: Desktop group is being created. ACTIVE: Desktop group is ready to use. DELETING: Desktop group is being deleted.
name	string Name of the desktop group.
description	string Description of the desktop group.
resources_spec	ResourcesSpec Resource specification of the desktop group.
network_interface_spec	NetworkInterfaceSpec Network interface specification of the desktop group.

ResourcesSpecResourcesSpec

Field	Description
memory	int64 RAM volume, in bytes. The minimum value is 1.
cores	int64 Number of CPU cores. The minimum value is 1.
core_fraction	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.

NetworkInterfaceSpecNetworkInterfaceSpec

Field	Description
network_id	string Required. ID of the network interface specification. The maximum string length in characters is 50.
subnet_ids[]	string List of subnet IDs. The number of elements must be greater than 0. The maximum string length in characters for each value is 50.

ListDesktopsListDesktops

Retrieves the list of desktops resources.

rpc ListDesktops (ListDesktopGroupDesktopsRequest) returns (ListDesktopGroupDesktopsResponse)

ListDesktopGroupDesktopsRequestListDesktopGroupDesktopsRequest

Field	Description
desktop_group_id	string Required. ID of the desktop group. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListDesktopGroupDesktopsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListDesktopGroupDesktopsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can use filtering only on Desktop.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. Value or a list of values to compare against the values of the field. The maximum string length in characters is 1000.
order_by	string Sorting the list by Desktop.name, Desktop.created_at and Desktop.status fields. The default sorting order is ascending. The maximum string length in characters is 100.

ListDesktopGroupDesktopsResponseListDesktopGroupDesktopsResponse

Field	Description
desktops[]	Desktop List of desktops.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListDesktopGroupDesktopsRequest.page_size, use the next_page_token as the value for the [ListDesktopsDGS Request.page_token] query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

DesktopDesktop

Field	Description
id	string Desktop ID.
folder_id	string ID of the folder that the desktop belongs to.
desktop_group_id	string ID of the desktop group that the desktop belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
status	enum Status Status of the desktop. CREATING: Desktop is being created. ACTIVE: Desktop is ready to use. DELETING: Desktop is being deleted.
name	string Name of the desktop.
resources	Resources Resources of the desktop.
network_interfaces[]	NetworkInterface
users[]	User

ResourcesResources

Field	Description
memory	int64 The minimum value is 1.
cores	int64 The minimum value is 1.
core_fraction	int64 Acceptable values are 0 to 100, inclusive.

NetworkInterfaceNetworkInterface

Field	Description
network_id	string Required. The maximum string length in characters is 50.
subnet_id	string Required. The maximum string length in characters is 50.

UserUser

Field	Description
subject_id	string Required. Identity of the access binding.

ListOperationsListOperations

Returns list of the operations for the specified desktop group.

rpc ListOperations (ListDesktopGroupOperationsRequest) returns (ListDesktopGroupOperationsResponse)

ListDesktopGroupOperationsRequestListDesktopGroupOperationsRequest

Field	Description
desktop_group_id	string Required. ID of the desktop group. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListDesktopGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListDesktopGroupOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string Sorting the list by DesktopGroup.name field. The default sorting order is ascending. The maximum string length in characters is 1000.

ListDesktopGroupOperationsResponseListDesktopGroupOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified desktop group.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListDesktopGroupOperationsRequest.page_size, use the next_page_token as the value for the ListDesktopGroupOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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.
result	oneof: error or response 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

CreateCreate

Creates desktop group in the specified folder.

rpc Create (CreateDesktopGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateDesktopGroupMetadata

    Operation.response:DesktopGroup

CreateDesktopGroupRequestCreateDesktopGroupRequest

Field	Description
folder_id	string Required. ID of the folder to create a DesktopGroup in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
desktop_image_id	string Required. An image used to create a desktop boot disk The maximum string length in characters is 50.
name	string Name of the DesktopGroup. The name must be unique within the folder. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9]).
description	string Description of the DesktopGroup. The maximum string length in characters is 1024.
resources_spec	ResourcesSpec Resource specification of the desktop group.
network_interface_spec	NetworkInterfaceSpec Network interface specification of the desktop group.

ResourcesSpecResourcesSpec

Field	Description
memory	int64 RAM volume, in bytes. The minimum value is 1.
cores	int64 Number of CPU cores. The minimum value is 1.
core_fraction	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.

NetworkInterfaceSpecNetworkInterfaceSpec

Field	Description
network_id	string Required. ID of the network interface specification. The maximum string length in characters is 50.
subnet_ids[]	string List of subnet IDs. The number of elements must be greater than 0. The maximum string length in characters for each value is 50.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<CreateDesktopGroupMetadata> 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.
result	oneof: error or response 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<DesktopGroup> if operation finished successfully.

CreateDesktopGroupMetadataCreateDesktopGroupMetadata

Field	Description
desktop_group_id	string ID of the desktop group that is being created.

DesktopGroupDesktopGroup

Field	Description
id	string Desktop group ID.
folder_id	string ID of the folder that the desktop group belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
status	enum Status Status of the desktop group. CREATING: Desktop group is being created. ACTIVE: Desktop group is ready to use. DELETING: Desktop group is being deleted.
name	string Name of the desktop group.
description	string Description of the desktop group.
resources_spec	ResourcesSpec Resource specification of the desktop group.
network_interface_spec	NetworkInterfaceSpec Network interface specification of the desktop group.

DeleteDelete

Deletes the specified desktop group.

rpc Delete (DeleteDesktopGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteDesktopGroupMetadata

    Operation.response:google.protobuf.Empty

DeleteDesktopGroupRequestDeleteDesktopGroupRequest

Field	Description
desktop_group_id	string Required. ID of the desktop group to delete. To get a desktop group ID make a DesktopGroupService.List request. The maximum string length in characters is 50.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<DeleteDesktopGroupMetadata> 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.
result	oneof: error or response 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteDesktopGroupMetadataDeleteDesktopGroupMetadata

Field	Description
desktop_group_id	string ID of the desktop group that is being deleted.

ListAccessBindingsListAccessBindings

Returns a list of the access bindings for the specified desktop group.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequestListAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100.

ListAccessBindingsResponseListAccessBindingsResponse

Field	Description
access_bindings[]	AccessBinding List of access bindings for the specified resource.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

AccessBindingAccessBinding

Field	Description
role_id	string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: 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 50.
type	string Required. 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. The maximum string length in characters is 100.

SetAccessBindingsSetAccessBindings

Sets access bindings for the specified desktop group.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequestSetAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource for which access bindings are being set. To get the resource ID, use a corresponding List request. The maximum string length in characters is 50.
access_bindings[]	AccessBinding Required. Access bindings to be set. For more information, see Access Bindings.

AccessBindingAccessBinding

Field	Description
role_id	string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: 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 50.
type	string Required. 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. The maximum string length in characters is 100.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<SetAccessBindingsMetadata> 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.
result	oneof: error or response 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

SetAccessBindingsMetadataSetAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being set.

UpdateAccessBindingsUpdateAccessBindings

Updates access bindings of the specified desktop group.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequestUpdateAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50.
access_binding_deltas[]	AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0.

AccessBindingDeltaAccessBindingDelta

Field	Description
action	enum AccessBindingAction Required. The action that is being performed on an access binding. ADD: Addition of an access binding. REMOVE: Removal of an access binding.
access_binding	AccessBinding Required. Access binding. For more information, see Access Bindings.

AccessBindingAccessBinding

Field	Description
role_id	string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: 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 50.
type	string Required. 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. The maximum string length in characters is 100.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<UpdateAccessBindingsMetadata> 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.
result	oneof: error or response 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

UpdateAccessBindingsMetadataUpdateAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being updated.