Created 06.5 Data функция decort_account: получение информации о подписчике. (markdown)
@@ -0,0 +1,37 @@
|
||||
_Data source_ функция **decort_account** служит для получения информации о подписчике ("account"), к ресурсам которого имеет доступ данный пользователь. Основной сценарий применения данной функции - получить цифровой идентификатор подписчика по его имени, чтобы в дальнейшем использовать этот идентификатор для управления ресурсами.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| name | string | Имя подписчика, по которому требуется получить информацию. Имя не может быть пустым.<br>Вы можете задать или `account_id`, или `name`. Если задан параметр `account_id`, то параметр `name` игнорируется. |
|
||||
| account_id | int | Идентификатор подписчика, по которому требуется получить информацию. Не может быть нулевым.<br>Если задан данный параметр, то параметр `name` игнорируется. |
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account`. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор подписчика. |
|
||||
| account_name | string | Имя подписчика. |
|
||||
| status | string | Текущий статус подписчика. |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account**:
|
||||
|
||||
```
|
||||
data "decort_account" "my_account" {
|
||||
name = "MyAccount" # this is the name of the account, which ID we want to get
|
||||
}
|
||||
# Once the above directive completes, accountID will be accessible as
|
||||
# "${data.decort_account.my_account.id}"
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account** в переменной `data.decort_account.my_at` будут сохранены возвращаемые значения. В частности, для получения идентификатора подписчика следует использовать конструкцию `"${data.decort_account.my_account.id}"`
|
||||
Reference in New Issue
Block a user