diff --git a/06.3-Data-функция-decort_disk:-получение-информации-о-диске..md b/06.3-Data-функция-decort_disk:-получение-информации-о-диске..md new file mode 100644 index 0000000..ff487e2 --- /dev/null +++ b/06.3-Data-функция-decort_disk:-получение-информации-о-диске..md @@ -0,0 +1,48 @@ +_Data source_ функция **decort_disk** служит для получения информации об уже существующем диске. + +## Аргументы +_Data source_ функция **decort_disk** принимает следующие аргументы: + +| Аргумент | Тип | Описание | +| --- | --- | --- | +| name | string | Имя диска, по которому требуется получить информацию. Имя диска не может быть пустым.
Диск идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени диска или по его идентификатору (`disk_id`).
Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются.
Обратите внимание, что имя диска НЕ является уникальным, и если в рамках указанного подписчика есть несколько дисков с одним и тем же названием, то будет выдана информация по первому из них. | +| disk_id | int | Идентификатор диска, по которому требуется получить информацию. Идентификатор не может быть нулевым.
Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются. | +| account_id | int | Идентификатор подписчика ("account"), которому принадлежит данный диск. Не может быть нулевым.
Данный параметр игнорируется, если задан `disk_id`. | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `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 | Имя подписчика ("account"), которому принадлежит данный диск. | +| description | string | Текстовое описание диска. | +| disk_id | int| Идентификатор диска. Дублирует значение параметра `id`. | +| id | int| Идентификатор диска. | +| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа. | +| name | string | Имя диска. Обратите внимание, что имя диска НЕ является уникальным, и если в рамках одного и того же подписчика ("account") есть несколько дисков с одним и тем же названием, то используется первый из них. | +| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск. | +| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск. | +| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений. | +| size | int | Размер диска в ГБ. | +| type | string | Тип диска. | + +## Пример использования +Пример вызова _data source_ функции **decort_disk**: + +``` +data "decort_disk" "my_data_disk" { + name = "Data01" # this is the name of pre-existing disk + account_id = 100 # this is the ID of the account, where disk named "Data01" is found +} +# Once the above directive completes, disk ID will be accessible as +# "${data.decort_disk.my_data_disk.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_disk** в переменной `data.decort_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `"${data.decort_disk.my_data_disk.id}"` \ No newline at end of file