diff --git a/06.21-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md b/06.21-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md new file mode 100644 index 0000000..ff216e5 --- /dev/null +++ b/06.21-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md @@ -0,0 +1,69 @@ +Функция доступна в провайдере версии 2.3 и выше. + +_Data source_ функция **decort_rg_list** служит для получения информации об имеющихся ресурсных группах. + +## Аргументы +_Data source_ функция **decort_rg_list** принимает следующие аргументы: +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| includedeleted | bool | :x: | Включение удаленных rg в результат поиска | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_rg_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| account_id | int | ID аккаунта - владельца ресурсной группы | +| account_name | string | Имя аккаунта - владельца ресурсной группы | +| acl | []Struct{
explicit bool
guid string
right string
status string
type string
user_group_id string
} | Более подробная информация об аккаунтах, имеющих доступ к ресурсной группе
Явно ли указан доступ
guid аккаунта
Права доступа
Статус аккаунта
Тип аккаунта
Идентификатор пользователя-владельца аккаунта
 
| +| created_by | string | Информация о создателе группы | +| created_time | int | Время создания группы | +| def_net_id | int | id сети по-умолчанию | +| def_net_type | string | Тип сети по-умолчанию | +| deleted_by | string | Информация о том, кто удалил группу | +| deleted_time | int | Время удаления группы | +| desc | string | Описание группы | +| gid | int | Grid id | +| guid | int | Внутренний идентификатор ресурсной группы | +| rg_id | int | Идентификатор ресурсной группы | +| lost_status | string | Статус блокировки ресурсной группы | +| name | string | Название ресурсной группы | +| register_computes | bool | Имеются ли зарезервированные выч. мощности | +| resource_limits | Struct{
cu_c float
cu_d float
cu_i float
cu_m float
cu_np float
gpu_units float
} | Ограничения ресурсов
Кол-во ядер
Размер диска, ГБ
Число публичных ip адресов
Размер RAM, МБ
Объем трафика, ГБ
Кол-вол графических ядер
 
| +| secret | string | Секрет группы | +| status | string | Статус группы | +| updated_by | string | Кем группа была обновлена в последний раз | +| updated_time | int | Время последнего обновления | +| vins | []int | Список идентификаторов виртуальных сетей | +| vms | []int | Список идентификаторов виртуальных машин (устаревшее) | + +## Пример использования +Пример вызова _data source_ функции **decort_rg_list**: +```terraform +data "decort_rg_list" "rl" { + #включение удаленных rg в результат поиска + #опциональный параметр + #тип - булев тип + #по-умолчанию - false + #includedeleted = true + + #номер страницы для отображения + #опциональный параметр, тип - число + #если не задан - выводятся все доступные данные + #page = 2 + + #размер страницы + #опциональный параметр, тип - число + #если не задан - выводятся все доступные данные + #size = 3 + +}# once the above directive completes, rg list will be accessible +# as data.decort_rg_list.rl.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). + +После успешного завершения такого вызова **decort_rg_list** в переменной `data.decort_rg_list.rl` будут сохранены возвращаемые значения. \ No newline at end of file