gcloud: Wed May 10 11:35:23 UTC 2023

gcloud/alloydb/help

@@ -34,6 +34,9 @@ GROUPS
      operations
         Provide commands for managing AlloyDB operations.
 
+     users
+        Provide commands for managing AlloyDB users.
+
 NOTES
     These variants are also available:
 

gcloud/alloydb/users/create

@@ -0,0 +1,66 @@
+NAME
+    gcloud alloydb users create - creates a user in a given cluster
+
+SYNOPSIS
+    gcloud alloydb users create USERNAME --cluster=CLUSTER --region=REGION
+        [--db-roles=[ROLE,...]] [--password=PASSWORD] [--superuser=SUPERUSER]
+        [--type=TYPE; default="BUILT_IN"] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Creates a user in a given cluster with specified username, cluster, region,
+    type, and password.
+
+EXAMPLES
+    To create a new user, run:
+
+        $ gcloud 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
+    These variants are also available:
+
+        $ gcloud alpha alloydb users create
+
+        $ gcloud beta alloydb users create
+

gcloud/alloydb/users/delete

@@ -0,0 +1,43 @@
+NAME
+    gcloud alloydb users delete - deletes an AlloyDB user in a given cluster
+
+SYNOPSIS
+    gcloud alloydb users delete USERNAME --cluster=CLUSTER --region=REGION
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Deletes an AlloyDB user in a given cluster.
+
+EXAMPLES
+    To delete an user, run:
+
+        $ gcloud 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
+    These variants are also available:
+
+        $ gcloud alpha alloydb users delete
+
+        $ gcloud beta alloydb users delete
+

gcloud/alloydb/users/help

@@ -0,0 +1,45 @@
+NAME
+    gcloud alloydb users - provide commands for managing AlloyDB users
+
+SYNOPSIS
+    gcloud alloydb users COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    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
+        Creates a user in a given cluster.
+
+     delete
+        Deletes an AlloyDB user in a given cluster.
+
+     list
+        Lists AlloyDB users in a given cluster.
+
+     set-password
+        Update an AlloyDB user's password within a given cluster and region.
+
+     set-roles
+        Update an AlloyDB user's database roles within a given cluster and
+        region.
+
+     set-superuser
+        Update an AlloyDB user's superuser role within a given cluster and
+        region.
+
+NOTES
+    These variants are also available:
+
+        $ gcloud alpha alloydb users
+
+        $ gcloud beta alloydb users
+

gcloud/alloydb/users/list

@@ -0,0 +1,71 @@
+NAME
+    gcloud alloydb users list - lists AlloyDB users in a given cluster
+
+SYNOPSIS
+    gcloud alloydb users list --cluster=CLUSTER --region=REGION
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Lists AlloyDB users in a given cluster.
+
+EXAMPLES
+    To list users, run:
+
+        $ gcloud 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
+    These variants are also available:
+
+        $ gcloud alpha alloydb users list
+
+        $ gcloud beta alloydb users list
+

gcloud/alloydb/users/set-password

@@ -0,0 +1,47 @@
+NAME
+    gcloud alloydb users set-password - update an AlloyDB user's password
+        within a given cluster and region
+
+SYNOPSIS
+    gcloud alloydb users set-password USERNAME --cluster=CLUSTER
+        --password=PASSWORD --region=REGION [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Update an AlloyDB user's password within a given cluster and region.
+
+EXAMPLES
+    To update a user's password, run:
+
+        $ gcloud 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
+    These variants are also available:
+
+        $ gcloud alpha alloydb users set-password
+
+        $ gcloud beta alloydb users set-password
+

gcloud/alloydb/users/set-roles

@@ -0,0 +1,48 @@
+NAME
+    gcloud alloydb users set-roles - update an AlloyDB user's database roles
+        within a given cluster and region
+
+SYNOPSIS
+    gcloud alloydb users set-roles USERNAME --cluster=CLUSTER
+        --db-roles=[ROLE,...] --region=REGION [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Update an AlloyDB user's database roles within a given cluster and region.
+
+EXAMPLES
+    To update a user's database roles, run:
+
+        $ gcloud 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
+    These variants are also available:
+
+        $ gcloud alpha alloydb users set-roles
+
+        $ gcloud beta alloydb users set-roles
+

gcloud/alloydb/users/set-superuser

@@ -0,0 +1,47 @@
+NAME
+    gcloud alloydb users set-superuser - update an AlloyDB user's superuser
+        role within a given cluster and region
+
+SYNOPSIS
+    gcloud alloydb users set-superuser USERNAME --cluster=CLUSTER
+        --region=REGION --superuser=SUPERUSER [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    Update an AlloyDB user's superuser role within a given cluster and region.
+
+EXAMPLES
+    To update a user's superuser role, run:
+
+        $ gcloud 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
+    These variants are also available:
+
+        $ gcloud alpha alloydb users set-superuser
+
+        $ gcloud beta alloydb users set-superuser
+