google.cloud.gcp_serviceusage_service 模块 – 创建 GCP 服务

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_serviceusage_service。

注意

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

概要

  • 一个可供使用的服务。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必选

使用的凭证类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

disable_dependent_services

布尔值

指示是否也应禁用依赖服务。仅当服务被禁用时才能启用。

选择

  • false

  • true

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

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

这只会更改任何 API 请求的 User Agent 字符串。

name

字符串 / 必选

服务的资源名称。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

state

字符串

给定对象是否应存在于 GCP 中

选择

  • "present" ← (默认)

  • "absent"

备注

注意

  • 入门：https://cloud.google.com/service-usage/docs/getting-started

  • 对于身份验证，您可以使用 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: 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

字符串

该服务是否已启用供消费者使用。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)