Модуль google.cloud.gcp_iam_role — создание роли GCP

Примечание

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

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

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

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

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

Обзор

Роль в API Identity and Access Management.

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Понятное описание роли.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он влияет только на строку User Agent для запросов API.
included_permissions list / elements=string	Названия разрешений, предоставляемых этой ролью при назначении в политике IAM.
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.
stage string	Текущий этап выпуска роли. Допустимые варианты: «ALPHA», «BETA», «GA», «DEPRECATED», «DISABLED», «EAP»
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
title string	Понятное название роли. Обычно оно ограничено 100 байтами в кодировке UTF-8.

Примеры

- name: create a role
  google.cloud.gcp_iam_role:
    name: myCustomRole2
    title: My Custom Role
    description: My custom role description
    included_permissions:
    - iam.roles.list
    - iam.roles.create
    - iam.roles.delete
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
deleted boolean	Текущее состояние удаления роли. Возвращается: success
description string	Понятное описание роли. Возвращается: success
includedPermissions list / elements=string	Названия разрешений, предоставляемых этой ролью при назначении в политике IAM. Возвращается: success
name string	Название роли. Возвращается: success
stage string	Текущий этап выпуска роли. Возвращается: success
title string	Понятное название роли. Обычно оно ограничено 100 байтами в кодировке UTF-8. Возвращается: success

Авторы

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