google.cloud.gcp_serviceusage_service_info – Сбор информации о службе GCP

Примечание

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_serviceusage_service_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 service
  gcp_serviceusage_service_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, а следующие являются полями, уникальными для данного модуля:

Ключ				Возвращаемое значение	Описание
resources сложный				всегда	Список ресурсов
	config сложный			успех	Настройка службы доступной службы.
		apis сложный		успех	Список интерфейсов API, экспортированных этой службой.
			name строка	успех	Имя API.
			version строка	успех	Версия API.
		name строка		успех	DNS-адрес, по которому доступна эта служба.
		title строка		успех	Название продукта для данной службы.
	disableDependentServices булево			успех	Указывает, следует ли также отключать зависимые службы. Может быть включено только в том случае, если служба отключена.
	name строка			успех	Имя ресурса службы.
	parent строка			успех	Имя родителя этой службы. Например, 'projects/123'.
	state строка			успех	Включена ли служба для использования потребителем.

Авторы

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_serviceusage_service_info_module.html