community.general.bitbucket_pipeline_variable 模块 – 管理 Bitbucket 管道变量

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定： community.general.bitbucket_pipeline_variable。

概要 

管理 Bitbucket 管道变量。

参数 

参数	注释
client_id 字符串	OAuth 消费者密钥。如果未设置，将使用环境变量 `BITBUCKET_CLIENT_ID`。
client_secret 字符串	OAuth 消费者密钥。如果未设置，将使用环境变量 `BITBUCKET_CLIENT_SECRET`。
name 字符串 / 必填	管道变量名称。
password 字符串自 community.general 4.0.0 版本起添加	应用密码。如果未设置，将使用环境变量 `BITBUCKET_PASSWORD`。
repository 字符串 / 必填	仓库名称。
secured 布尔值	是否加密变量值。选项 `false` ← (默认) `true`
state 字符串 / 必填	指示变量的所需状态。选项 `"absent"` `"present"`
user 别名：username 字符串自 community.general 4.0.0 版本起添加	用户名。如果未设置，将使用环境变量 `BITBUCKET_USERNAME`。 `username` 是 `user` 的别名，自 community.general 6.0.0 版本起。在此之前，它是 `workspace` 的别名。
value 字符串	管道变量值。
workspace 字符串 / 必填	仓库所有者。注意：`username` 曾是此选项的别名。自 community.general 6.0.0 版本起，它是 `user` 的别名。

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	处于 diff 模式时，将返回有关已更改内容（或可能需要在 `check_mode` 下更改的内容）的详细信息。

备注 

注意

支持检查模式。
对于已加密的值，返回参数 changed 始终为 true。
Bitbucket OAuth 消费者密钥和密钥可以从 Bitbucket 个人资料 -> 设置 -> 访问管理 -> OAuth 获取。
Bitbucket 应用密码可以从 Bitbucket 个人资料 -> 个人设置 -> 应用密码创建。
如果同时传递 OAuth 和基本身份验证凭据，则 OAuth 凭据优先。

示例 

- name: Create or update pipeline variables from the list
  community.general.bitbucket_pipeline_variable:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    name: '{{ item.name }}'
    value: '{{ item.value }}'
    secured: '{{ item.secured }}'
    state: present
  with_items:
    - { name: AWS_ACCESS_KEY, value: ABCD1234, secured: false }
    - { name: AWS_SECRET, value: qwe789poi123vbn0, secured: true }

- name: Remove pipeline variable
  community.general.bitbucket_pipeline_variable:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    name: AWS_ACCESS_KEY
    state: absent

作者

Evgeniy Krysanov (@catcombo)