Editing a group
-
Log in to Yandex Cloud Organization
using an administrator or organization owner account. -
In the left-hand panel, select
Groups. -
In the row with the group you need, click
and select Edit. -
Enter a new name or description for the group.
The name must be unique within the organization and satisfy the relevant requirements:
- It must be from 1 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
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.
-
View the description of the command to edit a Cloud Organization user group:
yc organization-manager group update --help
-
To edit a user group, run this command:
yc organization-manager group update \ --name <group_name> \ --new-name <new_name_for_group> \ --organization-id <organization_ID> \ --description <group_description>
Where:
-
--name
: User group name. This is a required parameter. The name must be unique within the organization and satisfy the relevant requirements:- It must be from 1 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
--new-name
: New name for the user group. -
--organization-id
: Organization ID. This is an optional parameter. -
--description
: Text description of the user group. This is an optional parameter.
-
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the documentation on the Terraform
If you don't have Terraform, install it and configure the Yandex Cloud provider.
-
In the configuration file, edit the group parameters:
resource "yandex_organizationmanager_group" "my-group" { name = "<group_name>" description = "<group_description>" organization_id = "<organization_ID>" }
Where:
-
name
: New group name. The name must be unique within the organization and satisfy the relevant requirements:- It must be from 1 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
description
: New group description. -
organization_id
: ID of the organization the group belongs to.
-
-
Create resources:
-
In the terminal, change to the folder where you edited the configuration file.
-
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.
-
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.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
in the terminal and press Enter.
Terraform will create all the required resources. You can check the new resources and their settings using the management console
or this CLI command:yc organization-manager group get \ --name <group_name> \ --organization-id <organization_ID>
-
Use the Group.update REST API method for the Group resource or the GroupService/Update gRPC API call.