Модуль google.cloud.gcp_resourcemanager_project_info — сбор сведений о проекте GCP

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string	Токен доступа OAuth2, если выбран тип учетных данных accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для всех запросов к API.
page_size integer	Указывает количество проектов, которое должен вернуть запрос к API.
project string	Проект Google Cloud Platform, который следует использовать.
scopes list / элементы=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 project
  gcp_resourcemanager_project_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    page_size: 100

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

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

Ключ	Описание
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_resourcemanager_project_info_module.html