google.cloud.gcp_cloudfunctions_cloud_function 模块 – 创建 GCP Cloud Function

注意

此模块是 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。

注意

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

概要 

一个 Cloud Function，包含响应事件执行的用户计算。

要求 

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

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
available_memory_mb 整数	函数可用的内存量（MB）。
description 字符串	用户提供的函数描述。
entry_point 字符串	将要执行的函数名称（如源代码中定义）。如果未指定，则默认为资源名称后缀。为了向后兼容，如果找不到具有给定名称的函数，则系统将尝试使用名为“function”的函数。对于 Node.js，这是 source_location 中指定的模块导出的函数名称。
env_type 字符串	指定您在其中运行此模块的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
environment_variables 字典	在函数执行期间应可用的环境变量。
event_trigger 字典	一种可以通过 URL 触发的 HTTPS 端点类型的源。
event_type 字符串 / 必需	要观察的事件类型。例如：`providers/cloud.storage/eventTypes/object.change` 和 `providers/cloud.pubsub/eventTypes/topic.publish`。
resource 字符串 / 必需	要从中观察事件的资源，例如，`projects/_/buckets/myBucket.`。
service 字符串	应该观察的服务的主机名。
https_trigger 字典	一种可以通过 URL 触发的 HTTPS 端点类型的源。
labels 字典	与此 Cloud Function 关联的一组键/值标签对。
location 字符串 / 必需	此云函数的位置。
name 字符串 / 必需	用户定义的函数名称。函数名称必须全局唯一，并与模式 `projects//locations//functions/*` 匹配。
project 字符串	要使用的 Google Cloud Platform 项目。
runtime 字符串	运行函数的运行时。部署新函数时为必需，更新现有函数时为可选。
scopes 列表 / elements=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
source_archive_url 字符串	Google Cloud Storage URL，以 gs:// 开头，指向包含该函数的 zip 存档。
source_repository 字典	函数托管的源存储库。
url 字符串 / 必需	指向定义函数的托管存储库的 URL。
source_upload_url 字符串	用于源上传的 Google Cloud Storage 签名 URL。
state 字符串	给定对象是否应存在于 GCP 中选项 `"present"` ←（默认） `"absent"`
timeout 字符串	函数执行超时。如果在超时结束时函数未完成，则认为执行失败并可以终止。默认为 60 秒。
trigger_http 布尔值	使用 HTTP 触发此函数。选项 `false` `true`

示例 

- name: create a cloud function
  google.cloud.gcp_cloudfunctions_cloud_function:
    name: test_object
    location: us-central1
    entry_point: helloGET
    source_archive_url: gs://ansible-cloudfunctions-bucket/function.zip
    trigger_http: 'true'
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
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 字符串	应该观察的服务的主机名。已返回: 成功
httpsTrigger 复杂	一种可以通过 URL 触发的 HTTPS 端点类型的源。已返回: 成功
url 字符串	该函数的已部署 URL。已返回: 成功
labels 字典	与此 Cloud Function 关联的一组键/值标签对。已返回: 成功
location 字符串	此云函数的位置。已返回: 成功
name 字符串	用户定义的函数名称。函数名称必须全局唯一，并与模式 `projects//locations//functions/` 匹配。已返回:* 成功
runtime 字符串	函数将要在其中运行的运行时。如果为空，则默认为 Node.js 6。已返回: 成功
serviceAccountEmail 字符串	此函数的服务帐户的电子邮件。已返回: 成功
sourceArchiveUrl 字符串	Google Cloud Storage URL，以 gs:// 开头，指向包含该函数的 zip 存档。已返回: 成功
sourceRepository 复杂	函数托管的源存储库。已返回: 成功
deployedUrl 字符串	指向托管存储库的 URL，该存储库在部署时定义了函数。已返回: 成功
url 字符串	指向定义函数的托管存储库的 URL。已返回: 成功
sourceUploadUrl 字符串	用于源上传的 Google Cloud Storage 签名 URL。已返回: 成功
status 字符串	函数部署的状态。已返回: 成功
timeout 字符串	函数执行超时。如果在超时结束时函数未完成，则认为执行失败并可以终止。默认为 60 秒。已返回: 成功
trigger_http 布尔值	使用 HTTP 触发此函数。已返回: 成功
updateTime 字符串	云函数的最后更新时间戳。已返回: 成功
versionId 字符串	云函数的版本标识符。每次部署尝试都会导致创建函数的新版本。已返回: 成功

作者

Google Inc. (@googlecloudplatform)