Configuring disk access permissions

Written by

Yandex Cloud

Updated at October 17, 2024

Assigning a role
Assigning multiple roles
Revoking a role

To grant a user, group, or service account access to a disk, assign a role for it.

Assigning a role

Management console

CLI

Terraform

API

In the management console, select the folder the disk belongs to.
Select Compute Cloud.
In the left-hand panel, select Disks.
Select a disk from the list.
Go to the Access bindings tab.
Click Assign bindings.
In the window that opens, select a group, user, or service account to be granted access to the disk.
Click Add role and select the required roles.
Click Save.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See the CLI command description for assigning a role for a disk:
```
yc compute disk add-access-binding --help
```

Get a list of disks in the default folder:

yc compute disk list

Result:

+----------------------+-------------+-------------+-------------------+--------+----------------------+-----------------+-------------+
|          ID          |     NAME    |    SIZE     |       ZONE        | STATUS |     INSTANCE IDS     | PLACEMENT GROUP | DESCRIPTION |
+----------------------+-------------+-------------+-------------------+--------+----------------------+-----------------+-------------+
| epd557pch3uk******** | first-disk  | 68719476736 | ru-central1-a | READY  | epd5ieqbii7l******** |                 |             |
| epdusilqgq3m******** | second-disk | 68719476736 | ru-central1-a | READY  | epd37ebcdf36******** |                 |             |
+----------------------+-------------+-------------+-------------------+--------+----------------------+-----------------+-------------+

View the list of roles already assigned for the resource:
```
yc compute disk list-access-bindings <disk_ID>
```

Assign the role using the command:

To a user:

yc compute disk add-access-binding <disk_ID> \
  --user-account-id <user_ID> \
  --role <role>

Where:

--user-account-id: User ID.
--role: Role to assign.

To a service account:

yc compute disk add-access-binding <disk_ID> \
  --service-account-id <service_account_ID> \
  --role <role>

Where:

--service-account-id is the service account ID.
--role: Role you want to assign.

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To assign a role for a disk using Terraform:

In the Terraform configuration file, describe the parameters of the resources you want to create:
```
resource "yandex_compute_disk_iam_binding" "sa-access" {
  disk_id = "<disk_ID>"
  role    = "<role>"
  members = ["<subject_type>:<subject_ID>","<subject_type>:<subject_ID>"]
}
```
Where:
- disk_id: Disk ID.
- role: Role to assign.
- members: List of types and IDs of subjects the role is assigned to. Specify it as userAccount:<user_ID> or serviceAccount:<service_account_ID>.
For more information about the yandex_compute_disk_iam_binding resource parameters, see the provider documentation.
Create resources:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.
Terraform will create all the required resources. You can check the update using the management console or this CLI command:
```
yc compute disk list-access-bindings <disk_ID>
```

Use the updateAccessBindings REST API method for the Disk resource or the DiskService/UpdateAccessBindings gRPC API call. In the request body, set the action property to ADD and specify the user type and ID in the subject property.

Assigning multiple roles

Management console

CLI

Terraform

API

In the management console, select the folder the disk belongs to.
Select Compute Cloud.
In the left-hand panel, select Disks.
Select a disk from the list.
Go to the Access bindings tab.
Click Assign bindings.
In the window that opens, select a group, user, or service account to be granted access to the disk.
Click Add role and select the required roles.
To add another role, click Add role.
Click Save.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

You can assign multiple roles using the set-access-bindings command.

Alert

The set-access-bindings command completely rewrites the access permissions for the resource. All current resource roles will be deleted.

Make sure the resource has no roles assigned that you would not want to lose:
```
yc compute disk list-access-bindings <disk_ID>
```
See the CLI command description for assigning roles for a disk:
```
yc compute disk set-access-bindings --help
```

Assign roles:

yc compute disk set-access-bindings <disk_ID> \
  --access-binding role=<role>,subject=<subject_type>:<subject_ID>

Where:

--access-binding: Role you want to assign:
- role: ID of the role to assign.
- subject: Type and ID of the subject getting the role.

For example, assign roles to multiple users and a service account:

yc compute disk set-access-bindings my-disk \
  --access-binding role=editor,subject=userAccount:gfei8n54hmfh********
  --access-binding role=viewer,subject=userAccount:helj89sfj80a********
  --access-binding role=editor,subject=serviceAccount:ajel6l0jcb9s********

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To assign multiple roles for a disk using Terraform:

In the Terraform configuration file, describe the parameters of the resources you want to create:
```
resource "yandex_compute_disk_iam_binding" "role1" {
  disk_id = "<disk_ID>"
  role    = "<role_1>"
  members = ["<subject_type>:<subject_ID>"]
}

resource "yandex_compute_disk_iam_binding" "role2" {
  disk_id = "<disk_ID>"
  role    = "<role_2>"
  members = ["<subject_type>:<subject_ID>"]
}
```
Where:
- disk_id: Disk ID.
- role: Role to assign.
- members: List of types and IDs of subjects the role is assigned to. Specify it as userAccount:<user_ID> or serviceAccount:<service_account_ID>.
For more information about the yandex_compute_disk_iam_binding resource parameters, see the provider documentation.
Create resources:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.
Terraform will create all the required resources. You can check the update using the management console or this CLI command:
```
yc compute disk list-access-bindings <disk_ID>
```

Use the setAccessBindings REST API method for the Disk resource or the DiskService/SetAccessBindings gRPC API call.

Revoking a role

Management console

CLI

Terraform

API

In the management console, select the folder the disk belongs to.
Select Compute Cloud.
In the left-hand panel, select Disks.
Select a disk from the list.
Go to the Access bindings tab.
Click Assign bindings.
In the line with the user you need, click and select Edit roles.
Click next to a role to delete it.
Click Save.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

See the CLI command description for revoking a role for a disk:
```
yc compute disk remove-access-binding --help
```

View the roles and assignees for the resource:

yc compute disk list-access-bindings <disk_ID>

To revoke access permissions, run this command:
```
yc compute disk remove-access-binding <disk_ID> \
  --role <role_ID> \
  --subject <subject_type>:<subject_ID>
```
Where:
- --role: ID of the role to revoke.
- --subject: Subject to revoke the role from.
For example, this command revokes the viewer role for a disk from a user with the ajel6l0jcb9s******** ID:
```
yc compute disk remove-access-binding my-disk \
  --role viewer \
  --subject userAccount:ajel6l0jcb9s********
```

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To revoke a role assigned for a disk using Terraform:

Open the Terraform configuration file and delete the fragment with the role description.

resource "yandex_compute_disk_iam_binding" "sa-access" {
  disk_id = "<disk_ID>"
  role    = "<role>"
  members = ["<subject_type>:<subject_ID>"]
}

Apply the changes:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.
You can check the update using the management console or this CLI command:
```
yc compute disk list-access-bindings <disk_ID>
```

To revoke disk roles, use the updateAccessBindings REST API method for the Disk resource or the DiskService/UpdateAccessBindings gRPC API call. In the request body, set the action property to REMOVE and specify the user type and ID in the subject property.

Configuring disk access permissions

Assigning a roleAssigning a role

Assigning multiple rolesAssigning multiple roles

Revoking a roleRevoking a role

Was the article helpful?

Assigning a role

Assigning multiple roles

Revoking a role