Модуль google.cloud.gcp_serviceusage_service — Создает службу GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможная установка этой коллекции, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
disable_dependent_services булево | Указывает, должны ли быть отключены зависимые службы. Может быть включено только если служба отключена. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это влияет только на строку User Agent для всех запросов API. |
name строка / обязательно | Имя ресурса службы. |
project строка | Проект Google Cloud Platform, который следует использовать. |
scopes список / элементы=строка | Массив используемых областей. |
| ... | ... |
Примечания
Примечание
- Начало работы: https://cloud.google.com/service-usage/docs/getting-started
- для аутентификации можно установить 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 сложный | Настройка сервиса доступного сервиса. Возвращается: успех |
|
apis сложный |
Список интерфейсов API, экспортируемых этим сервисом. Возвращается: успех |
|
name строка |
Имя API. Возвращается: успех |
|
version строка |
Версия API. Возвращается: успех |
|
name строка |
DNS-адрес, по которому доступен этот сервис. Возвращается: успех |
|
title строка |
Название продукта для этого сервиса. Возвращается: успех |
disableDependentServices булево | Указывает, следует ли также отключать зависимые службы. Может быть включено только в том случае, если служба отключена. Возвращается: успех |
name строка | Имя ресурса службы. Возвращается: успех |
parent строка | Имя родителя этой службы. Например, ‘projects/123’. Возвращается: успех |
state строка | Включен ли сервис для использования потребителем. Возвращается: успех |
Ссылки на коллекцию
© 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_module.html