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。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在未解决的完整性测试失败。请参阅讨论主题以了解更多信息。

摘要 

身份和访问管理 API 中的角色。

要求 

执行此模块的主机需要以下要求。

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description 字符串	角色的人类可读描述。
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
included_permissions 列表 / 元素=字符串	此角色在 IAM 策略中绑定时授予的权限的名称。
name 字符串 / 必需	角色的名称。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
stage 字符串	角色的当前发布阶段。一些有效的选项包括：“ALPHA”、“BETA”、“GA”、“DEPRECATED”、“DISABLED”、“EAP”
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`
title 字符串	角色的人类可读标题。通常，此标题限制为 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 布尔值	角色的当前已删除状态。返回：成功
description 字符串	角色的人类可读描述。返回：成功
includedPermissions 列表 / 元素=字符串	此角色在 IAM 策略中绑定时授予的权限的名称。返回：成功
name 字符串	角色的名称。返回：成功
stage 字符串	角色的当前发布阶段。返回：成功
title 字符串	角色的人类可读标题。通常，此标题限制为 100 个 UTF-8 字节。返回：成功

作者

Google Inc. (@googlecloudplatform)