Модуль google.cloud.gcp_iam_service_account_info — Сбор информации о GCP ServiceAccount

Примечание

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

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о GCP ServiceAccount

Требования

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

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_contents jsonarg	Содержание файла Service Account в формате JSON, либо как строка JSON, его представляющая.
service_account_email строка	Опциональный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу Service Account в формате 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 service account
  gcp_iam_service_account_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
displayName строка	Описание учетной записи службы, указанное пользователем. Возвращается: успешно
email строка	Электронный адрес учетной записи службы. Возвращается: успешно
name строка	Имя учетной записи службы. Возвращается: успешно
oauth2ClientId строка	Идентификатор клиента OAuth2 для учетной записи службы. Возвращается: успешно
projectId строка	Идентификатор проекта, которому принадлежит учетная запись службы. Возвращается: успешно
uniqueId строка	Уникальный и стабильный идентификатор учетной записи службы. Возвращается: успешно

Авторы

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