Модуль google.cloud.gcp_resourcemanager_project_info — Сбор информации о проекте GCP

Примечание

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

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

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

Для использования в книге задач укажите: google.cloud.gcp_resourcemanager_project_info.

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

Описание

Сбор информации о проекте GCP

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
page_size строка	Указывает количество проектов, которые должны быть возвращены запросом API
project строка	Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка	Массив используемых областей.
...

Примечания

Примечание

для аутентификации можно установить 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 project
  gcp_resourcemanager_project_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    page_size: 100

END_OF_DOCUMENT_MARKER

Значения возвращаемых данных

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

Ключ	Описание
resources complex	Список ресурсов Возвращается: всегда
createTime string	Время создания. Возвращается: при успехе
id string	Уникальный, назначенный пользователем идентификатор проекта. Он должен содержать от 6 до 30 строчных букв, цифр или дефисов. Он должен начинаться с буквы. Запрещены завершающие дефисы. Возвращается: при успехе
labels dictionary	Метки, связанные с этим проектом. Ключи меток должны быть длиной от 1 до 63 символов и должны соответствовать следующему регулярному выражению: `[a-z]([-a-z0-9][a-z0-9])?`. Значения меток должны быть длиной от 0 до 63 символов и должны соответствовать регулярному выражению `([a-z]([-a-z0-9][a-z0-9])?)?`. С заданным ресурсом может быть связано не более 256 меток. Клиенты должны хранить метки в представлении, например, JSON, которое не зависит от конкретных запрещённых символов. Возвращается: при успехе
lifecycleState string	Состояние жизненного цикла проекта. Возвращается: при успехе
name string	Назначенное пользователем отображаемое имя проекта. Оно должно содержать от 4 до 30 символов. Допустимые символы: строчные и прописные буквы, цифры, дефис, одинарная и двойная кавычка, пробел и знак восклицания. Возвращается: при успехе
number integer	Число, уникально идентифицирующее проект. Возвращается: при успехе
parent complex	Родительская организация. Возвращается: при успехе
id string	Идентификатор организации. Возвращается: при успехе
type string	Должно быть organization. Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

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

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