mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-18 06:47:12 +00:00
gcloud: Wed May 10 11:35:23 UTC 2023
This commit is contained in:
parent
a4643b613a
commit
14441c7ea7
154 changed files with 6649 additions and 164 deletions
70
gcloud/alpha/alloydb/users/create
Normal file
70
gcloud/alpha/alloydb/users/create
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users create - creates a user in a given cluster
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users create USERNAME --cluster=CLUSTER
|
||||
--region=REGION [--db-roles=[ROLE,...]] [--password=PASSWORD]
|
||||
[--superuser=SUPERUSER] [--type=TYPE; default="BUILT_IN"]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Creates a user in a given cluster with specified username, cluster,
|
||||
region, type, and password.
|
||||
|
||||
EXAMPLES
|
||||
To create a new user, run:
|
||||
|
||||
$ gcloud alpha alloydb users create my-username \
|
||||
--cluster=my-cluster --region=us-central1 --password=postgres
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
USERNAME
|
||||
AlloyDB username
|
||||
|
||||
REQUIRED FLAGS
|
||||
--cluster=CLUSTER
|
||||
AlloyDB cluster ID
|
||||
|
||||
--region=REGION
|
||||
Regional location (e.g. asia-east1, us-east1). See the full list of
|
||||
regions at https://cloud.google.com/sql/docs/instance-locations.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--db-roles=[ROLE,...]
|
||||
Comma separated list of database roles this new user will be granted
|
||||
upon creation.
|
||||
|
||||
--password=PASSWORD
|
||||
Password for this database user.
|
||||
|
||||
--superuser=SUPERUSER
|
||||
If true, new user will have AlloyDB superuser privileges. Default value
|
||||
is false.
|
||||
|
||||
--type=TYPE; default="BUILT_IN"
|
||||
Type corresponds to the user type. TYPE must be one of:
|
||||
|
||||
BUILT_IN
|
||||
This database user can authenticate via password-based
|
||||
authentication
|
||||
IAM_BASED
|
||||
This database user can authenticate via IAM-based authentication
|
||||
|
||||
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.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users create
|
||||
|
||||
$ gcloud beta alloydb users create
|
||||
|
||||
47
gcloud/alpha/alloydb/users/delete
Normal file
47
gcloud/alpha/alloydb/users/delete
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users delete - deletes an AlloyDB user in a given
|
||||
cluster
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users delete USERNAME --cluster=CLUSTER
|
||||
--region=REGION [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Deletes an AlloyDB user in a given cluster.
|
||||
|
||||
EXAMPLES
|
||||
To delete an user, run:
|
||||
|
||||
$ gcloud alpha alloydb users delete my-username \
|
||||
--cluster=my-cluster --region=us-central1
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
USERNAME
|
||||
AlloyDB username
|
||||
|
||||
REQUIRED FLAGS
|
||||
--cluster=CLUSTER
|
||||
AlloyDB cluster ID
|
||||
|
||||
--region=REGION
|
||||
Regional location (e.g. asia-east1, us-east1). See the full list of
|
||||
regions at https://cloud.google.com/sql/docs/instance-locations.
|
||||
|
||||
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.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users delete
|
||||
|
||||
$ gcloud beta alloydb users delete
|
||||
|
||||
49
gcloud/alpha/alloydb/users/help
Normal file
49
gcloud/alpha/alloydb/users/help
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users - provide commands for managing AlloyDB users
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Provide commands for managing AlloyDB users including creating,
|
||||
configuring, getting, listing, and deleting users.
|
||||
|
||||
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) Creates a user in a given cluster.
|
||||
|
||||
delete
|
||||
(ALPHA) Deletes an AlloyDB user in a given cluster.
|
||||
|
||||
list
|
||||
(ALPHA) Lists AlloyDB users in a given cluster.
|
||||
|
||||
set-password
|
||||
(ALPHA) Update an AlloyDB user's password within a given cluster and
|
||||
region.
|
||||
|
||||
set-roles
|
||||
(ALPHA) Update an AlloyDB user's database roles within a given cluster
|
||||
and region.
|
||||
|
||||
set-superuser
|
||||
(ALPHA) Update an AlloyDB user's superuser role within a given cluster
|
||||
and region.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users
|
||||
|
||||
$ gcloud beta alloydb users
|
||||
|
||||
75
gcloud/alpha/alloydb/users/list
Normal file
75
gcloud/alpha/alloydb/users/list
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users list - lists AlloyDB users in a given cluster
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users list --cluster=CLUSTER --region=REGION
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
|
||||
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Lists AlloyDB users in a given cluster.
|
||||
|
||||
EXAMPLES
|
||||
To list users, run:
|
||||
|
||||
$ gcloud alpha alloydb users list --cluster=my-cluster \
|
||||
--region=us-central1
|
||||
|
||||
REQUIRED FLAGS
|
||||
--cluster=CLUSTER
|
||||
AlloyDB cluster ID
|
||||
|
||||
--region=REGION
|
||||
Regional location (e.g. asia-east1, us-east1). See the full list of
|
||||
regions at https://cloud.google.com/sql/docs/instance-locations.
|
||||
|
||||
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.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users list
|
||||
|
||||
$ gcloud beta alloydb users list
|
||||
|
||||
51
gcloud/alpha/alloydb/users/set-password
Normal file
51
gcloud/alpha/alloydb/users/set-password
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users set-password - update an AlloyDB user's password
|
||||
within a given cluster and region
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users set-password USERNAME --cluster=CLUSTER
|
||||
--password=PASSWORD --region=REGION [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Update an AlloyDB user's password within a given cluster and
|
||||
region.
|
||||
|
||||
EXAMPLES
|
||||
To update a user's password, run:
|
||||
|
||||
$ gcloud alpha alloydb users set-password my-username \
|
||||
--cluster=my-cluster --region=us-central1 --password=postgres
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
USERNAME
|
||||
AlloyDB username
|
||||
|
||||
REQUIRED FLAGS
|
||||
--cluster=CLUSTER
|
||||
AlloyDB cluster ID
|
||||
|
||||
--password=PASSWORD
|
||||
Password for this database user.
|
||||
|
||||
--region=REGION
|
||||
Regional location (e.g. asia-east1, us-east1). See the full list of
|
||||
regions at https://cloud.google.com/sql/docs/instance-locations.
|
||||
|
||||
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.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users set-password
|
||||
|
||||
$ gcloud beta alloydb users set-password
|
||||
|
||||
52
gcloud/alpha/alloydb/users/set-roles
Normal file
52
gcloud/alpha/alloydb/users/set-roles
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users set-roles - update an AlloyDB user's database
|
||||
roles within a given cluster and region
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users set-roles USERNAME --cluster=CLUSTER
|
||||
--db-roles=[ROLE,...] --region=REGION [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Update an AlloyDB user's database roles within a given cluster and
|
||||
region.
|
||||
|
||||
EXAMPLES
|
||||
To update a user's database roles, run:
|
||||
|
||||
$ gcloud alpha alloydb users set-roles my-username \
|
||||
--cluster=my-cluster --region=us-central1 --db-roles=role1,role2
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
USERNAME
|
||||
AlloyDB username
|
||||
|
||||
REQUIRED FLAGS
|
||||
--cluster=CLUSTER
|
||||
AlloyDB cluster ID
|
||||
|
||||
--db-roles=[ROLE,...]
|
||||
Comma separated list of database roles this new user will be granted
|
||||
upon creation.
|
||||
|
||||
--region=REGION
|
||||
Regional location (e.g. asia-east1, us-east1). See the full list of
|
||||
regions at https://cloud.google.com/sql/docs/instance-locations.
|
||||
|
||||
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.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users set-roles
|
||||
|
||||
$ gcloud beta alloydb users set-roles
|
||||
|
||||
51
gcloud/alpha/alloydb/users/set-superuser
Normal file
51
gcloud/alpha/alloydb/users/set-superuser
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud alpha alloydb users set-superuser - update an AlloyDB user's
|
||||
superuser role within a given cluster and region
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha alloydb users set-superuser USERNAME --cluster=CLUSTER
|
||||
--region=REGION --superuser=SUPERUSER [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Update an AlloyDB user's superuser role within a given cluster and
|
||||
region.
|
||||
|
||||
EXAMPLES
|
||||
To update a user's superuser role, run:
|
||||
|
||||
$ gcloud alpha alloydb users set-superuser my-username \
|
||||
--cluster=my-cluster --region=us-central1 --superuser=true/false
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
USERNAME
|
||||
AlloyDB username
|
||||
|
||||
REQUIRED FLAGS
|
||||
--cluster=CLUSTER
|
||||
AlloyDB cluster ID
|
||||
|
||||
--region=REGION
|
||||
Regional location (e.g. asia-east1, us-east1). See the full list of
|
||||
regions at https://cloud.google.com/sql/docs/instance-locations.
|
||||
|
||||
--superuser=SUPERUSER
|
||||
If true, user will have AlloyDB superuser privileges
|
||||
|
||||
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.
|
||||
|
||||
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. These variants are also available:
|
||||
|
||||
$ gcloud alloydb users set-superuser
|
||||
|
||||
$ gcloud beta alloydb users set-superuser
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue