Add grid list page and description

stSolo
2022-03-28 13:38:21 +03:00
parent eca4b813be
commit 70eeaf770a

@@ -0,0 +1,37 @@
_Data source_ функция **decort_grid_list** служит для получения информации об имеющихся в облачной платформе grid. Grid это пространства, на которых возможно размещение виртуальных машин.
## Аргументы
_Data source_ функция **decort_grid_list** принимает следующие аргументы:
| Аргумент | Тип | Описание |
| --- | --- | --- |
| page | int | опциональный параметр, номер страниц
| size | int | опциональный параметр, размер страницы
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_grid_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| flag | string | флаг
| gid | int | id grid
| guid | int | внутренний id grid
| id | int | id grid
| location_code | string | код расположения grid
| name | string | наименование grid
## Пример использования
Пример вызова _data source_ функции **decs_grid_list**:
```
data "decort_grid_list" "gl" {
#page = 2
#size = 3
}
# once the above directive completes, grid list will be accessible
# as data.decort_grid_list.gl.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_grid_list** в переменной `data.decort_grid_list.gl` будут сохранены возвращаемые значения.