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

Примечание

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

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

Для использования в playbook укажите: google.cloud.gcp_pubsub_topic_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.
Значения переменных окружения будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимно исключают друг друга.

Примеры

- name: get info on a topic
  gcp_pubsub_topic_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources сложное			всегда	Список ресурсов
	kmsKeyName строка		успех	Имя ресурса криптоключа Cloud KMS, используемого для защиты доступа к сообщениям, опубликованным в этой теме. Учетная запись службы вашего проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должна иметь роль `roles/cloudkms.cryptoKeyEncrypterDecrypter`, чтобы использовать эту функцию. Ожидаемый формат: `projects//locations//keyRings//cryptoKeys/` .
	labels словарь		успех	Набор пар ключ/значение меток для назначения этой теме.
	messageStoragePolicy сложное		успех	Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в теме. Если отсутствует, то никаких ограничений не применяется.
		allowedPersistenceRegions список / элементы=строка	успех	Список идентификаторов регионов GCP, в которых могут храниться сообщения, опубликованные в теме. Сообщения, опубликованные издателями, работающими в недопустимых регионах GCP (или работающими вне GCP), будут маршрутизироваться для хранения в одном из разрешенных регионов. Пустой список означает, что регионы не разрешены, и это не является допустимой конфигурацией.
	name строка		успех	Имя темы.

Авторы

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