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。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：google.cloud.gcp_iam_service_account。

注意

由于违反了 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"

display_name

字符串

用户指定的服务账号描述。

env_type

字符串

指定您正在其中运行此模块的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

name

字符串

服务账号的名称。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务账号 JSON 文件的内容，可以是字典形式，也可以是代表它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 且用户不希望使用默认电子邮件，则为可选的服务账号电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务账号 JSON 文件的路径。

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 客户端 ID。

返回：成功

projectId

字符串

拥有服务账号的项目 ID。

返回：成功

uniqueId

字符串

服务账号的唯一且稳定的 ID。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)