You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
terraform-provider-dynamix/wiki/1.0.0/06.01.08-Data_dynamix_locat...

77 lines
3.5 KiB

7 months ago
_Data source_ функция **dynamix_locations_list** служит для получения информации об имеющихся в облачной платформе площадках(grid). Grid это пространства, на которых возможно размещение виртуальных машин.
## Аргументы
_Data source_ функция **dynamix_locations_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| flag | string | :x: | Поиск по флагу |
| name | string | :x: | Поиск по имени |
| by_id | int | :x: | Поиск по ID |
| location_code | string | :x: | Поиск по коду локации |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **dynamix_locations_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| auth_broker | []string | auth broker |
| flag | string | Флаг |
| gid | int | ID grid |
| guid | int | Внутренний id |
| id | int | ID |
| location_code | string | Код расположения grid |
| name | string | Наименование grid |
## Пример использования
Пример вызова _data source_ функции **dynamix_locations_list**:
```terraform
data "dynamix_locations_list" "ll" {
#фильтр по флагу
#опицональный параметр
#тип - строка
#flag = "some"
#фильтр по id локации
#опциональный параметр
#тип - целое число
#by_id = 100
#фильтр по имени локации
#опциональный параметр
#тип - строка
#name = "test"
#фильтр по коду локации
#опциональный параметр
#тип - строка
#location_code = "europe"
#сортировка по одному из поддерживаемых полей
#опциональный параметр
#тип - строка
#формат - "+поле" по возрастанию / "-поле" по убыванию
#sort_by = "+name"
#кол-во страниц для вывода
#опицональный параметр
#тип - целое число
#page = 1
#размер страницы
#опицональный параметр
#тип - целое число
#size = 1
}
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DYNAMIX см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-dynamix/src/branch/main/wiki/1.0.0/04.02-Инициализация-Terraform-провайдера-DYNAMIX.md)).
После успешного завершения такого вызова **dynamix_locations_list** в переменной `data.dynamix_locations_list.ll` будут сохранены возвращаемые значения.