google.cloud.gcp_iam_service_account_key 模块 – 创建 GCP ServiceAccountKey

注意

此模块是 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_key。

注意

由于违反了 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"`
env_type 字符串	指定您正在其中运行此模块的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
key_algorithm 字符串	指定密钥的算法。一些有效的选择包括：“KEY_ALG_UNSPECIFIED”、“KEY_ALG_RSA_1024”、“KEY_ALG_RSA_2048”
path path	将保存服务帐户私钥的文件的完整名称。如果文件已存在，它将尝试读取。确保该文件不存在或已是有效密钥。文件路径必须是绝对路径。
private_key_type 字符串	服务帐户密钥的输出格式。一些有效的选择包括：“TYPE_UNSPECIFIED”、“TYPE_PKCS12_FILE”、“TYPE_GOOGLE_CREDENTIALS_FILE”
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account 字典	serviceAccount 的名称。此字段表示指向 GCP 中 ServiceAccount 资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“name”，值为您的资源名称。或者，您可以将 `register: name-of-resource` 添加到 gcp_iam_service_account 任务，然后将此 service_account 字段设置为 “{{ name-of-resource }}”
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file path	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定的对象是否应存在于 GCP 中选择 `"present"` ← （默认） `"absent"`

示例 

- name: create a service account
  google.cloud.gcp_iam_service_account:
    name: test-ansible@graphite-playground.google.com.iam.gserviceaccount.com
    display_name: My Ansible test key
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: serviceaccount

- name: create a service account key
  google.cloud.gcp_iam_service_account_key:
    service_account: "{{ serviceaccount }}"
    private_key_type: TYPE_GOOGLE_CREDENTIALS_FILE
    path: "~/test_account.json"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
keyAlgorithm 字符串	指定密钥的算法。返回：成功
keyType 字符串	指定密钥的类型。可能的值包括 KEY_TYPE_UNSPECIFIED、USER_MANAGED 和 SYSTEM_MANAGED。返回：成功
name 字符串	密钥的名称。返回：成功
path 字符串	将保存服务帐户私钥的文件的完整名称。如果文件已存在，它将尝试读取。确保该文件不存在或已是有效密钥。文件路径必须是绝对路径。返回：成功
privateKeyData 字符串	私钥数据。Base-64 编码。返回：成功
privateKeyType 字符串	服务帐户密钥的输出格式。返回：成功
publicKeyData 字符串	公钥数据。Base-64 编码。返回：成功
serviceAccount 字典	serviceAccount 的名称。返回：成功
validAfterTime 字符串	密钥只能在此时间之后使用。返回：成功
validBeforeTime 字符串	密钥只能在此时间之前使用。返回：成功

作者

Google Inc. (@googlecloudplatform)