google.cloud.gcp_resourcemanager_project_info – Сбор информации о проекте GCP

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_resourcemanager_project_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор информации о проекте GCP

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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 с помощью переменной среды gcp_service_account_file.
для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры 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 строка		успех	Уникальный, заданный пользователем идентификатор проекта. Он должен содержать от 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 строка	успех	Должно быть organisation.

Авторы

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.10/collections/google/cloud/gcp_resourcemanager_project_info_module.html