Create bservice_deleted_list page

stSolo
2022-06-06 16:48:36 +03:00
parent 88e8fdb356
commit 92d874d041

@@ -0,0 +1,78 @@
Функция доступна в провайдере версии 2.3 и выше.
_Data source_ функция **decort_bservice_deleted_list** служит для получения информации о всех удаленных базовых сервисах. Базовый сервис (basic service) может быть шаблоном, на основе которого создаются вычислительные мощности (computes). Удаленные сервисы попадают в этот список, если они были удалены с флагом permanently, выставленном в false. Такие сервисы можно восстановить.
## Аргументы
_Data source_ функция **decort_bservice_deleted_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| account_id | int | :x: | ID аккаунта для фильтрации результата |
| rg_id | int | :x: | ID ресурсной группы для фильтрации результата |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_bservice_deleted_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | ID аккаунта |
| account_name | string | Название аккаунта |
| base_domain | string | Базовый домен |
| created_by | string | Кем создан сервис |
| created_time | int | Время создания сервиса |
| deleted_by | string | Кем удален сервис |
| deleted_time | int | Время удаления сервиса |
| gid | int | Grid id |
| groups | []int | Список вычислительных групп сервиса |
| guid | int | Внутренний ID сервиса |
| service_id | int | ID сервиса |
| service_name | string | Название сервиса |
| parent_srv_id | int | ID родительского сервисе |
| parent_srv_name | string | Название родительского сервиса |
| rg_id | int | ID ресурсной группы |
| rg_name | string | Название ресурсной группы |
| ssh_user | string | Имя пользователя для подключения по ssh |
| status | string | Статус сервиса |
| tech_status | string | Технический статус сервиса |
| updated_by | string | Кем сервис был обновлен |
| updated_time | int | Время последнего обновления |
| user_managed | bool | Флаг, управляется ли пользователем |
## Пример использования
Пример вызова _data source_ функции **decort_bservice_deleted_list**:
```terraform
data "decort_bservice_deleted_list" "bsdl" {
#id аккаунта для фильтрации данных
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
#account_id = 11111
#id ресурсной группы, используется для фильтрации
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
#rg_id = 11111
#номер страницы для отображения
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
#page = 2
#размер страницы
#опциональный параметр
#тип - число
#если не задан - выводятся все доступные данные
#size = 3
}
# once the above directive completes, bservice deleted list will be accessible
# as data.decort_bservice_deleted_list.bsdl.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_bservice_deleted_list** в переменной `data.decort_bservice_deleted_list.bsdl` будут сохранены возвращаемые значения.