google.cloud.gcp_sql_user 模块 – 创建 GCP 用户

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在剧本中使用它，请指定：google.cloud.gcp_sql_user。

注意

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

概要 

Users 资源表示 Cloud SQL 实例中的数据库用户。

要求 

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

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 请求的用户代理字符串。
host 字符串 / 必需	用户可以从中连接的主机名。对于插入操作，主机默认为空字符串。对于更新操作，主机作为请求 URL 的一部分指定。主机名在插入后无法更新。
instance 字典 / 必需	Cloud SQL 实例的名称。这并不包括项目 ID。此字段表示 GCP 中指向 Instance 资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“name”，值为资源的名称。或者，您可以将 `register: name-of-resource` 添加到 gcp_sql_instance 任务，然后将此 instance 字段设置为“{{ name-of-resource }}”
name 字符串 / 必需	Cloud SQL 实例中用户的名称。
password 字符串	用户的密码。
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 instance
  google.cloud.gcp_sql_instance:
    name: "{{resource_name}}-1"
    settings:
      ip_configuration:
        authorized_networks:
        - name: google dns server
          value: 8.8.8.8/32
      tier: db-n1-standard-1
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a user
  google.cloud.gcp_sql_user:
    name: test-user
    host: 10.1.2.3
    password: secret-password
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
host 字符串	用户可以从中连接的主机名。对于插入操作，主机默认为空字符串。对于更新操作，主机作为请求 URL 的一部分指定。主机名在插入后无法更新。返回：成功
instance 字典	Cloud SQL 实例的名称。这并不包括项目 ID。返回：成功
name 字符串	Cloud SQL 实例中用户的名称。返回：成功
password 字符串	用户的密码。返回：成功

作者

Google Inc. (@googlecloudplatform)