1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-16 12:22:03 +00:00

gcloud: Wed Apr 2 10:41:45 UTC 2025

This commit is contained in:
Automated 2025-04-02 10:41:45 +00:00
parent be9483c980
commit 4637d39593
282 changed files with 9293 additions and 700 deletions

View file

@ -0,0 +1,180 @@
NAME
gcloud alpha developer-connect account-connectors create - create
accountConnectors
SYNOPSIS
gcloud alpha developer-connect account-connectors create
(ACCOUNT_CONNECTOR : --location=LOCATION)
[--annotations=[ANNOTATIONS,...]] [--async] [--etag=ETAG]
[--labels=[LABELS,...]] [--request-id=REQUEST_ID] [--validate-only]
[--provider-oauth-config-scopes=[PROVIDER_OAUTH_CONFIG_SCOPES,...]
: --provider-oauth-config-system-id=PROVIDER_OAUTH_CONFIG_SYSTEM_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create an accountConnector
EXAMPLES
To create the accountConnector, run:
$ gcloud alpha developer-connect account-connectors create
POSITIONAL ARGUMENTS
AccountConnector resource - Identifier. The resource name of the
userConnection, in the format
projects/{project}/locations/{location}/accountConnectors/{account_connector_id}.
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 account_connector 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.
ACCOUNT_CONNECTOR
ID of the accountConnector or fully qualified identifier for the
accountConnector.
To set the account_connector attribute:
▸ provide the argument account_connector on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the accountConnector resource.
To set the location attribute:
▸ provide the argument account_connector on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--annotations=[ANNOTATIONS,...]
Allows users to store small amounts of arbitrary data.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
Shorthand Example:
--annotations=string=string
JSON Example:
--annotations='{"string": "string"}'
File Example:
--annotations=path_to_file.(yaml|json)
--async
Return immediately, without waiting for the operation in progress to
complete.
--etag=ETAG
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.
--labels=[LABELS,...]
Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--labels=string=string
JSON Example:
--labels='{"string": "string"}'
File Example:
--labels=path_to_file.(yaml|json)
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request
ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request.
This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
--validate-only
If set, validate the request, but do not actually post it.
Arguments for the account connector config.
ProviderOAuthConfig is the OAuth config for a provider.
--provider-oauth-config-scopes=[PROVIDER_OAUTH_CONFIG_SCOPES,...]
User selected scopes to apply to the Oauth config In the event of
changing scopes, user records under AccountConnector will be
deleted and users will re-auth again.
This flag argument must be specified if any of the other arguments
in this group are specified.
Arguments for the oauth provider id.
--provider-oauth-config-system-id=PROVIDER_OAUTH_CONFIG_SYSTEM_ID
Developer Connect provided OAuth. PROVIDER_OAUTH_CONFIG_SYSTEM_ID
must be one of:
github
GitHub provider. Scopes can be found at
https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes
gitlab
GitLab provider. Scopes can be found at
https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes
google
Google provider. Recommended scopes:
"https://www.googleapis.com/auth/drive.readonly",
"https://www.googleapis.com/auth/documents.readonly"
rovo
Rovo provider. Must select the "rovo" scope.
sentry
Sentry provider. Scopes can be found at
https://docs.sentry.io/api/permissions/
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 developerconnect/v1 API. The full documentation for
this API can be found at:
http://cloud.google.com/developer-connect/docs/overview
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -0,0 +1,102 @@
NAME
gcloud alpha developer-connect account-connectors delete - delete
accountConnectors
SYNOPSIS
gcloud alpha developer-connect account-connectors delete
(ACCOUNT_CONNECTOR : --location=LOCATION) [--async] [--etag=ETAG]
[--force] [--request-id=REQUEST_ID] [--validate-only]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete an accountConnector
EXAMPLES
To delete the accountConnector, run:
$ gcloud alpha developer-connect account-connectors delete
POSITIONAL ARGUMENTS
AccountConnector resource - Name of the resource 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 account_connector 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.
ACCOUNT_CONNECTOR
ID of the accountConnector or fully qualified identifier for the
accountConnector.
To set the account_connector attribute:
▸ provide the argument account_connector on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the accountConnector resource.
To set the location attribute:
▸ provide the argument account_connector on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--etag=ETAG
The current etag of the AccountConnectorn. If an etag is provided and
does not match the current etag of the AccountConnector, deletion will
be blocked and an ABORTED error will be returned.
--force
If set to true, any Users from this AccountConnector will also be
deleted. (Otherwise, the request will only work if the AccountConnector
has no Users.)
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request
ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request.
This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
--validate-only
If set, validate the request, but do not actually post it.
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 developerconnect/v1 API. The full documentation for
this API can be found at:
http://cloud.google.com/developer-connect/docs/overview
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -0,0 +1,67 @@
NAME
gcloud alpha developer-connect account-connectors describe - describe
accountConnectors
SYNOPSIS
gcloud alpha developer-connect account-connectors describe
(ACCOUNT_CONNECTOR : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe an accountConnector
EXAMPLES
To describe the accountConnector, run:
$ gcloud alpha developer-connect account-connectors describe
POSITIONAL ARGUMENTS
AccountConnector resource - Name of the resource 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 account_connector 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.
ACCOUNT_CONNECTOR
ID of the accountConnector or fully qualified identifier for the
accountConnector.
To set the account_connector attribute:
▸ provide the argument account_connector on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the accountConnector resource.
To set the location attribute:
▸ provide the argument account_connector on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
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 developerconnect/v1 API. The full documentation for
this API can be found at:
http://cloud.google.com/developer-connect/docs/overview
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -0,0 +1,40 @@
NAME
gcloud alpha developer-connect account-connectors - manage Account
Connector resources
SYNOPSIS
gcloud alpha developer-connect account-connectors COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Account Connector resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create accountConnectors.
delete
(ALPHA) Delete accountConnectors.
describe
(ALPHA) Describe accountConnectors.
list
(ALPHA) List accountConnectors.
update
(ALPHA) Update accountConnectors.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -0,0 +1,87 @@
NAME
gcloud alpha developer-connect account-connectors list - list
accountConnectors
SYNOPSIS
gcloud alpha developer-connect account-connectors list --location=LOCATION
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List accountConnectors
EXAMPLES
To list all accountConnectors, run:
$ gcloud alpha developer-connect account-connectors list
REQUIRED FLAGS
Location resource - Parent value for ListAccountConnectorsRequest This
represents a Cloud 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 --location 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.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 developerconnect/v1 API. The full documentation for
this API can be found at:
http://cloud.google.com/developer-connect/docs/overview
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -0,0 +1,241 @@
NAME
gcloud alpha developer-connect account-connectors update - update
accountConnectors
SYNOPSIS
gcloud alpha developer-connect account-connectors update
(ACCOUNT_CONNECTOR : --location=LOCATION) [--[no-]allow-missing]
[--async] [--etag=ETAG] [--request-id=REQUEST_ID]
[--[no-]validate-only]
[--annotations=[ANNOTATIONS,...]
| --update-annotations=[UPDATE_ANNOTATIONS,...] --clear-annotations
| --remove-annotations=[__REMOVE_ANNOTATIONS,...]]
[--clear-provider-oauth-config
--provider-oauth-config-scopes=[PROVIDER_OAUTH_CONFIG_SCOPES,...]]
[--labels=[LABELS,...]
| --update-labels=[UPDATE_LABELS,...] --clear-labels
| --remove-labels=[__REMOVE_LABELS,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an accountConnector
EXAMPLES
To update the accountConnector, run:
$ gcloud alpha developer-connect account-connectors update
POSITIONAL ARGUMENTS
AccountConnector resource - Identifier. The resource name of the
userConnection, in the format
projects/{project}/locations/{location}/accountConnectors/{account_connector_id}.
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 account_connector 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.
ACCOUNT_CONNECTOR
ID of the accountConnector or fully qualified identifier for the
accountConnector.
To set the account_connector attribute:
▸ provide the argument account_connector on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the accountConnector resource.
To set the location attribute:
▸ provide the argument account_connector on the command line with a
fully specified name;
▸ provide the argument --location on the command line.
FLAGS
--[no-]allow-missing
If set to true, and the userConnection is not found a new
userConnection will be created. In this situation update_mask is
ignored. The creation will succeed only if the input userConnection has
all the necessary. Use --allow-missing to enable and --no-allow-missing
to disable.
--async
Return immediately, without waiting for the operation in progress to
complete.
--etag=ETAG
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.
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request
ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request.
This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
--[no-]validate-only
If set, validate the request, but do not actually post it. Use
--validate-only to enable and --no-validate-only to disable.
Update annotations.
At most one of these can be specified:
--annotations=[ANNOTATIONS,...]
Set annotations to new value. Allows users to store small amounts of
arbitrary data.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
Shorthand Example:
--annotations=string=string
JSON Example:
--annotations='{"string": "string"}'
File Example:
--annotations=path_to_file.(yaml|json)
--update-annotations=[UPDATE_ANNOTATIONS,...]
Update annotations value or add key value pair. Allows users to store
small amounts of arbitrary data.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
Shorthand Example:
--update-annotations=string=string
JSON Example:
--update-annotations='{"string": "string"}'
File Example:
--update-annotations=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-annotations
Clear annotations value and set to empty map.
--remove-annotations=[__REMOVE_ANNOTATIONS,...]
Remove existing value from map annotations.
Arguments for the account connector config.
ProviderOAuthConfig is the OAuth config for a provider.
--clear-provider-oauth-config
Set accountConnector.providerOauthConfig back to default value.
--provider-oauth-config-scopes=[PROVIDER_OAUTH_CONFIG_SCOPES,...]
User selected scopes to apply to the Oauth config In the event of
changing scopes, user records under AccountConnector will be
deleted and users will re-auth again.
Update labels.
At most one of these can be specified:
--labels=[LABELS,...]
Set labels to new value. Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only
hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--labels=string=string
JSON Example:
--labels='{"string": "string"}'
File Example:
--labels=path_to_file.(yaml|json)
--update-labels=[UPDATE_LABELS,...]
Update labels value or add key value pair. Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only
hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--update-labels=string=string
JSON Example:
--update-labels='{"string": "string"}'
File Example:
--update-labels=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-labels
Clear labels value and set to empty map.
--remove-labels=[__REMOVE_LABELS,...]
Remove existing value from map labels.
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 developerconnect/v1 API. The full documentation for
this API can be found at:
http://cloud.google.com/developer-connect/docs/overview
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS
GROUPS
GROUP is one of the following:
account-connectors
(ALPHA) Manage Account Connector resources.
connections
(ALPHA) Manage connection resources.