Модуль google.cloud.gcp_serviceusage_service — создание службы GCP

Примечание

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

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

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

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

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

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

Служба, доступная для использования.

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если в качестве типа учетных данных выбран accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
disable_dependent_services boolean	Указывает, следует ли также отключить зависимые службы. Можно включить, только если служба отключена. Варианты: `false` `true`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для всех запросов API.
name string / обязательный	Имя ресурса службы.
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.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Начало работы: https://cloud.google.com/service-usage/docs/getting-started
Для работы этого модуля служба serviceusage.googleapis.com уже должна быть включена: https://cloud.google.com/service-usage/docs/enable-disable#gcloud.
Для аутентификации можно задать 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: create a service
  google.cloud.gcp_serviceusage_service:
    name: spanner.googleapis.com
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

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

Авторы

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