Contact UsGet started

Configuring VM access permissions

Written by
Updated at October 30, 2024

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

Assigning a role

  1. In the management console, select the folder the VM belongs to.
  2. Select Compute Cloud.
  3. Select the appropriate VM.
  4. Go to the Access bindings tab.
  5. Click Assign bindings.
  6. In the window that opens, select a group, user, or service account to be granted access to the VM.
  7. Click Add role and select the required roles.
  8. 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.

  1. See the CLI command description for assigning a role for a VM:

    yc compute instance add-access-binding --help

  2. Get a list of VMs in the default folder:

    yc compute instance list

    Result:

    +----------------------+-----------------+---------------+---------+----------------------+
|          ID          |       NAME      |    ZONE ID    | STATUS  |     DESCRIPTION      |
+----------------------+-----------------+---------------+---------+----------------------+
| fhm0b28lgfp4******** | first-instance  | ru-central1-a | RUNNING | my first vm via CLI  |
| fhm9gk85nj7g******** | second-instance | ru-central1-a | RUNNING | my second vm via CLI |
+----------------------+-----------------+---------------+---------+----------------------+

  3. View the list of roles already assigned for the resource:

    yc compute instance list-access-bindings <VM_ID>

  4. Assign the role using the command:

    • To a user:

      yc compute instance add-access-binding <VM_ID> \
  --user-account-id <user_ID> \
  --role <role>

      Where:

    • To a service account:

      yc compute instance add-access-binding <VM_ID> \
  --service-account-id <service_account_ID> \
  --role <role>

      Where:

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 VM using Terraform:

  1. In the Terraform configuration file, describe the parameters of the resources you want to create:

    resource "yandex_compute_instance_iam_binding" "sa-access" {
  instance_id = "<VM_ID>"
  role        = "<role>"
  members     = ["<subject_type>:<subject_ID>","<subject_type>:<subject_ID>"]
}

    Where:

    • instance_id: VM ID.
    • role: Role to assign.
    • members: List of types and IDs of subjects the roles are assigned to. Specify it as userAccount:<user_ID> or serviceAccount:<service_account_ID>.

    For more information about the yandex_compute_instance_iam_binding resource parameters, see the provider documentation.

  2. 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 new resources using the management console or this CLI command:

    yc compute instance list-access-bindings <VM_ID>

Use the updateAccessBindings REST API method for the Instance resource or the InstanceService/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

  1. In the management console, select the folder the VM belongs to.
  2. Select Compute Cloud.
  3. Select the appropriate VM.
  4. Go to the Access bindings tab.
  5. Click Assign bindings.
  6. In the window that opens, select a group, user, or service account to be granted access to the VM.
  7. Click Add role and select the required roles.
  8. To add another role, click Add role.
  9. 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.

  1. Make sure the resource has no roles assigned that you would not want to lose:

    yc compute instance list-access-bindings <VM_ID>

  2. See the CLI command description for assigning roles for a VM:

    yc compute instance set-access-bindings --help

  3. Assign roles:

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

    Where:

    • --access-binding: Role 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 instance set-access-bindings test-vm \
  --access-binding role=editor,subject=userAccount:gfei8n54hmfh********
  --access-binding role=viewer,subject=userAccount:helj89sfj80a********
  --access-binding role=editor,subject=serviceAccount:ajel6l0jcb9s********

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

To assign multiple roles for a VM using Terraform:

  1. In the Terraform configuration file, describe the parameters of the resources you want to create:

    resource "yandex_compute_instance_iam_binding" "role-1" {
  instance_id = "<VM_ID>"
  role        = "<role_1>"
  members     = ["<subject_type>:<subject_ID>"]
}

resource "yandex_compute_instance_iam_binding" "role-2" {
  instance_id = "<VM_ID>"
  role        = "<role_2>"
  members     = ["<subject_type>:<subject_ID>"]
}

    Where:

    • instance_id: VM ID.
    • role: Role to assign.
    • members: List of types and IDs of subjects the roles are assigned to. Specify it as userAccount:<user_ID> or serviceAccount:<service_account_ID>.

    For more information about the yandex_compute_instance_iam_binding resource parameters, see the provider documentation.

  2. 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.

    You can check the updates using the management console or this CLI command:

    yc compute instance list-access-bindings <VM_ID>

Use the setAccessBindings REST API method for the Instance resource or the InstanceService/SetAccessBindings gRPC API call.

Revoking a role

  1. In the management console, select the folder the VM belongs to.
  2. Select Compute Cloud.
  3. Select the appropriate VM.
  4. Go to the Access bindings tab.
  5. In the line with the user you need, click and select Edit roles.
  6. Click next to a role to delete it.
  7. 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.

  1. See the CLI command description for revoking a role for a VM:

    yc compute instance remove-access-binding --help

  2. View the roles and assignees for the resource:

    yc compute instance list-access-bindings <VM_ID>

  3. To revoke access permissions, run this command:

    yc compute instance remove-access-binding <VM_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, to revoke the viewer role for a VM from a user with the ajel6l0jcb9s******** ID:

    yc compute instance remove-access-binding test-vm \
  --role viewer \
  --subject userAccount:ajel6l0jcb9s********

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

To revoke a role assigned for a VM using Terraform:

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

    resource "yandex_compute_instance_iam_binding" "sa-access" {
  instance_id = "<VM_ID>"
  role        = "<role>"
  members     = ["<subject_type>:<subject_ID>"]
}

  2. 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 updates using the management console or this CLI command:

    yc compute instance list-access-bindings <VM_ID>

To revoke instance roles, use the updateAccessBindings REST API method for the Instance resource or the InstanceService/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.

Previous
VM maintenance policy management
Next
Deleting a VM