google.cloud.gcp_resourcemanager_project 模块 – 创建 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
。
注意
由于违反了 Ansible 包含要求,google.cloud 集合将从 Ansible 12 中删除。该集合存在未解决的健全性测试失败。有关更多信息,请参阅讨论主题。
概要
表示一个 GCP 项目。项目是 ACL、API、App Engine 应用、VM 和其他 Google Cloud Platform 资源的容器。
要求
执行此模块的主机上需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
---|---|
如果凭据类型为 accesstoken,则为 OAuth2 访问令牌。 |
|
使用的凭据类型。 选择
|
|
指定您在哪个 Ansible 环境中运行此模块。 除非您知道自己在做什么,否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
项目的唯一、用户分配的 ID。它必须是 6 到 30 个小写字母、数字或连字符。它必须以字母开头。 禁止尾随连字符。 |
|
与此项目关联的标签。 标签键的长度必须在 1 到 63 个字符之间,并且必须符合以下正则表达式:`[a-z]([-a-z0-9]*[a-z0-9])?`。 标签值的长度必须在 0 到 63 个字符之间,并且必须符合正则表达式 `([a-z]([-a-z0-9]*[a-z0-9])?)?`。 一个给定资源最多可以关联 256 个标签。 客户端应将标签存储在诸如 JSON 之类的表示形式中,该表示形式不依赖于特定字符被禁止。 |
|
项目的用户分配显示名称。它必须是 4 到 30 个字符。允许的字符是:小写和大写字母、数字、连字符、单引号、双引号、空格和感叹号。 |
|
父组织。 |
|
组织的 ID。 |
|
必须是组织。 |
|
要使用的 Google Cloud Platform 项目。 |
|
要使用的范围数组 |
|
服务帐户 JSON 文件的内容,可以作为字典或表示它的 JSON 字符串。 |
|
如果选择了 machineaccount 并且用户不希望使用默认电子邮件,则可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型,则为服务帐户 JSON 文件的路径。 |
|
给定对象是否应存在于 GCP 中 选择
|
示例
- name: create a project
google.cloud.gcp_resourcemanager_project:
name: My Sample Project
id: ansible-test-{{ 10000000000 | random }}
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
parent:
type: organization
id: 636173955921
state: present
返回值
此处记录了常见的返回值 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
创建时间。 返回: 成功 |
|
项目的唯一、用户分配的 ID。它必须是 6 到 30 个小写字母、数字或连字符。它必须以字母开头。 禁止尾随连字符。 返回: 成功 |
|
与此项目关联的标签。 标签键的长度必须在 1 到 63 个字符之间,并且必须符合以下正则表达式:`[a-z]([-a-z0-9]*[a-z0-9])?`。 标签值的长度必须在 0 到 63 个字符之间,并且必须符合正则表达式 `([a-z]([-a-z0-9]*[a-z0-9])?)?`。 一个给定资源最多可以关联 256 个标签。 客户端应将标签存储在诸如 JSON 之类的表示形式中,该表示形式不依赖于特定字符被禁止。 返回: 成功 |
|
项目生命周期状态。 返回: 成功 |
|
项目的用户分配显示名称。它必须是 4 到 30 个字符。允许的字符是:小写和大写字母、数字、连字符、单引号、双引号、空格和感叹号。 返回: 成功 |
|
唯一标识项目的编号。 返回: 成功 |
|
父组织。 返回: 成功 |
|
组织的 ID。 返回: 成功 |
|
必须是组织。 返回: 成功 |