Create rg_list page

stSolo
2022-06-03 15:19:10 +03:00
parent df259e6ef4
commit d08d986612

@@ -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{<br/>explicit bool<br/>guid string<br/>right string<br/>status string<br/>type string<br/>user_group_id string<br/>} | Более подробная информация об аккаунтах, имеющих доступ к ресурсной группе<br/>Явно ли указан доступ<br/>guid аккаунта<br/>Права доступа<br/>Статус аккаунта<br/>Тип аккаунта<br/>Идентификатор пользователя-владельца аккаунта<br/>&nbsp;<br/> |
| 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{<br/>cu_c float<br/>cu_d float<br/>cu_i float<br/>cu_m float<br/>cu_np float<br/>gpu_units float<br/>} | Ограничения ресурсов<br/>Кол-во ядер<br/>Размер диска, ГБ<br/>Число публичных ip адресов<br/>Размер RAM, МБ<br/>Объем трафика, ГБ<br/>Кол-вол графических ядер<br/>&nbsp;<br/> |
| 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` будут сохранены возвращаемые значения.