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

Примечание

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

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

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

Для использования в playbook укажите: 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 / required	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Описание роли, понятное человеку.
env_type string	Указывает, в какой среде Ansible вы запускаете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API.
included_permissions list / elements=string	Имена разрешений, которые предоставляет эта роль при привязке в политике IAM.
name string / required	Имя роли.
project string	Проект Google Cloud Platform для использования.
scopes list / elements=string	Массив областей для использования
service_account_contents jsonarg	Содержимое файла Service Account JSON, либо в виде словаря, либо в виде представляющей его JSON-строки.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к файлу Service Account 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	Текущее состояние удаления роли. Возвращено: успех
description string	Описание роли в удобочитаемой форме. Возвращено: успех
includedPermissions list / elements=string	Имена разрешений, предоставляемых этой ролью при привязке в политике IAM. Возвращено: успех
name string	Имя роли. Возвращено: успех
stage string	Текущий этап запуска роли. Возвращено: успех
title string	Удобочитаемое название роли. Обычно ограничено 100 байтами UTF-8. Возвращено: успех

Авторы

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