google.cloud.gcp_cloudbuildv2_connection_info module – List Cloudbuildv2.Connection resources

Note

This module is part of the google.cloud collection (version 1.15.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_cloudbuildv2_connection_info.

Synopsis

  • A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center/Cloud or GitLab.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

  • requests >= 2.18.4

  • google-auth >= 2.25.1

Parameters

Parameter

Comments

access_token

string

The access token used to authenticate.

auth_kind

string / required

The type of credential used.

Choices:

  • "accesstoken"

  • "application"

  • "machineaccount"

  • "serviceaccount"

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

filters

list / elements=string

A list of filter expression strings used to filter the resources returned by the API.

Each string is a filter expression (e.g. some_field = "SOME_VALUE").

Multiple expressions are combined with a logical AND.

Refer to the filter topic documentation https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Refer to the AIP-160 filter syntax documentation https://google.aip.dev/160.

location

string / required

The location for the resource.

project

string

The Google Cloud Platform project to use.

scopes

list / elements=string

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is

selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount

is selected as type.

Notes

Note

  • API Reference: https://cloud.google.com/build/docs/api/reference/rest

  • Official Documentation Guide: https://cloud.google.com/build/docs

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.

  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set access_token using the GCP_ACCESS_TOKEN env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email, service_account_file, service_account_file and access_token options are mutually exclusive.

Examples

- name: List all gcp_cloudbuildv2_connection_info resources
  google.cloud.gcp_cloudbuildv2_connection_info:
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

- name: List gcp_cloudbuildv2_connection_info resources matching given filters
  google.cloud.gcp_cloudbuildv2_connection_info:
    filters:
      - display_name = "my-resource"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Whether any changes were made (always false for info modules).

Returned: always

resources

list / elements=dictionary

List of Cloudbuildv2.Connection resources matching the supplied filters. May be empty, contain a single resource, or multiple resources.

Returned: always

annotations

dictionary

Allows clients to store small amounts of arbitrary data.

**Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.

Returned: when set

bitbucketCloudConfig

dictionary

Configuration for connections to Bitbucket Cloud.

Returned: when set

authorizerCredential

dictionary

An access token with the `webhook`, `repository`, `repository:admin` and `pullrequest` scope access.

It can be either a workspace, project or repository access token.

It’s recommended to use a system account to generate these credentials.

Returned: always

username

string

Output only.

The username associated to this token.

Returned: success

userTokenSecretVersion

string

A SecretManager resource containing the user token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: always

readAuthorizerCredential

dictionary

An access token with the `repository` access.

It can be either a workspace, project or repository access token.

It’s recommended to use a system account to generate the credentials.

Returned: always

username

string

Output only.

The username associated to this token.

Returned: success

userTokenSecretVersion

string

A SecretManager resource containing the user token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: always

webhookSecretSecretVersion

string

SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`.

Returned: always

workspace

string

The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.

Returned: always

bitbucketDataCenterConfig

dictionary

Configuration for connections to Bitbucket Data Center.

Returned: when set

authorizerCredential

dictionary

A http access token with the `REPO_ADMIN` scope access.

Returned: always

username

string

Output only.

The username associated to this token.

Returned: success

userTokenSecretVersion

string

A SecretManager resource containing the user token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: always

hostUri

string

The URI of the Bitbucket Data Center host this connection is for.

Returned: always

readAuthorizerCredential

dictionary

A http access token with the `REPO_READ` access.

Returned: always

username

string

Output only.

The username associated to this token.

Returned: success

userTokenSecretVersion

string

A SecretManager resource containing the user token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: always

serverVersion

string

Output only.

Version of the Bitbucket Data Center running on the `host_uri`.

Returned: success

serviceDirectoryConfig

dictionary

Configuration for using Service Directory to privately connect to a Bitbucket Data Center.

This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet.

If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet.

Returned: when set

service

string

The Service Directory service name.

Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

Returned: always

sslCa

string

SSL certificate to use for requests to the Bitbucket Data Center.

Returned: when set

webhookSecretSecretVersion

string

SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`.

Returned: always

createTime

string

Output only.

Server assigned timestamp for when the connection was created.

Returned: success

disabled

boolean

If disabled is set to true, functionality is disabled for this connection.

Repository based API methods and webhooks processing for repositories in this connection will be disabled.

Returned: when set

etag

string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returned: success

githubConfig

dictionary

Configuration for connections to github.com.

Returned: when set

appInstallationId

integer

GitHub App installation id.

Returned: when set

authorizerCredential

dictionary

OAuth credential of the account that authorized the Cloud Build GitHub App.

It is recommended to use a robot account instead of a human user account.

The OAuth token must be tied to the Cloud Build GitHub App.

Returned: when set

oauthTokenSecretVersion

string

A SecretManager resource containing the OAuth token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: when set

username

string

Output only.

The username associated to this token.

Returned: success

githubEnterpriseConfig

dictionary

Configuration for connections to an instance of GitHub Enterprise.

Returned: when set

appId

integer

Id of the GitHub App created from the manifest.

Returned: when set

appInstallationId

integer

ID of the installation of the GitHub App.

Returned: when set

appSlug

string

The URL-friendly name of the GitHub App.

Returned: when set

hostUri

string

The URI of the GitHub Enterprise host this connection is for.

Returned: always

privateKeySecretVersion

string

SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.

Returned: when set

serviceDirectoryConfig

dictionary

Configuration for using Service Directory to privately connect to a GitHub Enterprise server.

This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet.

If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet.

Returned: when set

service

string

The Service Directory service name.

Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

Returned: always

sslCa

string

SSL certificate to use for requests to GitHub Enterprise.

Returned: when set

webhookSecretSecretVersion

string

SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.

Returned: when set

gitlabConfig

dictionary

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

Returned: when set

authorizerCredential

dictionary

A GitLab personal access token with the `api` scope access.

Returned: always

username

string

Output only.

The username associated to this token.

Returned: success

userTokenSecretVersion

string

A SecretManager resource containing the user token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: always

hostUri

string

The URI of the GitLab Enterprise host this connection is for.

If not specified, the default value is https://gitlab.com.

Returned: when set

readAuthorizerCredential

dictionary

A GitLab personal access token with the minimum `read_api` scope access.

Returned: always

username

string

Output only.

The username associated to this token.

Returned: success

userTokenSecretVersion

string

A SecretManager resource containing the user token that authorizes the Cloud Build connection.

Format: `projects/*/secrets/*/versions/*`.

Returned: always

serverVersion

string

Output only.

Version of the GitLab Enterprise server running on the `host_uri`.

Returned: success

serviceDirectoryConfig

dictionary

Configuration for using Service Directory to privately connect to a GitLab Enterprise server.

This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet.

If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet.

Returned: when set

service

string

The Service Directory service name.

Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

Returned: always

sslCa

string

SSL certificate to use for requests to GitLab Enterprise.

Returned: when set

webhookSecretSecretVersion

string

SecretManager resource containing the webhook secret of a GitLab Enterprise project, formatted as `projects/*/secrets/*/versions/*`.

Returned: always

installationState

dictionary

Output only.

Installation state of the Connection.

Returned: success

actionUri

string

Output only.

Link to follow for next action.

Empty string if the installation is already complete.

Returned: success

message

string

Output only.

Message of what the user should do next to continue the installation.

Empty string if the installation is already complete.

Returned: success

stage

string

Output only.

Current step of the installation process.

Returned: success

reconciling

boolean

Output only.

Set to true when the connection is being set up or updated in the background.

Returned: success

updateTime

string

Output only.

Server assigned timestamp for when the connection was updated.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)