Модуль google.cloud.gcp_iam_service_account_info — сбор информации о сервисном аккаунте GCP

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_iam_service_account_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 service account
  gcp_iam_service_account_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

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

Авторы

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