модуль google.cloud.gcp_pubsub_topic_info — сбор сведений о теме GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_pubsub_topic_info.

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

Краткое описание

Сбор сведений о теме GCP

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не уверены в своих действиях. Этот параметр изменяет только строку User Agent для всех запросов к API.
project string	Проект Google Cloud Platform, который следует использовать.
scopes list / elements=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей это содержимое.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбран serviceaccount.

Примечания

Примечание

для аутентификации параметр service_account_file можно задать с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
для аутентификации параметр service_account_contents можно задать с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации параметр service_account_email можно задать с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации параметр access_token можно задать с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации параметр 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 complex	Список ресурсов Возвращается: всегда
kmsKeyName string	Имя ресурса Cloud KMS CryptoKey, который будет использоваться для защиты доступа к сообщениям, опубликованным в этой теме. Чтобы использовать эту функцию, учетной записи службы PubSub проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) необходимо назначить роль `roles/cloudkms.cryptoKeyEncrypterDecrypter`. Ожидаемый формат: `projects//locations//keyRings//cryptoKeys/` . Возвращается: при успехе
labels dictionary	Набор пар ключ/значение меток, назначаемых этой теме. Возвращается: при успехе
messageStoragePolicy complex	Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в этой теме. Если политика не задана, ограничения не применяются. Возвращается: при успехе
allowedPersistenceRegions list / elements=string	Список идентификаторов регионов GCP, в которых могут храниться сообщения, опубликованные в этой теме. Сообщения, опубликованные издателями, работающими в регионах GCP, не входящих в список разрешенных (или за пределами GCP), будут направляться для хранения в один из разрешенных регионов. Пустой список означает, что ни один регион не разрешен, и не является допустимой конфигурацией. Возвращается: при успехе
name string	Имя темы. Возвращается: при успехе
schemaSettings complex	Настройки проверки публикуемых сообщений по схеме. Возвращается: при успехе
encoding string	Кодировка сообщений, проверяемых по схеме. Возвращается: при успехе
schema string	Имя схемы, по которой должны проверяться публикуемые сообщения. Формат: projects/{project}/schemas/{schema}. Значение этого поля будет равно _deleted-schema_, если схема удалена. Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

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