модуль google.cloud.gcp_sql_user — создает пользователя GCP

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_sql_user.

Краткое описание
Требования
Параметры
Примеры
Возвращаемые значения

Краткое описание

Ресурс Users представляет пользователя базы данных в экземпляре Cloud SQL.

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для всех запросов API.
host string / обязательный	Имя узла, с которого пользователь может подключаться. Для операций вставки значение host по умолчанию — пустая строка. Для операций обновления host указывается как часть URL запроса. Имя узла нельзя изменить после вставки.
instance dictionary / обязательный	Имя экземпляра Cloud SQL. Идентификатор проекта не включается. Это поле представляет ссылку на ресурс Instance в GCP. Его можно задать двумя способами. Во-первых, можно указать словарь с ключом ‘name’ и значением, равным имени ресурса. В качестве альтернативы можно добавить `register: name-of-resource` в задачу gcp_sql_instance, а затем задать для этого поля instance значение “{{ name-of-resource }}”
name string / обязательный	Имя пользователя в экземпляре Cloud SQL.
password string	Пароль пользователя.
project string	Проект Google Cloud Platform, который будет использоваться.
scopes list / elements=string	Массив областей доступа, которые будут использоваться
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы: словарь или JSON-строка, представляющая это содержимое.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли указанный объект существовать в 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 string	Имя узла, с которого пользователь может подключаться. Для операций вставки значение host по умолчанию — пустая строка. Для операций обновления host указывается как часть URL запроса. Имя узла нельзя изменить после вставки. Возвращается: success
instance dictionary	Имя экземпляра Cloud SQL. Идентификатор проекта не включается. Возвращается: success
name string	Имя пользователя в экземпляре Cloud SQL. Возвращается: success
password string	Пароль пользователя. Возвращается: success

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_sql_user_module.html