google.cloud.gcp_pubsub_topic_info 模块 – 收集 GCP 主题信息

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_pubsub_topic_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 请求的用户代理字符串。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

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

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

kmsKeyName

字符串

用于保护对发布到此主题的消息的访问权限的 Cloud KMS CryptoKey 的资源名称。您的项目的 PubSub 服务帐户（`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) 必须具有 `roles/cloudkms.cryptoKeyEncrypterDecrypter` 才能使用此功能。

预期格式为 `projects/*/locations/*/keyRings/*/cryptoKeys/*`。

返回：成功

labels

字典

要分配给此主题的一组键/值标签对。

返回：成功

messageStoragePolicy

复杂

限制发布到主题的消息可能存储在其中的 Google Cloud Platform 区域集的策略。如果不存在，则没有任何约束生效。

返回：成功

allowedPersistenceRegions

列表 / 元素=字符串

发布到主题的消息可能持久存储在其中的 GCP 区域 ID 列表。由在非允许的 GCP 区域（或完全在 GCP 外运行）中运行的发布者发布的消息将被路由到允许的区域之一进行存储。空列表表示不允许任何区域，这不是有效的配置。

返回：成功

name

字符串

主题名称。

返回：成功

schemaSettings

复杂

用于根据模式验证已发布消息的设置。

返回：成功

encoding

字符串

根据模式验证的消息的编码。

返回：成功

schema

字符串

应针对其验证已发布消息的模式名称。格式为 projects/{project}/schemas/{schema}。

如果模式已被删除，则此字段的值将为 _deleted-schema_。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)