Модуль google.cloud.gcp_iam_service_account — создание ServiceAccount в 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.

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

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

Сервисный аккаунт в API управления идентификацией и доступом.

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
display_name string	Описание сервисного аккаунта, заданное пользователем.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не уверены в своих действиях. Этот параметр меняет только строку User Agent для всех запросов API.
name string	Имя сервисного аккаунта.
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.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примеры

- name: create a service account
  google.cloud.gcp_iam_service_account:
    name: sa-{{ resource_name.split("-")[-1] }}@graphite-playground.google.com.iam.gserviceaccount.com
    display_name: My Ansible test key
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
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_module.html