Модуль google.cloud.gcp_serviceusage_service_info – Сбор информации о службе GCP

Примечание

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

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

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

Для использования в playbook укажите: google.cloud.gcp_serviceusage_service_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.
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.
значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a service
  gcp_serviceusage_service_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
resources сложное	Список ресурсов Возвращается: всегда
config сложное	Конфигурация службы доступной службы. Возвращается: успешно
apis сложное	Список интерфейсов API, экспортированных этой службой. Возвращается: успешно
name строка	Имя API. Возвращается: успешно
version строка	Версия API. Возвращается: успешно
name строка	DNS-адрес, на котором доступна эта служба. Возвращается: успешно
title строка	Название продукта для этой службы. Возвращается: успешно
disableDependentServices логическое	Указывает, следует ли также отключать зависимые службы. Может быть включено только в случае отключения службы. Возвращается: успешно
name строка	Имя ресурса службы. Возвращается: успешно
parent строка	Имя родителя этой службы. Например, «projects/123». Возвращается: успешно
state строка	Включена ли служба для использования потребителем. Возвращается: успешно

Авторы

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