Spec-Zone.ru › Ansible

модуль google.cloud.gcp_cloudfunctions_cloud_function_info — сбор сведений о GCP CloudFunction

Примечание

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

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

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

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

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

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

  • Сбор сведений о GCP CloudFunction

Требования

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

  • 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.

location

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.

Примечания

Примечание

  • Для аутентификации можно задать 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 cloud function
  gcp_cloudfunctions_cloud_function_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ

Описание

resources

complex

Список ресурсов

Возвращается: всегда

availableMemoryMb

integer

Объем памяти в МБ, доступный для функции.

Возвращается: при успехе

description

string

Описание функции, заданное пользователем.

Возвращается: при успехе

entryPoint

string

Имя функции (как оно определено в исходном коде), которая будет выполнена.

Если значение не указано, по умолчанию используется суффикс имени ресурса. Для обратной совместимости, если функция с указанным именем не найдена, система попытается использовать функцию с именем “function”. Для Node.js это имя функции, экспортируемой модулем, указанным в source_location.

Возвращается: при успехе

environmentVariables

dictionary

Переменные среды, доступные во время выполнения функции.

Возвращается: при успехе

eventTrigger

complex

Тип источника с конечной точкой HTTPS, который можно активировать по URL.

Возвращается: при успехе

eventType

string

Тип отслеживаемого события. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`.

Возвращается: при успехе

resource

string

Ресурс или ресурсы, для которых нужно отслеживать события, например `projects/_/buckets/myBucket.` .

Возвращается: при успехе

service

string

Имя хоста службы, которую следует отслеживать.

Возвращается: при успехе

httpsTrigger

complex

Тип источника с конечной точкой HTTPS, который можно активировать по URL.

Возвращается: при успехе

url

string

URL развернутой функции.

Возвращается: при успехе

labels

dictionary

Набор пар «ключ/значение», связанных с этой Cloud Function.

Возвращается: при успехе

location

string

Расположение этой облачной функции.

Возвращается: при успехе

name

string

Имя функции, заданное пользователем. Имена функций должны быть глобально уникальными и соответствовать шаблону `projects/*/locations/*/functions/*`.

Возвращается: при успехе

runtime

string

Среда выполнения, в которой будет работать функция. Если значение не указано, по умолчанию используется Node.js 6.

Возвращается: при успехе

serviceAccountEmail

string

Адрес электронной почты учетной записи службы для этой функции.

Возвращается: при успехе

sourceArchiveUrl

string

URL Google Cloud Storage, начинающийся с gs:// и указывающий на zip-архив с функцией.

Возвращается: при успехе

sourceRepository

complex

Репозиторий исходного кода, в котором размещена функция.

Возвращается: при успехе

deployedUrl

string

URL размещенного репозитория, в котором была определена функция на момент развертывания.

Возвращается: при успехе

url

string

URL размещенного репозитория, в котором определена функция.

Возвращается: при успехе

sourceUploadUrl

string

Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода.

Возвращается: при успехе

status

string

Состояние развертывания функции.

Возвращается: при успехе

timeout

string

Время ожидания выполнения функции. Если по истечении этого периода функция не завершится, выполнение считается неудачным и может быть прервано. По умолчанию — 60 секунд.

Возвращается: при успехе

trigger_http

boolean

Использовать HTTP для активации этой функции.

Возвращается: при успехе

updateTime

string

Время последнего обновления Cloud Function.

Возвращается: при успехе

versionId

string

Идентификатор версии Cloud Function. При каждой попытке развертывания создается новая версия функции.

Возвращается: при успехе

Авторы

  • 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_cloudfunctions_cloud_function_info_module.html

Spec-Zone.ru

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