Spec-Zone.ru › Ansible 2.10

google.cloud.gcp_serviceusage_service – Создаёт GCP-сервис

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.1).

Для его установки используйте: ansible-galaxy collection install google.cloud.

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

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

Описание

  • Сервис, доступный для использования.

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательный
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
disable_dependent_services
булево
    Варианты:
  • no
  • yes
Указывает, следует ли также отключать зависимые сервисы. Может быть включено только в случае отключения сервиса.
env_type
строка
Указывает, в какой среде Ansible выполняется этот модуль.
Это значение следует задавать только при необходимости.
Это значение изменяет только строку User Agent для всех запросов к API.
name
строка / обязательный
Имя ресурса сервиса.
project
строка
Проект Google Cloud Platform для использования.
scopes
список / элементы=строка
Массив используемых областей доступа.
service_account_contents
jsonarg
Содержание JSON-файла учетной записи сервиса, представленного в виде словаря или JSON-строки.
service_account_email
строка
Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file
путь
Путь к JSON-файлу учетной записи сервиса, если тип serviceaccount выбран в качестве типа.
state
строка
    Варианты:
  • present ←
  • absent
Указывает, должен ли данный объект существовать в GCP

Примечания

Примечание

  • Начало работы: 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.
  • для аутентификации можно задать 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
сложное
success
Конфигурация сервиса доступного сервиса.

apis
сложное
success
Список интерфейсов API, экспортируемых этим сервисом.

name
строка
success
Имя API.

version
строка
success
Версия API.

name
строка
success
DNS-адрес, по которому доступен этот сервис.

title
строка
success
Название продукта для этого сервиса.

disableDependentServices
булево
success
Указывает, следует ли также отключать зависимые сервисы. Может быть включено только в случае отключения сервиса.

name
строка
success
Имя ресурса сервиса.

parent
строка
success
Имя родителя этого сервиса. Например, 'projects/123'.

state
строка
success
Включен ли сервис для использования потребителем.



Авторы

  • Google Inc. (@googlecloudplatform)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API