gcp_pubsub_topic_info – Сбор информации о GCP-теме

Новое в версии 2.8.

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

Описание

Сбор информации о GCP-теме
Этот модуль назывался gcp_pubsub_topic_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_pubsub_topic_facts

Требования

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

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, используя переменную среды 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.
Значения переменных среды будут использованы только в том случае, если значения в книге сценариев не заданы.
Параметры 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 CryptoKey, используемого для защиты доступа к сообщениям, опубликованным в этой теме. Учетная запись службы PubSub вашего проекта (`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 строка		успех	Имя темы.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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_pubsub_topic_info_module.html