gcp_resourcemanager_project_info – Сбор информации о проекте GCP
Новое в версии 2.8.
Обзор
- Сбор информации о проекте GCP
- Этот модуль назывался
gcp_resourcemanager_project_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_resourcemanager_project_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Это значение не должно устанавливаться, если вам это не нужно. Это только изменяет строку User Agent для всех запросов к API. | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, его представляющей. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в Playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a project
gcp_resourcemanager_project_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание | ||
|---|---|---|---|---|
| resources сложный тип | всегда | Список ресурсов | ||
| createTime строка | успех | Время создания. | ||
| id строка | успех | Уникальный, назначенный пользователем ID проекта. Он должен содержать от 6 до 30 строчных букв, цифр или дефисов. Он должен начинаться с буквы. Запрещены завершающие дефисы. | ||
| labels словарь | успех | Метки, связанные с этим проектом. Ключи меток должны иметь длину от 1 до 63 символов и должны соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9]*[a-z0-9])?`. Значения меток должны иметь длину от 0 до 63 символов и должны соответствовать регулярному выражению `([a-z]([-a-z0-9]*[a-z0-9])?)?`. Не более 256 меток могут быть связаны с данным ресурсом. Клиенты должны хранить метки в представлении, например, JSON, которое не зависит от запрещенных конкретных символов. | ||
| lifecycleState строка | успех | Состояние жизненного цикла проекта. | ||
| name строка | успех | Назначенное пользователем имя отображения проекта. Оно должно содержать от 4 до 30 символов. Разрешенные символы: строчные и прописные буквы, цифры, дефис, одинарная кавычка, двойная кавычка, пробел и знак восклицания. | ||
| number целое число | успех | Номер, уникально идентифицирующий проект. | ||
| parent сложный тип | успех | Родительская организация. | ||
| id строка | успех | Идентификатор организации. | ||
| type строка | успех | Должно быть organization. | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_resourcemanager_project_info_module.html