google.cloud.gcp_resourcemanager_project_info 模块 – 收集 GCP 项目的信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP 项目的信息

要求

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

  • 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 请求的用户代理字符串。

page_size

字符串

指示 API 请求应返回的项目数

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 project
  gcp_resourcemanager_project_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    page_size: 100

返回值

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

键

描述

资源

复杂

资源列表

返回：始终

createTime

字符串

创建时间。

返回：成功

id

字符串

项目的唯一、用户分配的 ID。它必须是 6 到 30 个小写字母、数字或连字符。它必须以字母开头。

禁止使用尾随连字符。

返回：成功

labels

字典

与此项目关联的标签。

标签键的长度必须在 1 到 63 个字符之间，并且必须符合以下正则表达式：`[a-z]([-a-z0-9]*[a-z0-9])?`。

标签值的长度必须在 0 到 63 个字符之间，并且必须符合正则表达式 `([a-z]([-a-z0-9]*[a-z0-9])?)?`。

一个给定的资源最多可以关联 256 个标签。

客户端应将标签存储在诸如 JSON 之类的表示形式中，该表示形式不依赖于禁止使用的特定字符。

返回：成功

lifecycleState

字符串

项目生命周期状态。

返回：成功

name

字符串

项目用户分配的显示名称。它必须是 4 到 30 个字符。允许的字符为：小写和大写字母、数字、连字符、单引号、双引号、空格和感叹号。

返回：成功

number

整数

唯一标识项目的编号。

返回：成功

parent

复杂

父组织。

返回：成功

id

字符串

组织的 ID。

返回：成功

type

字符串

必须是组织。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)