google.cloud.gcp_cloudfunctions_cloud_function_info 模块 – 收集 GCP CloudFunction 的信息

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 Playbook 中使用它，请指定：google.cloud.gcp_cloudfunctions_cloud_function_info。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中移除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅讨论线程。

概要

  • 收集 GCP CloudFunction 的信息

要求

执行此模块的主机上需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

指定您正在其中运行此模块的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

location

字符串 / 必需

此云功能的位置。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / elements=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

备注

注意

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

  • 只有未设置 Playbook 值时，才会使用环境变量值。

  • 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

复杂

资源列表

已返回： 总是

availableMemoryMb

整数

函数可用的内存量，以 MB 为单位。

已返回： 成功

description

字符串

用户提供的函数描述。

已返回： 成功

entryPoint

字符串

要执行的函数名称（在源代码中定义）。

如果未指定，则默认为资源名称后缀。为了向后兼容，如果找不到给定名称的函数，则系统将尝试使用名为“function”的函数。对于 Node.js，这是 source_location 中指定的模块导出的函数名称。

已返回： 成功

environmentVariables

字典

在函数执行期间应可用的环境变量。

已返回： 成功

eventTrigger

复杂

可以通过 URL 触发的 HTTPS 端点类型的源。

已返回： 成功

eventType

字符串

要观察的事件类型。例如：`providers/cloud.storage/eventTypes/object.change` 和 `providers/cloud.pubsub/eventTypes/topic.publish`。

已返回： 成功

resource

字符串

从中观察事件的资源，例如 `projects/_/buckets/myBucket.` 。

已返回： 成功

service

字符串

应该被观察的服务的主机名。

已返回： 成功

https触发器

复杂

可以通过 URL 触发的 HTTPS 端点类型的源。

已返回： 成功

url

字符串

该函数的已部署 URL。

已返回： 成功

标签

字典

与此云函数关联的一组键/值标签对。

已返回： 成功

location

字符串

此云功能的位置。

已返回： 成功

名称

字符串

用户定义的函数名称。函数名称必须在全局范围内唯一，并且与模式 `projects/*/locations/*/functions/*` 匹配。

已返回： 成功

运行时

字符串

函数将要运行的运行时环境。如果为空，则默认为 Node.js 6。

已返回： 成功

服务帐户电子邮件

字符串

此函数的服务帐户的电子邮件地址。

已返回： 成功

源存档 URL

字符串

指向包含该函数的 zip 存档的 Google Cloud Storage URL，以 gs:// 开头。

已返回： 成功

源存储库

复杂

托管函数的源存储库。

已返回： 成功

已部署 URL

字符串

指向在部署时定义该函数的托管存储库的 URL。

已返回： 成功

url

字符串

指向定义该函数的托管存储库的 URL。

已返回： 成功

源上传 URL

字符串

用于源上传的 Google Cloud Storage 签名 URL。

已返回： 成功

状态

字符串

函数部署的状态。

已返回： 成功

超时

字符串

函数执行超时时间。如果在超时时间结束时函数未完成，则认为执行失败并可以终止。默认为 60 秒。

已返回： 成功

触发器_http

布尔值

使用 HTTP 触发此函数。

已返回： 成功

更新时间

字符串

云函数的最后更新时间戳。

已返回： 成功

版本 ID

字符串

云函数的版本标识符。每次部署尝试都会创建一个新的函数版本。

已返回： 成功

作者

  • Google Inc. (@googlecloudplatform)