Create vins_list page

stSolo
2022-06-03 17:42:00 +03:00
parent e0e09ec2b6
commit 141033e061

@@ -0,0 +1,65 @@
Функция доступна в провайдере версии 2.3 и выше.
_Data source_ функция **decort_vins_list** служит для получения информации об имеющихся виртуальных сетях.
## Аргументы
_Data source_ функция **decort_vins_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| include_deleted | bool | :x: | Включение удаленных vins в результат поиска |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | ID аккаунта - владельца виртуальной сети |
| account_name | string | Имя аккаунта - владельца виртуальной |
| created_by | string | Информация о создателе виртуальной сети |
| created_time | int | Время создания виртуальной сети |
| deleted_by | string | Информация о том, кто удалил виртуальную сеть |
| deleted_time | int | Время удаления виртуальной сети |
| external_ip | string | Внешний ip - адрес |
| vins_id | int | Идентификатор виртуальной сети |
| vins_name | string | Название виртуальной сети |
| network | string | Сеть |
| rg_id | int | Идентификатор ресурсной группы |
| rg_name | string | Название ресурсной группы |
| status | string | Статус виртуальной сети |
| updated_by | string | Кем виртуальная сеть была обновлена в последний раз |
| updated_time | int | Время последнего обновления |
| vxlan_id | int | Идентификатор vxlan |
## Пример использования
Пример вызова _data source_ функции **decort_vins_list**:
```terraform
data "decort_vins_list" "vl" {
#включение удаленных vins в результат
#опциональный параметр
#тип - булев тип
#если не задан - выводятся все неудаленные данные
#include_deleted = true
#номер страницы для отображения
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
#page = 1
#размер страницы
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
#size = 1
}
# once the above directive completes, vins list will be accessible
# as data.decort_vins_list.vl.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_vins_list** в переменной `data.decort_vins_list.vl` будут сохранены возвращаемые значения.