1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-10 11:21:48 +00:00
gcloud-help/gcloud/builds/connections/update/github-enterprise
2024-07-31 09:35:16 +00:00

117 lines
4.3 KiB
Text

NAME
gcloud builds connections update github-enterprise - update a Cloud Build
Connection of type GitHub Enterprise
SYNOPSIS
gcloud builds connections update github-enterprise
(CONNECTION : --region=REGION) [--app-id=APP_ID]
[--app-installation-id=APP_INSTALLATION_ID] [--app-slug=APP_SLUG]
[--async] [--host-uri=HOST_URI]
[--private-key-secret-version=PRIVATE_KEY_SECRET_VERSION]
[--service-directory-service=SERVICE_DIRECTORY_SERVICE]
[--ssl-ca-file=SSL_CA_FILE]
[--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a Cloud Build Connection of type GitHub Enterprise.
EXAMPLES
To update the ssl_ca, provide the connection name and the ssl_ca file:
$ gcloud builds connections update github-enterprise my-ghe-conn \
--region=us-west1 --ssl-ca-file=mycertificate.crt
To update the installation id, provide the connection name and the
installation id of the Cloud Build GitHub app.
$ gcloud builds connections update github-enterprise my-ghe-conn \
--region=us-west1 --app-installation-id=1234
POSITIONAL ARGUMENTS
Connection resource - Connection to update. The arguments in this group
can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other
ways.
To set the project attribute:
◆ provide the argument connection on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
CONNECTION
ID of the connection or fully qualified identifier for the
connection.
To set the connection attribute:
▸ provide the argument connection on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The Google Cloud region.
To set the region attribute:
▸ provide the argument connection on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property builds/region.
FLAGS
--app-id=APP_ID
App ID of the GitHub App in the GitHub Enterprise server.
--app-installation-id=APP_INSTALLATION_ID
Installation ID of the Cloud Build GitHub App.
--app-slug=APP_SLUG
App slug (url-friendly name) of the GitHub App. When seeing the
configuration page of the App (e.g. in
https://my-ghe-server.net/settings/apps/my-app), the app-slug is the
last component of the URL path ("my-app" in that example).
--async
Return immediately, without waiting for the operation in progress to
complete.
--host-uri=HOST_URI
URI of the GitHub Enterprise server.
--private-key-secret-version=PRIVATE_KEY_SECRET_VERSION
Secret containing the private key of the GitHub App.
--service-directory-service=SERVICE_DIRECTORY_SERVICE
Service Directory service resource to use for accessing the GitHub
Enterprise Server. Necessary only if the server has no public access
from the internet.
--ssl-ca-file=SSL_CA_FILE
File containing the SSL_CA to be used.
--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION
Secret containing the webhook secret string for validating webhook
events generated by the GitHub App.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the cloudbuild/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/cloud-build/docs/
NOTES
These variants are also available:
$ gcloud alpha builds connections update github-enterprise
$ gcloud beta builds connections update github-enterprise