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

Примечание

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

Для его установки используйте: 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 строка	успех	Должно быть organization.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_resourcemanager_project_info_module.html