Модуль google.cloud.gcp_pubsub_topic_info – Сбор информации о теме GCP

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Устанавливать не рекомендуется, если вы не знаете, что делаете. Это только изменяет строку User Agent для всех запросов к API.
project строка	Проект Google Cloud Platform для использования.
scopes список / элементы=строка	Массив используемых областей
...	...

Примечания

Примечание

для аутентификации можно установить 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"

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
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 строка	Имя темы. Возвращается: успешно
schemaSettings сложный	Параметры проверки сообщений, опубликованных по схеме. Возвращается: успешно
encoding строка	Кодировка сообщений, проверенных по схеме. Возвращается: успешно
schema строка	Имя схемы, по которой должны проверяться опубликованные сообщения. Формат проектов/{project}/schemas/{schema}. Значение этого поля будет _deleted-schema_, если схема была удалена. Возвращается: успешно

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на сборки

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