Модуль google.cloud.gcp_iam_service_account – Создаёт GCP учётную запись сервиса

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
display_name строка	Описание учётной записи сервиса, заданное пользователем.
env_type строка	Указывает среду Ansible, в которой выполняется модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов API.
name строка	Имя учётной записи сервиса.
project строка	Используемый проект Google Cloud Platform.
scopes список / элементы=строка	Массив используемых областей.
service_account_contents jsonarg	Содержимое файла JSON учётной записи сервиса, либо в виде словаря, либо в виде строки JSON, которая его представляет.
service_account_email строка	Дополнительный адрес электронной почты учётной записи сервиса, если выбран тип machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учётной записи сервиса, если тип выбран как serviceaccount.
state строка	Определяет, должен ли указанный объект существовать в 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 строка	Описание учетной записи службы, заданное пользователем. Возвращено: успех
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_module.html