Модуль google.cloud.gcp_spanner_database_info — сбор сведений о базе данных GCP

Примечание

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

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

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

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

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

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

Сбор сведений о базе данных GCP

Требования

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

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.
instance dictionary / обязательный	Экземпляр, в котором нужно создать базу данных. Это поле представляет собой ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, можно передать словарь с ключом ‘name’ и значением, содержащим имя ресурса. Также можно добавить `register: name-of-resource` в задачу gcp_spanner_instance, а затем задать для этого поля instance значение “{{ name-of-resource }}”
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.

Примечания

Примечание

Для аутентификации можно задать service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: get info on a database
  gcp_spanner_database_info:
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
resources complex	Список ресурсов Возвращается: всегда
encryptionConfig complex	Конфигурация шифрования базы данных. Возвращается: при успехе
kmsKeyName string	Полное имя ключа KMS, используемого для шифрования этой базы данных. Этот ключ должен находиться в том же расположении, что и база данных Spanner. Возвращается: при успехе
extraStatements list / elements=string	Необязательный список инструкций DDL для выполнения в только что созданной базе данных. Инструкции могут создавать таблицы, индексы и т. д. Они выполняются атомарно вместе с созданием базы данных: если какая-либо инструкция завершится ошибкой, база данных не будет создана. Возвращается: при успехе
instance dictionary	Экземпляр, в котором нужно создать базу данных. Возвращается: при успехе
name string	Уникальный идентификатор базы данных, который нельзя изменить после создания экземпляра. Значения имеют формат [a-z][-a-z0-9][a-z0-9]. Возвращается:* при успехе

Авторы

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_spanner_database_info_module.html