From 11068cb1236834e10a688cb27bb91cf478a5b2ce Mon Sep 17 00:00:00 2001 From: Automated Date: Wed, 8 Feb 2023 10:13:59 +0000 Subject: [PATCH] gcloud: Wed Feb 8 10:13:59 UTC 2023 --- gcloud/_version | 8 +- .../application-default/set-quota-project | 13 +- gcloud/alpha/blockchain-node-engine/help | 3 + .../operations/describe | 64 +++++ .../blockchain-node-engine/operations/help | 31 +++ .../blockchain-node-engine/operations/list | 84 +++++++ gcloud/alpha/compute/backend-services/create | 19 ++ gcloud/alpha/compute/backend-services/update | 19 ++ gcloud/alpha/compute/commitments/create | 8 +- .../managed/rolling-action/start-update | 21 ++ .../instance-groups/managed/set-autoscaling | 10 +- .../managed/set-instance-template | 23 +- .../managed/update-autoscaling | 33 ++- .../instance-templates/create-with-container | 4 - gcloud/alpha/compute/instances/bulk/create | 18 ++ .../compute/instances/create-with-container | 4 - .../alpha/compute/network-attachments/create | 27 ++- .../alpha/compute/network-attachments/delete | 12 +- .../compute/network-attachments/describe | 12 +- gcloud/alpha/compute/network-attachments/help | 6 +- gcloud/alpha/compute/network-attachments/list | 16 +- .../compute/network-endpoint-groups/create | 4 +- .../compute/network-endpoint-groups/update | 24 +- gcloud/alpha/compute/queued-resources/create | 18 ++ gcloud/alpha/container/azure/clients/create | 8 +- gcloud/alpha/container/azure/clients/delete | 6 +- .../backup-restore/backup-plans/create | 2 +- .../backup-restore/backup-plans/update | 2 +- .../container/bare-metal/admin-clusters/help | 3 +- .../admin-clusters/query-version-config | 13 +- .../alpha/container/bare-metal/clusters/help | 3 +- .../bare-metal/clusters/query-version-config | 45 ++-- .../container/fleet/memberships/register | 73 +++--- .../alpha/container/hub/memberships/register | 73 +++--- gcloud/alpha/container/vmware/clusters/help | 3 +- .../vmware/clusters/query-version-config | 47 ++-- gcloud/alpha/firebase/test/android/help | 4 - gcloud/alpha/firebase/test/android/run | 2 +- gcloud/alpha/firebase/test/ios/help | 4 - gcloud/alpha/iam/help | 3 + gcloud/alpha/iam/workforce-pools/create | 96 ++++++++ .../iam/workforce-pools/create-cred-config | 147 ++++++++++++ .../iam/workforce-pools/create-login-config | 49 ++++ gcloud/alpha/iam/workforce-pools/delete | 63 +++++ gcloud/alpha/iam/workforce-pools/describe | 58 +++++ gcloud/alpha/iam/workforce-pools/help | 62 +++++ gcloud/alpha/iam/workforce-pools/list | 81 +++++++ .../iam/workforce-pools/operations/describe | 75 ++++++ .../alpha/iam/workforce-pools/operations/help | 31 +++ .../iam/workforce-pools/providers/create-oidc | 206 ++++++++++++++++ .../iam/workforce-pools/providers/delete | 80 +++++++ .../iam/workforce-pools/providers/describe | 75 ++++++ .../alpha/iam/workforce-pools/providers/help | 54 +++++ .../alpha/iam/workforce-pools/providers/list | 94 ++++++++ .../providers/operations/describe | 89 +++++++ .../workforce-pools/providers/operations/help | 33 +++ .../iam/workforce-pools/providers/undelete | 80 +++++++ .../iam/workforce-pools/providers/update-oidc | 205 ++++++++++++++++ gcloud/alpha/iam/workforce-pools/undelete | 63 +++++ gcloud/alpha/iam/workforce-pools/update | 88 +++++++ gcloud/alpha/init | 12 +- gcloud/alpha/iot/devices/list | 15 +- gcloud/alpha/notebooks/environments/create | 5 +- gcloud/alpha/notebooks/environments/delete | 5 +- gcloud/alpha/notebooks/environments/describe | 5 +- gcloud/alpha/notebooks/environments/help | 12 +- gcloud/alpha/notebooks/environments/list | 5 +- gcloud/alpha/notebooks/help | 10 +- .../instances/add-iam-policy-binding | 7 +- gcloud/alpha/notebooks/instances/create | 5 +- gcloud/alpha/notebooks/instances/delete | 5 +- gcloud/alpha/notebooks/instances/describe | 5 +- gcloud/alpha/notebooks/instances/diagnose | 5 +- .../alpha/notebooks/instances/get-iam-policy | 14 +- gcloud/alpha/notebooks/instances/help | 37 +-- .../alpha/notebooks/instances/is-upgradeable | 5 +- gcloud/alpha/notebooks/instances/list | 5 +- gcloud/alpha/notebooks/instances/register | 5 +- .../instances/remove-iam-policy-binding | 5 +- gcloud/alpha/notebooks/instances/reset | 5 +- .../alpha/notebooks/instances/set-iam-policy | 7 +- gcloud/alpha/notebooks/instances/start | 5 +- gcloud/alpha/notebooks/instances/stop | 5 +- gcloud/alpha/notebooks/instances/update | 5 +- gcloud/alpha/notebooks/instances/upgrade | 5 +- gcloud/alpha/notebooks/locations/help | 6 +- gcloud/alpha/notebooks/locations/list | 5 +- gcloud/alpha/run/deploy | 2 +- gcloud/alpha/run/jobs/create | 2 +- gcloud/alpha/run/jobs/deploy | 6 +- gcloud/alpha/run/jobs/help | 2 +- gcloud/alpha/run/jobs/replace | 6 +- gcloud/alpha/run/services/help | 3 +- gcloud/alpha/run/services/replace | 8 +- gcloud/alpha/scc/custom-modules/help | 26 ++ gcloud/alpha/scc/custom-modules/sha/create | 112 +++++++++ gcloud/alpha/scc/custom-modules/sha/delete | 81 +++++++ gcloud/alpha/scc/custom-modules/sha/get | 79 ++++++ .../scc/custom-modules/sha/get-effective | 84 +++++++ gcloud/alpha/scc/custom-modules/sha/help | 50 ++++ gcloud/alpha/scc/custom-modules/sha/list | 89 +++++++ .../scc/custom-modules/sha/list-descendant | 93 +++++++ .../scc/custom-modules/sha/list-effective | 93 +++++++ gcloud/alpha/scc/custom-modules/sha/test | 141 +++++++++++ gcloud/alpha/scc/custom-modules/sha/update | 140 +++++++++++ gcloud/alpha/scc/help | 3 + .../application-default/set-quota-project | 11 +- .../application-default/set-quota-project | 13 +- gcloud/beta/compute/commitments/create | 7 +- gcloud/beta/compute/help | 3 + .../instance-groups/managed/set-autoscaling | 10 +- .../managed/set-instance-template | 9 + .../managed/update-autoscaling | 33 ++- gcloud/beta/compute/instance-templates/create | 4 - .../instance-templates/create-with-container | 4 - gcloud/beta/compute/instances/create | 4 - .../compute/instances/create-with-container | 4 - .../beta/compute/network-attachments/create | 102 ++++++++ .../beta/compute/network-attachments/delete | 58 +++++ .../beta/compute/network-attachments/describe | 58 +++++ gcloud/beta/compute/network-attachments/help | 38 +++ gcloud/beta/compute/network-attachments/list | 90 +++++++ .../backup-restore/backup-plans/create | 2 +- .../backup-restore/backup-plans/update | 2 +- .../beta/container/fleet/memberships/register | 73 +++--- .../beta/container/hub/memberships/register | 73 +++--- gcloud/beta/firebase/test/android/run | 2 +- gcloud/beta/iam/help | 3 + gcloud/beta/iam/workforce-pools/create | 94 ++++++++ .../iam/workforce-pools/create-cred-config | 145 +++++++++++ gcloud/beta/iam/workforce-pools/delete | 61 +++++ gcloud/beta/iam/workforce-pools/describe | 56 +++++ gcloud/beta/iam/workforce-pools/help | 56 +++++ gcloud/beta/iam/workforce-pools/list | 79 ++++++ .../iam/workforce-pools/operations/describe | 72 ++++++ .../beta/iam/workforce-pools/operations/help | 29 +++ .../iam/workforce-pools/providers/create-oidc | 204 ++++++++++++++++ .../beta/iam/workforce-pools/providers/delete | 78 ++++++ .../iam/workforce-pools/providers/describe | 73 ++++++ .../beta/iam/workforce-pools/providers/help | 52 ++++ .../beta/iam/workforce-pools/providers/list | 92 +++++++ .../providers/operations/describe | 87 +++++++ .../workforce-pools/providers/operations/help | 31 +++ .../iam/workforce-pools/providers/undelete | 78 ++++++ .../iam/workforce-pools/providers/update-oidc | 203 ++++++++++++++++ gcloud/beta/iam/workforce-pools/undelete | 61 +++++ gcloud/beta/iam/workforce-pools/update | 86 +++++++ gcloud/beta/init | 12 +- gcloud/beta/iot/devices/list | 15 +- gcloud/beta/notebooks/environments/create | 5 +- gcloud/beta/notebooks/environments/delete | 5 +- gcloud/beta/notebooks/environments/describe | 5 +- gcloud/beta/notebooks/environments/help | 12 +- gcloud/beta/notebooks/environments/list | 5 +- gcloud/beta/notebooks/help | 10 +- .../instances/add-iam-policy-binding | 7 +- gcloud/beta/notebooks/instances/create | 5 +- gcloud/beta/notebooks/instances/delete | 5 +- gcloud/beta/notebooks/instances/describe | 5 +- gcloud/beta/notebooks/instances/diagnose | 5 +- .../beta/notebooks/instances/get-iam-policy | 14 +- gcloud/beta/notebooks/instances/help | 37 +-- .../beta/notebooks/instances/is-upgradeable | 5 +- gcloud/beta/notebooks/instances/list | 5 +- gcloud/beta/notebooks/instances/register | 5 +- .../instances/remove-iam-policy-binding | 5 +- gcloud/beta/notebooks/instances/reset | 5 +- .../beta/notebooks/instances/set-iam-policy | 7 +- gcloud/beta/notebooks/instances/start | 5 +- gcloud/beta/notebooks/instances/stop | 5 +- gcloud/beta/notebooks/instances/update | 5 +- gcloud/beta/notebooks/instances/upgrade | 5 +- gcloud/beta/notebooks/locations/help | 6 +- gcloud/beta/notebooks/locations/list | 5 +- gcloud/beta/run/deploy | 2 +- gcloud/beta/run/jobs/create | 4 +- gcloud/beta/run/jobs/deploy | 226 ++++++++++++++++++ gcloud/beta/run/jobs/help | 7 +- gcloud/beta/run/jobs/replace | 6 +- gcloud/beta/run/services/help | 2 +- gcloud/beta/run/services/replace | 8 +- gcloud/compute/commitments/create | 7 +- gcloud/compute/help | 3 + .../instance-groups/managed/set-autoscaling | 10 +- .../managed/set-instance-template | 9 + .../managed/update-autoscaling | 33 ++- gcloud/compute/instance-templates/create | 4 - .../instance-templates/create-with-container | 4 - gcloud/compute/instances/create | 4 - .../compute/instances/create-with-container | 4 - gcloud/compute/network-attachments/create | 101 ++++++++ gcloud/compute/network-attachments/delete | 57 +++++ gcloud/compute/network-attachments/describe | 57 +++++ gcloud/compute/network-attachments/help | 37 +++ gcloud/compute/network-attachments/list | 88 +++++++ gcloud/container/azure/clients/create | 8 +- gcloud/container/azure/clients/delete | 6 +- gcloud/container/fleet/memberships/register | 73 +++--- gcloud/container/hub/memberships/register | 73 +++--- .../container/vpn-connections/create | 6 +- gcloud/firebase/test/android/help | 3 + .../test/android}/list-device-capacities | 35 ++- gcloud/firebase/test/android/run | 2 +- gcloud/firebase/test/ios/help | 3 + .../test/ios}/list-device-capacities | 41 ++-- gcloud/iam/help | 3 + gcloud/iam/workforce-pools/create | 92 +++++++ gcloud/iam/workforce-pools/create-cred-config | 143 +++++++++++ gcloud/iam/workforce-pools/delete | 60 +++++ gcloud/iam/workforce-pools/describe | 55 +++++ gcloud/iam/workforce-pools/get-iam-policy | 78 ++++++ gcloud/iam/workforce-pools/help | 64 +++++ gcloud/iam/workforce-pools/list | 78 ++++++ .../iam/workforce-pools/operations/describe | 71 ++++++ gcloud/iam/workforce-pools/operations/help | 28 +++ .../iam/workforce-pools/providers/create-oidc | 203 ++++++++++++++++ .../iam/workforce-pools/providers/create-saml | 193 +++++++++++++++ gcloud/iam/workforce-pools/providers/delete | 77 ++++++ gcloud/iam/workforce-pools/providers/describe | 72 ++++++ gcloud/iam/workforce-pools/providers/help | 56 +++++ gcloud/iam/workforce-pools/providers/list | 90 +++++++ .../providers/operations/describe | 86 +++++++ .../workforce-pools/providers/operations/help | 29 +++ gcloud/iam/workforce-pools/providers/undelete | 77 ++++++ .../iam/workforce-pools/providers/update-oidc | 202 ++++++++++++++++ .../iam/workforce-pools/providers/update-saml | 192 +++++++++++++++ gcloud/iam/workforce-pools/set-iam-policy | 58 +++++ gcloud/iam/workforce-pools/subjects/delete | 69 ++++++ gcloud/iam/workforce-pools/subjects/help | 30 +++ .../subjects/operations/describe | 75 ++++++ .../workforce-pools/subjects/operations/help | 21 ++ gcloud/iam/workforce-pools/subjects/undelete | 69 ++++++ gcloud/iam/workforce-pools/undelete | 60 +++++ gcloud/iam/workforce-pools/update | 85 +++++++ gcloud/init | 12 +- gcloud/iot/devices/list | 15 +- gcloud/run/deploy | 2 +- gcloud/run/services/help | 2 +- gcloud/run/services/replace | 8 +- gcloud/vmware/private-clouds/subnets/list | 42 +++- 240 files changed, 8982 insertions(+), 619 deletions(-) create mode 100644 gcloud/alpha/blockchain-node-engine/operations/describe create mode 100644 gcloud/alpha/blockchain-node-engine/operations/help create mode 100644 gcloud/alpha/blockchain-node-engine/operations/list create mode 100644 gcloud/alpha/iam/workforce-pools/create create mode 100644 gcloud/alpha/iam/workforce-pools/create-cred-config create mode 100644 gcloud/alpha/iam/workforce-pools/create-login-config create mode 100644 gcloud/alpha/iam/workforce-pools/delete create mode 100644 gcloud/alpha/iam/workforce-pools/describe create mode 100644 gcloud/alpha/iam/workforce-pools/help create mode 100644 gcloud/alpha/iam/workforce-pools/list create mode 100644 gcloud/alpha/iam/workforce-pools/operations/describe create mode 100644 gcloud/alpha/iam/workforce-pools/operations/help create mode 100644 gcloud/alpha/iam/workforce-pools/providers/create-oidc create mode 100644 gcloud/alpha/iam/workforce-pools/providers/delete create mode 100644 gcloud/alpha/iam/workforce-pools/providers/describe create mode 100644 gcloud/alpha/iam/workforce-pools/providers/help create mode 100644 gcloud/alpha/iam/workforce-pools/providers/list create mode 100644 gcloud/alpha/iam/workforce-pools/providers/operations/describe create mode 100644 gcloud/alpha/iam/workforce-pools/providers/operations/help create mode 100644 gcloud/alpha/iam/workforce-pools/providers/undelete create mode 100644 gcloud/alpha/iam/workforce-pools/providers/update-oidc create mode 100644 gcloud/alpha/iam/workforce-pools/undelete create mode 100644 gcloud/alpha/iam/workforce-pools/update create mode 100644 gcloud/alpha/scc/custom-modules/help create mode 100644 gcloud/alpha/scc/custom-modules/sha/create create mode 100644 gcloud/alpha/scc/custom-modules/sha/delete create mode 100644 gcloud/alpha/scc/custom-modules/sha/get create mode 100644 gcloud/alpha/scc/custom-modules/sha/get-effective create mode 100644 gcloud/alpha/scc/custom-modules/sha/help create mode 100644 gcloud/alpha/scc/custom-modules/sha/list create mode 100644 gcloud/alpha/scc/custom-modules/sha/list-descendant create mode 100644 gcloud/alpha/scc/custom-modules/sha/list-effective create mode 100644 gcloud/alpha/scc/custom-modules/sha/test create mode 100644 gcloud/alpha/scc/custom-modules/sha/update create mode 100644 gcloud/beta/compute/network-attachments/create create mode 100644 gcloud/beta/compute/network-attachments/delete create mode 100644 gcloud/beta/compute/network-attachments/describe create mode 100644 gcloud/beta/compute/network-attachments/help create mode 100644 gcloud/beta/compute/network-attachments/list create mode 100644 gcloud/beta/iam/workforce-pools/create create mode 100644 gcloud/beta/iam/workforce-pools/create-cred-config create mode 100644 gcloud/beta/iam/workforce-pools/delete create mode 100644 gcloud/beta/iam/workforce-pools/describe create mode 100644 gcloud/beta/iam/workforce-pools/help create mode 100644 gcloud/beta/iam/workforce-pools/list create mode 100644 gcloud/beta/iam/workforce-pools/operations/describe create mode 100644 gcloud/beta/iam/workforce-pools/operations/help create mode 100644 gcloud/beta/iam/workforce-pools/providers/create-oidc create mode 100644 gcloud/beta/iam/workforce-pools/providers/delete create mode 100644 gcloud/beta/iam/workforce-pools/providers/describe create mode 100644 gcloud/beta/iam/workforce-pools/providers/help create mode 100644 gcloud/beta/iam/workforce-pools/providers/list create mode 100644 gcloud/beta/iam/workforce-pools/providers/operations/describe create mode 100644 gcloud/beta/iam/workforce-pools/providers/operations/help create mode 100644 gcloud/beta/iam/workforce-pools/providers/undelete create mode 100644 gcloud/beta/iam/workforce-pools/providers/update-oidc create mode 100644 gcloud/beta/iam/workforce-pools/undelete create mode 100644 gcloud/beta/iam/workforce-pools/update create mode 100644 gcloud/beta/run/jobs/deploy create mode 100644 gcloud/compute/network-attachments/create create mode 100644 gcloud/compute/network-attachments/delete create mode 100644 gcloud/compute/network-attachments/describe create mode 100644 gcloud/compute/network-attachments/help create mode 100644 gcloud/compute/network-attachments/list rename gcloud/{alpha/firebase/test/ios => firebase/test/android}/list-device-capacities (66%) rename gcloud/{alpha/firebase/test/android => firebase/test/ios}/list-device-capacities (62%) create mode 100644 gcloud/iam/workforce-pools/create create mode 100644 gcloud/iam/workforce-pools/create-cred-config create mode 100644 gcloud/iam/workforce-pools/delete create mode 100644 gcloud/iam/workforce-pools/describe create mode 100644 gcloud/iam/workforce-pools/get-iam-policy create mode 100644 gcloud/iam/workforce-pools/help create mode 100644 gcloud/iam/workforce-pools/list create mode 100644 gcloud/iam/workforce-pools/operations/describe create mode 100644 gcloud/iam/workforce-pools/operations/help create mode 100644 gcloud/iam/workforce-pools/providers/create-oidc create mode 100644 gcloud/iam/workforce-pools/providers/create-saml create mode 100644 gcloud/iam/workforce-pools/providers/delete create mode 100644 gcloud/iam/workforce-pools/providers/describe create mode 100644 gcloud/iam/workforce-pools/providers/help create mode 100644 gcloud/iam/workforce-pools/providers/list create mode 100644 gcloud/iam/workforce-pools/providers/operations/describe create mode 100644 gcloud/iam/workforce-pools/providers/operations/help create mode 100644 gcloud/iam/workforce-pools/providers/undelete create mode 100644 gcloud/iam/workforce-pools/providers/update-oidc create mode 100644 gcloud/iam/workforce-pools/providers/update-saml create mode 100644 gcloud/iam/workforce-pools/set-iam-policy create mode 100644 gcloud/iam/workforce-pools/subjects/delete create mode 100644 gcloud/iam/workforce-pools/subjects/help create mode 100644 gcloud/iam/workforce-pools/subjects/operations/describe create mode 100644 gcloud/iam/workforce-pools/subjects/operations/help create mode 100644 gcloud/iam/workforce-pools/subjects/undelete create mode 100644 gcloud/iam/workforce-pools/undelete create mode 100644 gcloud/iam/workforce-pools/update diff --git a/gcloud/_version b/gcloud/_version index 83a514ed0..2ee0f89d3 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 416.0.0 -alpha 2023.01.30 -beta 2023.01.30 +Google Cloud SDK 417.0.0 +alpha 2023.02.03 +beta 2023.02.03 bq 2.0.84 bundled-python3-unix 3.9.16 -core 2023.01.30 +core 2023.02.03 gcloud-crc32c 1.0.0 gsutil 5.19 diff --git a/gcloud/alpha/auth/application-default/set-quota-project b/gcloud/alpha/auth/application-default/set-quota-project index ae79fb684..49665b0ee 100644 --- a/gcloud/alpha/auth/application-default/set-quota-project +++ b/gcloud/alpha/auth/application-default/set-quota-project @@ -7,11 +7,14 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Before running this command, an ADC must already be generated using - $ gcloud auth application-default login. The quota project can be used by - client libraries for the billing purpose. The existing application default - credentials must have the serviceusage.services.use permission on the given - project. + (ALPHA) A quota project is a Google Cloud Project that will be used for + billing and quota limits. + + Before running this command, an ADC must already be generated using $ + gcloud auth application-default login. The quota project defined in the ADC + will be used by the Google client libraries. The existing application + default credentials must have the serviceusage.services.use permission on + the given project. EXAMPLES To update the quota project in application default credentials to diff --git a/gcloud/alpha/blockchain-node-engine/help b/gcloud/alpha/blockchain-node-engine/help index fe95574db..9882dfa65 100644 --- a/gcloud/alpha/blockchain-node-engine/help +++ b/gcloud/alpha/blockchain-node-engine/help @@ -26,6 +26,9 @@ GROUPS nodes (ALPHA) Commands for viewing and manipulating blockchain nodes. + operations + (ALPHA) Manage Blockchain Node Engine operations. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/blockchain-node-engine/operations/describe b/gcloud/alpha/blockchain-node-engine/operations/describe new file mode 100644 index 000000000..8464680cf --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/operations/describe @@ -0,0 +1,64 @@ +NAME + gcloud alpha blockchain-node-engine operations describe - show details + about an operation + +SYNOPSIS + gcloud alpha blockchain-node-engine operations describe + (OPERATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details about an operation. + +EXAMPLES + To show details about an operation, run: + + $ gcloud alpha blockchain-node-engine operations describe \ + my-operation --location=us-central1 + +POSITIONAL ARGUMENTS + Operation resource - The operation you want to get the details of. 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 operation on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the blockchain node resource. + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property web3/location. + +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 blockchainnodeengine/v1alpha1 API. The full + documentation for this API can be found at: https://cloud.google.com/web3 + +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. + diff --git a/gcloud/alpha/blockchain-node-engine/operations/help b/gcloud/alpha/blockchain-node-engine/operations/help new file mode 100644 index 000000000..9e08162c1 --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/operations/help @@ -0,0 +1,31 @@ +NAME + gcloud alpha blockchain-node-engine operations - manage Blockchain Node + Engine operations + +SYNOPSIS + gcloud alpha blockchain-node-engine operations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Commands for managing Blockchain Node Engine operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Show details about an operation. + + list + (ALPHA) List operations. + +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. + diff --git a/gcloud/alpha/blockchain-node-engine/operations/list b/gcloud/alpha/blockchain-node-engine/operations/list new file mode 100644 index 000000000..05ea2b73b --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/operations/list @@ -0,0 +1,84 @@ +NAME + gcloud alpha blockchain-node-engine operations list - list operations + +SYNOPSIS + gcloud alpha blockchain-node-engine operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List operations. + +EXAMPLES + To list all operations in a project and location 'us-central1', run: + + $ gcloud alpha blockchain-node-engine operations list \ + --location=us-central1 + +FLAGS + Location resource - The location you want to list the operations for. 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; + ◆ set the property web3/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --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; + ▸ set the property web3/location. + +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 blockchainnodeengine/v1alpha1 API. The full + documentation for this API can be found at: https://cloud.google.com/web3 + +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. + diff --git a/gcloud/alpha/compute/backend-services/create b/gcloud/alpha/compute/backend-services/create index e98b88dae..cdaeca5c3 100644 --- a/gcloud/alpha/compute/backend-services/create +++ b/gcloud/alpha/compute/backend-services/create @@ -26,6 +26,8 @@ SYNOPSIS [--idle-timeout-sec=IDLE_TIMEOUT_SEC] [--load-balancing-scheme=LOAD_BALANCING_SCHEME; default="EXTERNAL"] [--locality-lb-policy=LOCALITY_LB_POLICY] + [--logging-optional=LOGGING_OPTIONAL] + [--logging-optional-fields=[LOGGING_OPTIONAL_FIELDS,...]] [--logging-sample-rate=LOGGING_SAMPLE_RATE] [--max-ttl=MAX_TTL] [--[no-]negative-caching] [--negative-caching-policy=[[CODE=TTL],...]] [--network=NETWORK] [--port-name=PORT_NAME] [--protocol=PROTOCOL] @@ -337,6 +339,23 @@ FLAGS LEAST_REQUEST, RING_HASH, RANDOM, ORIGINAL_DESTINATION, MAGLEV, WEIGHTED_MAGLEV. + --logging-optional=LOGGING_OPTIONAL + This field can only be specified if logging is enabled for the backend + service. Configures whether all, none or a subset of optional fields + should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, + EXCLUDE_ALL_OPTIONAL, CUSTOM]. This can only be specified if the + protocol is HTTP, HTTPS, HTTP2, TCP, SSL, UDP, or UNSPECIFIED. Default + is EXCLUDE_ALL_OPTIONAL. LOGGING_OPTIONAL must be one of: + EXCLUDE_ALL_OPTIONAL, INCLUDE_ALL_OPTIONAL, CUSTOM. + + --logging-optional-fields=[LOGGING_OPTIONAL_FIELDS,...] + This field can only be specified if logging is enabled for the backend + service and "logConfig.optionalMode" was set to CUSTOM. Contains a + comma-separated list of optional fields you want to include in the + logs. For example: serverInstance, serverGkeDetails.cluster, + serverGkeDetails.pod.podNamespace. This can only be specified if the + protocol is HTTP, HTTPS, HTTP2, TCP, SSL, UDP, or UNSPECIFIED. + --logging-sample-rate=LOGGING_SAMPLE_RATE This field can only be specified if logging is enabled for the backend service. The value of the field must be a float in the range [0, 1]. diff --git a/gcloud/alpha/compute/backend-services/update b/gcloud/alpha/compute/backend-services/update index 662d67030..fd986132d 100644 --- a/gcloud/alpha/compute/backend-services/update +++ b/gcloud/alpha/compute/backend-services/update @@ -21,6 +21,8 @@ SYNOPSIS oauth2-client-secret=OAUTH2-CLIENT-SECRET]] [--idle-timeout-sec=IDLE_TIMEOUT_SEC] [--locality-lb-policy=LOCALITY_LB_POLICY] + [--logging-optional=LOGGING_OPTIONAL] + [--logging-optional-fields=[LOGGING_OPTIONAL_FIELDS,...]] [--logging-sample-rate=LOGGING_SAMPLE_RATE] [--port-name=PORT_NAME] [--protocol=PROTOCOL] [--[no-]request-coalescing] [--security-policy=SECURITY_POLICY] @@ -245,6 +247,23 @@ FLAGS LEAST_REQUEST, RING_HASH, RANDOM, ORIGINAL_DESTINATION, MAGLEV, WEIGHTED_MAGLEV. + --logging-optional=LOGGING_OPTIONAL + This field can only be specified if logging is enabled for the backend + service. Configures whether all, none or a subset of optional fields + should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, + EXCLUDE_ALL_OPTIONAL, CUSTOM]. This can only be specified if the + protocol is HTTP, HTTPS, HTTP2, TCP, SSL, UDP, or UNSPECIFIED. Default + is EXCLUDE_ALL_OPTIONAL. LOGGING_OPTIONAL must be one of: + EXCLUDE_ALL_OPTIONAL, INCLUDE_ALL_OPTIONAL, CUSTOM. + + --logging-optional-fields=[LOGGING_OPTIONAL_FIELDS,...] + This field can only be specified if logging is enabled for the backend + service and "logConfig.optionalMode" was set to CUSTOM. Contains a + comma-separated list of optional fields you want to include in the + logs. For example: serverInstance, serverGkeDetails.cluster, + serverGkeDetails.pod.podNamespace. This can only be specified if the + protocol is HTTP, HTTPS, HTTP2, TCP, SSL, UDP, or UNSPECIFIED. + --logging-sample-rate=LOGGING_SAMPLE_RATE This field can only be specified if logging is enabled for the backend service. The value of the field must be a float in the range [0, 1]. diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index 662a5b783..cab7afa00 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -98,10 +98,10 @@ OPTIONAL FLAGS --type=TYPE; default="general-purpose" Type of commitment. memory-optimized indicates that the commitment is for memory-optimized VMs. TYPE must be one of: accelerator-optimized, - compute-optimized, compute-optimized-c2d, general-purpose, - general-purpose-e2, general-purpose-n2, general-purpose-n2d, - general-purpose-t2d, graphics-optimized, memory-optimized, - memory-optimized-m3. + compute-optimized, compute-optimized-c2d, compute-optimized-c3, + general-purpose, general-purpose-e2, general-purpose-n2, + general-purpose-n2d, general-purpose-t2d, graphics-optimized, + memory-optimized, memory-optimized-m3. Manage the reservations to be created with the commitment. diff --git a/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update b/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update index 9263968e5..765ea5780 100644 --- a/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update +++ b/gcloud/alpha/compute/instance-groups/managed/rolling-action/start-update @@ -19,6 +19,27 @@ DESCRIPTION start-update updates instances in a managed instance group, according to the given versions and the given update policy. + An instance template version can be either a global or regional resource. + +EXAMPLES + Running: + + gcloud alpha compute instance-groups managed rolling-action start-update example-managed-instance-group \ + --version='template=example-global-instance-template' + + Sets the group's instance template version to a global instance template + resource: 'example-global-instance-template'. + + To use a regional instance template, specify its full URL. + + Running: + + gcloud alpha compute instance-groups managed rolling-action start-update example-managed-instance-group \ + --version='template=https://www.googleapis.com/compute/alpha/projects/example-project/regions/us-central1/instanceTemplates/example-regional-instance-template' + + Sets the group's instance template version to a regional instance template + resource: 'example-regional-instance-template'. + POSITIONAL ARGUMENTS NAME Name of the managed instance group to operate on. diff --git a/gcloud/alpha/compute/instance-groups/managed/set-autoscaling b/gcloud/alpha/compute/instance-groups/managed/set-autoscaling index 12541544a..ce5271c3f 100644 --- a/gcloud/alpha/compute/instance-groups/managed/set-autoscaling +++ b/gcloud/alpha/compute/instance-groups/managed/set-autoscaling @@ -243,8 +243,14 @@ FLAGS autoscaler scales the group to have at least as many VMs as defined by the minimum required instances. After the configured duration, if there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after the + scaling schedule ends. --schedule-min-required-replicas=MIN_REQUIRED_REPLICAS How many VMs the autoscaler should provision for the duration of this diff --git a/gcloud/alpha/compute/instance-groups/managed/set-instance-template b/gcloud/alpha/compute/instance-groups/managed/set-instance-template index 111059a0e..2420b2d49 100644 --- a/gcloud/alpha/compute/instance-groups/managed/set-instance-template +++ b/gcloud/alpha/compute/instance-groups/managed/set-instance-template @@ -22,13 +22,34 @@ DESCRIPTION ▪ Use the rolling-action start-update command. ▪ Use the API to set the group's updatePolicy.type to PROACTIVE. +EXAMPLES + Running: + + gcloud alpha compute instance-groups managed set-instance-template \ + example-managed-instance-group --template=example-global-instance-template + + Sets the instance template for the 'example-managed-instance-group' group + to a global resource: 'example-global-instance-template'. + + To use a regional instance template, specify its full URL. + + Running: + + gcloud alpha compute instance-groups managed set-instance-template \ + example-managed-instance-group \ + --template=https://www.googleapis.com/compute/alpha/projects/example-project/regions/us-central1/instanceTemplates/example-regional-instance-template + + Sets the instance template for the 'example-managed-instance-group' group + to a regional resource: 'example-regional-instance-template'. + POSITIONAL ARGUMENTS NAME Name of the managed instance group to operate on. REQUIRED FLAGS --template=TEMPLATE - Compute Engine instance template resource to be used. + Specifies the instance template to use when creating new instances. An + instance template is either a global or regional resource. OPTIONAL FLAGS At most one of these can be specified: diff --git a/gcloud/alpha/compute/instance-groups/managed/update-autoscaling b/gcloud/alpha/compute/instance-groups/managed/update-autoscaling index 309e6ecd9..92e770d4a 100644 --- a/gcloud/alpha/compute/instance-groups/managed/update-autoscaling +++ b/gcloud/alpha/compute/instance-groups/managed/update-autoscaling @@ -142,10 +142,14 @@ FLAGS scaling schedule that is currently active the disabled scaling schedule stops being effective immediately after it moves into DISABLED state. If there is no need to maintain capacity, the - autoscaler starts removing instances after a 10-minute stabilization - period and (if configured) following scale-in controls. This ensures - you don't accidentally lose capacity immediately after the scaling - schedule ends. + autoscaler starts removing instances after the usual stabilization + period and after scale-in controls (if configured). For more + information, see Delays in scaling in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after + the scaling schedule ends. --enable-schedule=SCHEDULE_NAME Name of the scaling schedule to be enabled. @@ -162,9 +166,14 @@ FLAGS scaling schedule that is currently active, the deleted scaling schedule stops being effective immediately after it is deleted. If there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. This ensures you don't accidentally lose - capacity immediately after the scaling schedule ends. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after + the scaling schedule ends. --set-schedule=SCHEDULE_NAME A unique name for the scaling schedule to be configured. @@ -217,8 +226,14 @@ FLAGS autoscaler scales the group to have at least as many VMs as defined by the minimum required instances. After the configured duration, if there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after the + scaling schedule ends. --schedule-min-required-replicas=MIN_REQUIRED_REPLICAS How many VMs the autoscaler should provision for the duration of this diff --git a/gcloud/alpha/compute/instance-templates/create-with-container b/gcloud/alpha/compute/instance-templates/create-with-container index d0e1a510d..88123e4e6 100644 --- a/gcloud/alpha/compute/instance-templates/create-with-container +++ b/gcloud/alpha/compute/instance-templates/create-with-container @@ -596,10 +596,6 @@ FLAGS The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-tier=NETWORK_TIER Specifies the network tier that will be used to configure the instance. NETWORK_TIER must be one of: PREMIUM, STANDARD, FIXED_STANDARD. The diff --git a/gcloud/alpha/compute/instances/bulk/create b/gcloud/alpha/compute/instances/bulk/create index 8b450b9a6..fe479ab31 100644 --- a/gcloud/alpha/compute/instances/bulk/create +++ b/gcloud/alpha/compute/instances/bulk/create @@ -23,6 +23,7 @@ SYNOPSIS [--local-ssd=[device-name=DEVICE-NAME], [interface=INTERFACE],[size=SIZE]] [--location-policy=[ZONE=POLICY,...]] [--machine-type=MACHINE_TYPE] + [--maintenance-interval=MAINTENANCE_INTERVAL] [--max-count-per-zone=[ZONE=MAX_COUNT_PER_ZONE,...]] [--max-run-duration=MAX_RUN_DURATION] [--metadata=KEY=VALUE,[KEY=VALUE,...]] @@ -473,6 +474,23 @@ OPTIONAL FLAGS available machine types, run 'gcloud compute machine-types list'. If unspecified, the default type is n1-standard-1. + --maintenance-interval=MAINTENANCE_INTERVAL + Specifies how infrastructure upgrades should be applied to the VM. + MAINTENANCE_INTERVAL must be one of: + + PERIODIC + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. Security updates + will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. This may mean a VM + will take longer to receive an update than if it was configured for + AS_NEEDED. Security updates will still be applied as soonas they + are available. RECURRENT is used for GEN3 and Sliceof Hardware VMs. + --max-count-per-zone=[ZONE=MAX_COUNT_PER_ZONE,...] Maximum number of instances per zone specified as key-value pairs. The zone name is the key and the max count per zone is the value in that diff --git a/gcloud/alpha/compute/instances/create-with-container b/gcloud/alpha/compute/instances/create-with-container index 948e15549..b1fff7d3c 100644 --- a/gcloud/alpha/compute/instances/create-with-container +++ b/gcloud/alpha/compute/instances/create-with-container @@ -638,10 +638,6 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/alpha/compute/network-attachments/create b/gcloud/alpha/compute/network-attachments/create index 0742a0451..ea8dd7c21 100644 --- a/gcloud/alpha/compute/network-attachments/create +++ b/gcloud/alpha/compute/network-attachments/create @@ -12,7 +12,26 @@ SYNOPSIS [--subnets-region=SUBNETS_REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Create a Google Compute Engine network attachment. + (ALPHA) gcloud alpha compute network-attachments create is used to create + network attachments. A service consumer creates network attachments and + makes it available to producers. Service producers then use a multi-NIC VM + to form a bi-directional, non-NAT'd communication channel. + +EXAMPLES + $ gcloud alpha compute network-attachments create \ + NETWORK_ATTACHMENT_NAME --region=us-central1 \ + --subnets=MY_SUBNET --connection-preference=ACCEPT_MANUAL \ + --producer-accept-list=PROJECT1,PROJECT2 \ + --producer-reject-list=PROJECT3,PROJECT4 + + To create a network attachment with a textual description, run: + + $ gcloud alpha compute network-attachments create \ + NETWORK_ATTACHMENT_NAME --region=us-central1 \ + --subnets=MY_SUBNET --connection-preference=ACCEPT_MANUAL \ + --producer-accept-list=PROJECT1,PROJECT2 \ + --producer-reject-list=PROJECT3,PROJECT4 \ + --description='default network attachment' POSITIONAL ARGUMENTS NAME @@ -77,5 +96,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud compute network-attachments create + + $ gcloud beta compute network-attachments create diff --git a/gcloud/alpha/compute/network-attachments/delete b/gcloud/alpha/compute/network-attachments/delete index 20256b692..ce9ae25de 100644 --- a/gcloud/alpha/compute/network-attachments/delete +++ b/gcloud/alpha/compute/network-attachments/delete @@ -9,6 +9,12 @@ SYNOPSIS DESCRIPTION (ALPHA) Delete one or more Google Compute Engine network attachments. +EXAMPLES + To delete a network attachment, run: + + $ gcloud alpha compute network-attachments delete \ + NETWORK_ATTACHMENT_NAME --region=us-central1 + POSITIONAL ARGUMENTS NAME [NAME ...] Names of the network attachments to delete. @@ -46,5 +52,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud compute network-attachments delete + + $ gcloud beta compute network-attachments delete diff --git a/gcloud/alpha/compute/network-attachments/describe b/gcloud/alpha/compute/network-attachments/describe index 5c68eb3c6..dc2130a2a 100644 --- a/gcloud/alpha/compute/network-attachments/describe +++ b/gcloud/alpha/compute/network-attachments/describe @@ -9,6 +9,12 @@ SYNOPSIS DESCRIPTION (ALPHA) Describes a Google Compute Engine network attachment. +EXAMPLES + To describe a network attachment, run: + + $ gcloud alpha compute network-attachments describe \ + NETWORK_ATTACHMENT_NAME --region=us-central1 + POSITIONAL ARGUMENTS NAME Name of the network attachment to describe. @@ -46,5 +52,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud compute network-attachments describe + + $ gcloud beta compute network-attachments describe diff --git a/gcloud/alpha/compute/network-attachments/help b/gcloud/alpha/compute/network-attachments/help index 3a3d67fc9..42d2b7359 100644 --- a/gcloud/alpha/compute/network-attachments/help +++ b/gcloud/alpha/compute/network-attachments/help @@ -32,5 +32,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud compute network-attachments + + $ gcloud beta compute network-attachments diff --git a/gcloud/alpha/compute/network-attachments/list b/gcloud/alpha/compute/network-attachments/list index b5de07b54..ef2e6e3e6 100644 --- a/gcloud/alpha/compute/network-attachments/list +++ b/gcloud/alpha/compute/network-attachments/list @@ -11,6 +11,16 @@ SYNOPSIS DESCRIPTION (ALPHA) List Google Compute Engine network attachments. +EXAMPLES + To list all the network attachments, run: + + $ gcloud alpha compute network-attachments list + + To list the network attachments in given region(s), run: + + $ gcloud alpha compute network-attachments list \ + --regions=region-1,region-2 + POSITIONAL ARGUMENTS [NAME ...] (DEPRECATED) If provided, show details for the specified names and/or @@ -74,5 +84,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud compute network-attachments list + + $ gcloud beta compute network-attachments list diff --git a/gcloud/alpha/compute/network-endpoint-groups/create b/gcloud/alpha/compute/network-endpoint-groups/create index db410ea4f..66be0f7e4 100644 --- a/gcloud/alpha/compute/network-endpoint-groups/create +++ b/gcloud/alpha/compute/network-endpoint-groups/create @@ -56,8 +56,8 @@ FLAGS network is used if unspecified. This is only supported for NEGs with endpoint type gce-vm-ip-port, - non-gcp-private-ip-port, gce-vm-primary-ip, gce-vm-ip, or - private-service-connect. + non-gcp-private-ip-port, gce-vm-primary-ip, gce-vm-ip, + private-service-connect, internet-ip-port, or internet-fqdn-port. For Private Service Connect NEGs, you can optionally specify --network and --subnet if --psc-target-service points to a published service. If diff --git a/gcloud/alpha/compute/network-endpoint-groups/update b/gcloud/alpha/compute/network-endpoint-groups/update index f48429e20..a8d970933 100644 --- a/gcloud/alpha/compute/network-endpoint-groups/update +++ b/gcloud/alpha/compute/network-endpoint-groups/update @@ -6,8 +6,8 @@ SYNOPSIS gcloud alpha compute network-endpoint-groups update NAME (--add-endpoint=[fqdn=FQDN],[instance=INSTANCE],[ip=IP],[port=PORT] | --remove-endpoint=[fqdn=FQDN], - [instance=INSTANCE],[ip=IP],[port=PORT]) [--global | --zone=ZONE] - [GCLOUD_WIDE_FLAG ...] + [instance=INSTANCE],[ip=IP],[port=PORT]) + [--global | --region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update a Compute Engine network endpoint group. @@ -181,6 +181,26 @@ OPTIONAL FLAGS --global If set, the network endpoint group is global. + --region=REGION + Region of the network endpoint group to operate on. If not specified, + you might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + --zone=ZONE Zone of the network endpoint group to operate on. If not specified and the compute/zone property isn't set, you might be prompted to diff --git a/gcloud/alpha/compute/queued-resources/create b/gcloud/alpha/compute/queued-resources/create index 4489e887e..32e387e0c 100644 --- a/gcloud/alpha/compute/queued-resources/create +++ b/gcloud/alpha/compute/queued-resources/create @@ -24,6 +24,7 @@ SYNOPSIS [--local-ssd=[device-name=DEVICE-NAME], [interface=INTERFACE],[size=SIZE]] [--location-policy=[ZONE=POLICY,...]] [--machine-type=MACHINE_TYPE] + [--maintenance-interval=MAINTENANCE_INTERVAL] [--max-run-duration=MAX_RUN_DURATION] [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--metadata-from-file=KEY=LOCAL_FILE_PATH,[...]] @@ -457,6 +458,23 @@ OPTIONAL FLAGS available machine types, run 'gcloud compute machine-types list'. If unspecified, the default type is n1-standard-1. + --maintenance-interval=MAINTENANCE_INTERVAL + Specifies how infrastructure upgrades should be applied to the VM. + MAINTENANCE_INTERVAL must be one of: + + PERIODIC + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. Security updates + will still be applied as soon as they are available. + RECURRENT + VMs receive infrastructure and hypervisor updates on a periodic + basis, minimizing the number of maintenance operations (live + migrations or terminations) on an individual VM. This may mean a VM + will take longer to receive an update than if it was configured for + AS_NEEDED. Security updates will still be applied as soonas they + are available. RECURRENT is used for GEN3 and Sliceof Hardware VMs. + --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration relative to the VM instance's most-recent start time. Format the diff --git a/gcloud/alpha/container/azure/clients/create b/gcloud/alpha/container/azure/clients/create index d6b629bd2..8b8349c9b 100644 --- a/gcloud/alpha/container/azure/clients/create +++ b/gcloud/alpha/container/azure/clients/create @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud alpha container azure clients create (CLIENT : --location=LOCATION) - --application-id=APP_ID --tenant-id=TENANT_ID [--validate-only] - [GCLOUD_WIDE_FLAG ...] + --application-id=APP_ID --tenant-id=TENANT_ID [--async] + [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create an Azure client. @@ -52,6 +52,10 @@ REQUIRED FLAGS client. OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --validate-only Validate the creation of the client, but don't actually perform it. diff --git a/gcloud/alpha/container/azure/clients/delete b/gcloud/alpha/container/azure/clients/delete index 49e73b0f6..7689ee8f5 100644 --- a/gcloud/alpha/container/azure/clients/delete +++ b/gcloud/alpha/container/azure/clients/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud alpha container azure clients delete (CLIENT : --location=LOCATION) - [--allow-missing] [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete an Azure client. @@ -46,6 +46,10 @@ FLAGS Allow idempotent deletion of cluster. The request will still succeed in case the cluster does not exist. + --async + Return immediately, without waiting for the operation in progress to + complete. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/backup-restore/backup-plans/create b/gcloud/alpha/container/backup-restore/backup-plans/create index 60b75193c..1103475d9 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/create +++ b/gcloud/alpha/container/backup-restore/backup-plans/create @@ -127,7 +127,7 @@ OPTIONAL FLAGS Schedule on which backups will be automatically created. Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, "10 3 * * " will automatically create a backup at 0310 + For example, 10 3 * * * will automatically create a backup at 0310 every day. All times are interpreted as UTC. The minimum interval between scheduled backups is 10 minutes. diff --git a/gcloud/alpha/container/backup-restore/backup-plans/update b/gcloud/alpha/container/backup-restore/backup-plans/update index b68284b84..68600b81f 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/update +++ b/gcloud/alpha/container/backup-restore/backup-plans/update @@ -144,7 +144,7 @@ FLAGS Schedule on which backups will be automatically created. Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, "10 3 * * " will automatically create a backup at 0310 + For example, 10 3 * * * will automatically create a backup at 0310 every day. All times are interpreted as UTC. The minimum interval between scheduled backups is 10 minutes. diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/help b/gcloud/alpha/container/bare-metal/admin-clusters/help index fb7dea6f8..ab82a4b6f 100644 --- a/gcloud/alpha/container/bare-metal/admin-clusters/help +++ b/gcloud/alpha/container/bare-metal/admin-clusters/help @@ -27,7 +27,8 @@ COMMANDS (ALPHA) List Anthos on bare metal admin clusters. query-version-config - (ALPHA) Query Anthos on bare metal admin cluster version configuration. + (ALPHA) Query versions for creating or upgrading an Anthos on bare + metal admin cluster. update (ALPHA) Update an Anthos on bare metal admin cluster. diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config b/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config index a160a7d14..d7ed2b924 100644 --- a/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config +++ b/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config @@ -1,6 +1,7 @@ NAME gcloud alpha container bare-metal admin-clusters query-version-config - - query Anthos on bare metal admin cluster version configuration + query versions for creating or upgrading an Anthos on bare metal admin + cluster SYNOPSIS gcloud alpha container bare-metal admin-clusters query-version-config @@ -8,7 +9,8 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Query Anthos on bare metal admin cluster version configuration. + (ALPHA) Query versions for creating or upgrading an Anthos on bare metal + admin cluster. EXAMPLES To query versions for creating an admin cluster, run: @@ -21,11 +23,11 @@ EXAMPLES $ gcloud alpha container bare-metal admin-clusters \ query-version-config --admin-cluster=my-admin-cluster FLAGS - Version configuration type + Use cases for querying versions. - Upgrade configuration + Upgrade an Anthos on bare metal user cluster use case. - Admin cluster resource - admin cluster to query version configuration + Admin cluster resource - Admin cluster to query versions for upgrade. 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: @@ -35,6 +37,7 @@ FLAGS ▫ set the property core/project. To set the location attribute: ▫ provide the argument --admin-cluster on the command line with a fully specified name; + ▫ provide the argument --location on the command line; ▫ set the property container_bare_metal/location. --admin-cluster=ADMIN_CLUSTER diff --git a/gcloud/alpha/container/bare-metal/clusters/help b/gcloud/alpha/container/bare-metal/clusters/help index 2a4ae2252..d89dd0c90 100644 --- a/gcloud/alpha/container/bare-metal/clusters/help +++ b/gcloud/alpha/container/bare-metal/clusters/help @@ -32,7 +32,8 @@ COMMANDS (ALPHA) List Anthos clusters on bare metal. query-version-config - (ALPHA) Query Anthos on bare metal version configuration. + (ALPHA) Query versions for creating or upgrading an Anthos on bare + metal user cluster. update (ALPHA) Update an Anthos cluster on bare metal. diff --git a/gcloud/alpha/container/bare-metal/clusters/query-version-config b/gcloud/alpha/container/bare-metal/clusters/query-version-config index 817259169..2896f613b 100644 --- a/gcloud/alpha/container/bare-metal/clusters/query-version-config +++ b/gcloud/alpha/container/bare-metal/clusters/query-version-config @@ -1,23 +1,26 @@ NAME gcloud alpha container bare-metal clusters query-version-config - query - Anthos on bare metal version configuration + versions for creating or upgrading an Anthos on bare metal user cluster SYNOPSIS gcloud alpha container bare-metal clusters query-version-config (--cluster=CLUSTER : [--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP - : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global"]) + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global" --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT]) [--location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Query Anthos on bare metal version configuration. + (ALPHA) Query versions for creating or upgrading an Anthos on bare metal + user cluster. EXAMPLES To query versions for creating a cluster with an admin cluster membership - named my-admin-cluster-membership, run: + named my-admin-cluster-membership managed in project + my-admin-cluster-project run: $ gcloud alpha container bare-metal clusters query-version-config \ - --admin-cluster-membership=my-admin-cluster-membership + --admin-cluster-membership=my-admin-cluster-membership \ + --admin-cluster-membership-project=my-admin-cluster-project To query versions for upgrading a user cluster named my-user-cluster, run: @@ -25,13 +28,13 @@ EXAMPLES --cluster=my-user-cluster REQUIRED FLAGS - Version configuration type + Use cases for querying versions. Exactly one of these must be specified: - Upgrade configuration + Upgrade an Anthos on bare metal user cluster use case. - Cluster resource - cluster to query version configuration This + Cluster resource - Cluster to query versions for upgrade. 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: @@ -41,6 +44,7 @@ REQUIRED FLAGS ▫ set the property core/project. To set the location attribute: ▫ provide the argument --cluster on the command line with a fully specified name; + ▫ provide the argument --location on the command line; ▫ set the property container_bare_metal/location. --cluster=CLUSTER @@ -48,17 +52,12 @@ REQUIRED FLAGS To set the cluster attribute: ◇ provide the argument --cluster on the command line. - Create configuration + Create an Anthos on bare metal user cluster use case. - Admin cluster membership resource - membership of the admin cluster. - Membership can be the membership ID or the full resource name. 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 --admin-cluster-membership on the command - line with a fully specified name; - ▫ provide the argument --project on the command line; - ▫ set the property core/project. + Admin cluster membership resource - Membership of the admin cluster to + query versions for create. Membership can be the membership ID or the + full resource name. The arguments in this group can be used to specify + the attributes of this resource. --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP ID of the admin_cluster_membership or fully qualified identifier @@ -78,6 +77,16 @@ REQUIRED FLAGS ◇ provide the argument --admin-cluster-membership-location on the command line. + --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT + Project ID of the Google Cloud project for the + admin_cluster_membership. To set the project attribute: + ◇ provide the argument --admin-cluster-membership on the + command line with a fully specified name; + ◇ provide the argument --admin-cluster-membership-project on + the command line; + ◇ provide the argument --project on the command line; + ◇ set the property core/project. + OPTIONAL FLAGS Location resource - Google Cloud location to query version configuration. This represents a Cloud resource. (NOTE) Some attributes are not given diff --git a/gcloud/alpha/container/fleet/memberships/register b/gcloud/alpha/container/fleet/memberships/register index 7047b02f8..5186662f6 100644 --- a/gcloud/alpha/container/fleet/memberships/register +++ b/gcloud/alpha/container/fleet/memberships/register @@ -46,72 +46,73 @@ DESCRIPTION avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific + kubeconfig file, and install the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE URI: + Register a GKE cluster referenced from a GKE URI: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect agent using service account key file: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster first, and install the Connect agent later. + Register a GKE cluster first, and install the Connect agent later. $ gcloud alpha container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud alpha container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --enable-workload-identity + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity - Register a GKE cluster, and install a specific version of the Connect - agent: + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=20220819-00-00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=20220819-00-00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install the - Connect agent: + Register a GKE cluster and output a manifest that can be used to install + the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS Membership resource - The group of arguments defining a membership. The diff --git a/gcloud/alpha/container/hub/memberships/register b/gcloud/alpha/container/hub/memberships/register index cc918243d..fcd66f9fb 100644 --- a/gcloud/alpha/container/hub/memberships/register +++ b/gcloud/alpha/container/hub/memberships/register @@ -46,72 +46,73 @@ DESCRIPTION avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific + kubeconfig file, and install the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE URI: + Register a GKE cluster referenced from a GKE URI: $ gcloud alpha container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect agent using service account key file: $ gcloud alpha container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster first, and install the Connect agent later. + Register a GKE cluster first, and install the Connect agent later. $ gcloud alpha container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud alpha container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --enable-workload-identity + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity - Register a GKE cluster, and install a specific version of the Connect - agent: + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud alpha container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=20220819-00-00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=20220819-00-00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install the - Connect agent: + Register a GKE cluster and output a manifest that can be used to install + the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS Membership resource - The group of arguments defining a membership. The diff --git a/gcloud/alpha/container/vmware/clusters/help b/gcloud/alpha/container/vmware/clusters/help index 615d7cb57..efb706cab 100644 --- a/gcloud/alpha/container/vmware/clusters/help +++ b/gcloud/alpha/container/vmware/clusters/help @@ -32,7 +32,8 @@ COMMANDS (ALPHA) List Anthos clusters on VMware. query-version-config - (ALPHA) Query Anthos on VMware version configuration. + (ALPHA) Query versions for creating or upgrading an Anthos on VMware + user cluster. update (ALPHA) Update an Anthos cluster on VMware. diff --git a/gcloud/alpha/container/vmware/clusters/query-version-config b/gcloud/alpha/container/vmware/clusters/query-version-config index f8992680f..0f864abb5 100644 --- a/gcloud/alpha/container/vmware/clusters/query-version-config +++ b/gcloud/alpha/container/vmware/clusters/query-version-config @@ -1,23 +1,26 @@ NAME - gcloud alpha container vmware clusters query-version-config - query Anthos - on VMware version configuration + gcloud alpha container vmware clusters query-version-config - query + versions for creating or upgrading an Anthos on VMware user cluster SYNOPSIS gcloud alpha container vmware clusters query-version-config (--cluster=CLUSTER : [--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP - : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global"]) + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global" --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT]) [--location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Query Anthos on VMware version configuration. + (ALPHA) Query versions for creating or upgrading an Anthos on VMware user + cluster. EXAMPLES To query versions for creating a cluster with an admin cluster membership - named my-admin-cluster-membership, run: + named my-admin-cluster-membership managed in project + my-admin-cluster-project run: $ gcloud alpha container vmware clusters query-version-config \ - --admin-cluster-membership=my-admin-cluster-membership + --admin-cluster-membership=my-admin-cluster-membership \ + --admin-cluster-membership-project=my-admin-cluster-project To query versions for upgrading a user cluster named my-user-cluster, run: @@ -25,13 +28,13 @@ EXAMPLES --cluster=my-user-cluster REQUIRED FLAGS - Version configuration type + Use cases for querying versions. Exactly one of these must be specified: - Upgrade configuration + Upgrade an Anthos on VMware user cluster use case. - Cluster resource - cluster to query version configuration This + Cluster resource - Cluster to query versions for upgrade. 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: @@ -41,6 +44,7 @@ REQUIRED FLAGS ▫ set the property core/project. To set the location attribute: ▫ provide the argument --cluster on the command line with a fully specified name; + ▫ provide the argument --location on the command line; ▫ set the property container_vmware/location. --cluster=CLUSTER @@ -48,17 +52,12 @@ REQUIRED FLAGS To set the cluster attribute: ◇ provide the argument --cluster on the command line. - Create configuration + Create an Anthos on VMware user cluster use case. - Admin cluster membership resource - membership of the admin cluster. - Membership can be the membership ID or the full resource name. 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 --admin-cluster-membership on the command - line with a fully specified name; - ▫ provide the argument --project on the command line; - ▫ set the property core/project. + Admin cluster membership resource - Membership of the admin cluster to + query versions for create. Membership can be the membership ID or the + full resource name. The arguments in this group can be used to specify + the attributes of this resource. --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP ID of the admin_cluster_membership or fully qualified identifier @@ -78,6 +77,16 @@ REQUIRED FLAGS ◇ provide the argument --admin-cluster-membership-location on the command line. + --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT + Project ID of the Google Cloud project for the + admin_cluster_membership. To set the project attribute: + ◇ provide the argument --admin-cluster-membership on the + command line with a fully specified name; + ◇ provide the argument --admin-cluster-membership-project on + the command line; + ◇ provide the argument --project on the command line; + ◇ set the property core/project. + OPTIONAL FLAGS Location resource - Google Cloud location to query version configuration. This represents a Cloud resource. (NOTE) Some attributes are not given diff --git a/gcloud/alpha/firebase/test/android/help b/gcloud/alpha/firebase/test/android/help index 42e480f79..755b570aa 100644 --- a/gcloud/alpha/firebase/test/android/help +++ b/gcloud/alpha/firebase/test/android/help @@ -64,10 +64,6 @@ GROUPS COMMANDS COMMAND is one of the following: - list-device-capacities - (ALPHA) List capacity information for all supported Android models & - versions. - run (ALPHA) Invoke a test in Firebase Test Lab for Android and view test results. diff --git a/gcloud/alpha/firebase/test/android/run b/gcloud/alpha/firebase/test/android/run index a24fce4a4..8a6587eac 100644 --- a/gcloud/alpha/firebase/test/android/run +++ b/gcloud/alpha/firebase/test/android/run @@ -504,7 +504,7 @@ DEPRECATED DEVICE DIMENSIONS FLAGS --device-ids=MODEL_ID,[MODEL_ID,...], -d MODEL_ID,[MODEL_ID,...] The list of MODEL_IDs to test against (default: one device model determined by the Firebase Test Lab device catalog; see TAGS listed by - the $ gcloud alpha firebase test android devices list command). + the $ gcloud alpha firebase test android models list command). --locales=LOCALE,[LOCALE,...], -l LOCALE,[LOCALE,...] The list of LOCALEs to test against (default: a single locale diff --git a/gcloud/alpha/firebase/test/ios/help b/gcloud/alpha/firebase/test/ios/help index 601a0eab6..44f3ad475 100644 --- a/gcloud/alpha/firebase/test/ios/help +++ b/gcloud/alpha/firebase/test/ios/help @@ -51,10 +51,6 @@ GROUPS COMMANDS COMMAND is one of the following: - list-device-capacities - (ALPHA) List capacity information for all supported iOS models & - versions. - run (ALPHA) Invoke a test in Firebase Test Lab for iOS and view test results. diff --git a/gcloud/alpha/iam/help b/gcloud/alpha/iam/help index 84bf15426..e81c1e280 100644 --- a/gcloud/alpha/iam/help +++ b/gcloud/alpha/iam/help @@ -36,6 +36,9 @@ GROUPS service-accounts (ALPHA) Create and manipulate service accounts. + workforce-pools + (ALPHA) Create and manage workforce pools. + workload-identity-pools (ALPHA) Manage IAM workload identity pools. diff --git a/gcloud/alpha/iam/workforce-pools/create b/gcloud/alpha/iam/workforce-pools/create new file mode 100644 index 000000000..660e39941 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/create @@ -0,0 +1,96 @@ +NAME + gcloud alpha iam workforce-pools create - create a new workforce pool under + an organization + +SYNOPSIS + gcloud alpha iam workforce-pools create + (WORKFORCE_POOL : --location=LOCATION) --organization=ORGANIZATION + [--async] [--description=DESCRIPTION] [--disabled] + [--display-name=DISPLAY_NAME] [--session-duration=SESSION_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creates a workforce pool under an organization given a valid + organization ID. + +EXAMPLES + The following command creates a workforce pool with ID my-workforce-pool in + the organization 12345: + + $ gcloud alpha iam workforce-pools create my-workforce-pool \ + --organization=12345 + + The following command creates a workforce pool with ID my-workforce-pool + with explicit values for all required and optional parameters: + + $ gcloud alpha iam workforce-pools create my-workforce-pool \ + --organization=12345 --location=global \ + --display-name="My Workforce Pool" \ + --description="My workforce pool + description." --session-duration="7200s" --disabled + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to create. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --organization=ORGANIZATION + The parent organization of the workforce pool to create. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description for the workforce pool. Cannot exceed 256 characters in + length. + + --disabled + Whether or not the workforce pool is disabled. + + --display-name=DISPLAY_NAME + A display name for the workforce pool. Cannot exceed 32 characters in + length. + + --session-duration=SESSION_DURATION + How long the Google Cloud access tokens, console sign-in sessions, and + gcloud sign-in sessions from this workforce pool are valid. Must be + greater than 15 minutes (900s) and less than 12 hours (43200s). If not + configured, minted credentials will have a default duration of one hour + (3600s). + +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 iam workforce-pools create + + $ gcloud beta iam workforce-pools create + diff --git a/gcloud/alpha/iam/workforce-pools/create-cred-config b/gcloud/alpha/iam/workforce-pools/create-cred-config new file mode 100644 index 000000000..510356e45 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/create-cred-config @@ -0,0 +1,147 @@ +NAME + gcloud alpha iam workforce-pools create-cred-config - create a + configuration file for generated credentials + +SYNOPSIS + gcloud alpha iam workforce-pools create-cred-config AUDIENCE + --output-file=OUTPUT_FILE + --workforce-pool-user-project=WORKFORCE_POOL_USER_PROJECT + (--credential-source-file=CREDENTIAL_SOURCE_FILE + | --credential-source-url=CREDENTIAL_SOURCE_URL + | --executable-command=EXECUTABLE_COMMAND) + [--credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME] + [--credential-source-headers=[key=value,...]] + [--credential-source-type=CREDENTIAL_SOURCE_TYPE] + [--subject-token-type=SUBJECT_TOKEN_TYPE] + [--executable-interactive-timeout-millis=EXECUTABLE_INTERACTIVE_TIMEOUT_MILLIS --executable-output-file=EXECUTABLE_OUTPUT_FILE --executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS] + [--service-account=SERVICE_ACCOUNT + : --service-account-token-lifetime-seconds=SERVICE_ACCOUNT_TOKEN_LIFETIME_SECONDS] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) This command creates a configuration file to allow access to + authenticated Google Cloud actions from a variety of external user + accounts. + +EXAMPLES + To create a file-sourced credential configuration for your project, run: + + $ gcloud alpha iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --credential-source-file=$PATH_TO_OIDC_ID_TOKEN \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To create a URL-sourced credential configuration for your project, run: + + $ gcloud alpha iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --credential-source-url=$URL_FOR_OIDC_TOKEN \ + --credential-source-headers=Key=Value \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To create an executable-source credential configuration for your project, + run the following command: + + $ gcloud alpha iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --executable-command=$EXECUTABLE_COMMAND \ + --executable-timeout-millis=30000 \ + --executable-output-file=$CACHE_FILE \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To use the resulting file for any of these commands, set the + GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the + generated file. + +POSITIONAL ARGUMENTS + AUDIENCE + The workforce pool provider resource name. + +REQUIRED FLAGS + --output-file=OUTPUT_FILE + Location to store the generated credential configuration file. + + --workforce-pool-user-project=WORKFORCE_POOL_USER_PROJECT + The client project number used to identify the application (client + project) to the server when calling Google APIs. The user principal + must have serviceusage.services.use IAM permission to use the specified + project. + + Credential types. + + Exactly one of these must be specified: + + --credential-source-file=CREDENTIAL_SOURCE_FILE + The location of the file which stores the credential. + + --credential-source-url=CREDENTIAL_SOURCE_URL + The URL to obtain the credential from. + + --executable-command=EXECUTABLE_COMMAND + The full command to run to retrieve the credential. Must be an + absolute path for the program including arguments. + +OPTIONAL FLAGS + --credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME + The subject token field name (key) in a JSON credential source. + + --credential-source-headers=[key=value,...] + Headers to use when querying the credential-source-url. + + --credential-source-type=CREDENTIAL_SOURCE_TYPE + The format of the credential source (JSON or text). + + --subject-token-type=SUBJECT_TOKEN_TYPE + The type of token being used for authorization. This defaults to + urn:ietf:params:oauth:token-type:id_token. + + Arguments for an executable type credential source. + + --executable-interactive-timeout-millis=EXECUTABLE_INTERACTIVE_TIMEOUT_MILLIS + The timeout duration, in milliseconds, to wait for the executable to + finish when the command is running in interactive mode. + + --executable-output-file=EXECUTABLE_OUTPUT_FILE + The absolute path to the file storing the executable response. + + --executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS + The timeout duration in milliseconds for waiting for the executable + to finish. + + Service account impersonation options. + + --service-account=SERVICE_ACCOUNT + The email of the service account to impersonate. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --service-account-token-lifetime-seconds=SERVICE_ACCOUNT_TOKEN_LIFETIME_SECONDS + The desired lifetime duration of the service account access token in + seconds. This defaults to one hour when not provided. If a lifetime + greater than one hour is required, the service account must be added + as an allowed value in an Organization Policy that enforces the + constraints/iam.allowServiceAccountCredentialLifetimeExtension + constraint. + +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 iam workforce-pools create-cred-config + + $ gcloud beta iam workforce-pools create-cred-config + diff --git a/gcloud/alpha/iam/workforce-pools/create-login-config b/gcloud/alpha/iam/workforce-pools/create-login-config new file mode 100644 index 000000000..bef3124ed --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/create-login-config @@ -0,0 +1,49 @@ +NAME + gcloud alpha iam workforce-pools create-login-config - create a login + configuration file to enable sign-in via a web-based authorization flow + using Workforce Identity Federation + +SYNOPSIS + gcloud alpha iam workforce-pools create-login-config AUDIENCE + --output-file=OUTPUT_FILE [--activate] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) This command creates a configuration file to enable browser based + third-party sign in with Workforce Identity Federation through gcloud auth + login --login-config=/path/to/config.json. + +EXAMPLES + To create a login configuration for your project, run: + + $ gcloud alpha iam workforce-pools create-login-config \ + locations/global/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --output-file=login-config.json + +POSITIONAL ARGUMENTS + AUDIENCE + Workforce pool provider resource name. + +REQUIRED FLAGS + --output-file=OUTPUT_FILE + Location to store the generated login configuration file. + +OPTIONAL FLAGS + --activate + Sets the property auth/login_config_file to the created login + configuration file. Calling gcloud auth login will automatically use + this login configuration unless it is explicitly unset. + +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. + diff --git a/gcloud/alpha/iam/workforce-pools/delete b/gcloud/alpha/iam/workforce-pools/delete new file mode 100644 index 000000000..99199549a --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/delete @@ -0,0 +1,63 @@ +NAME + gcloud alpha iam workforce-pools delete - delete a workforce pool + +SYNOPSIS + gcloud alpha iam workforce-pools delete + (WORKFORCE_POOL : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a workforce pool. + +EXAMPLES + The following command deletes a workforce pool with ID my-workforce-pool: + + $ gcloud alpha iam workforce-pools delete my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to delete. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools delete + + $ gcloud beta iam workforce-pools delete + diff --git a/gcloud/alpha/iam/workforce-pools/describe b/gcloud/alpha/iam/workforce-pools/describe new file mode 100644 index 000000000..2d0b4dd4c --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/describe @@ -0,0 +1,58 @@ +NAME + gcloud alpha iam workforce-pools describe - describe a workforce pool + +SYNOPSIS + gcloud alpha iam workforce-pools describe + (WORKFORCE_POOL : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a workforce pool. + +EXAMPLES + The following command describes a workforce pool with ID my-workforce-pool: + + $ gcloud alpha iam workforce-pools describe my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to describe. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools describe + + $ gcloud beta iam workforce-pools describe + diff --git a/gcloud/alpha/iam/workforce-pools/help b/gcloud/alpha/iam/workforce-pools/help new file mode 100644 index 000000000..ab5beabc2 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/help @@ -0,0 +1,62 @@ +NAME + gcloud alpha iam workforce-pools - create and manage workforce pools + +SYNOPSIS + gcloud alpha iam workforce-pools GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud alpha iam workforce-pools group lets you create and + manage workforce pools for organizations on the Google Cloud Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + (ALPHA) Manage IAM workforce pool long-running operations. + + providers + (ALPHA) Create and manage workforce pool providers. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a new workforce pool under an organization. + + create-cred-config + (ALPHA) Create a configuration file for generated credentials. + + create-login-config + (ALPHA) Create a login configuration file to enable sign-in via a + web-based authorization flow using Workforce Identity Federation. + + delete + (ALPHA) Delete a workforce pool. + + describe + (ALPHA) Describe a workforce pool. + + list + (ALPHA) List the workforce pools for an organization. + + undelete + (ALPHA) Undelete a workforce pool. + + update + (ALPHA) Update a workforce pool. + +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 iam workforce-pools + + $ gcloud beta iam workforce-pools + diff --git a/gcloud/alpha/iam/workforce-pools/list b/gcloud/alpha/iam/workforce-pools/list new file mode 100644 index 000000000..c5f1bc6e1 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/list @@ -0,0 +1,81 @@ +NAME + gcloud alpha iam workforce-pools list - list the workforce pools for an + organization + +SYNOPSIS + gcloud alpha iam workforce-pools list --location=LOCATION + --organization=ORGANIZATION [--show-deleted] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Lists all of the workforce pools for an organization given a valid + organization ID. + + This command can fail for the following reasons: + ▪ The organization specified does not exist. + ▪ The active account does not have permission to access the + organization. + +EXAMPLES + The following command lists the workforce pools for an organization with + the ID 12345, including soft-deleted pools: + + $ gcloud alpha iam workforce-pools list --organization=12345 \ + --location=global --show-deleted + +REQUIRED FLAGS + --location=LOCATION + The location of the workforce pools to list. + + --organization=ORGANIZATION + The parent organization of the workforce pools to list. + +FLAGS + --show-deleted + Show soft-deleted workforce pools by specifying this flag. + +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. + +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 iam workforce-pools list + + $ gcloud beta iam workforce-pools list + diff --git a/gcloud/alpha/iam/workforce-pools/operations/describe b/gcloud/alpha/iam/workforce-pools/operations/describe new file mode 100644 index 000000000..16d43b45a --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/operations/describe @@ -0,0 +1,75 @@ +NAME + gcloud alpha iam workforce-pools operations describe - describe a workforce + pool operation + +SYNOPSIS + gcloud alpha iam workforce-pools operations describe + (OPERATION : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a workforce pool operation. + +EXAMPLES + To describe the long-running workforce pool operation with the ID + my-operation, run: + + $ gcloud alpha iam workforce-pools operations describe \ + my-operation --workforce-pool="my-workforce-pool" \ + --location="global" + +POSITIONAL ARGUMENTS + Workforce pool operation resource - The workforce pool long-running + operation to describe. The arguments in this group can be used to specify + the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool operation or fully qualified identifier for + the workforce pool operation. To set the operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools operations describe + + $ gcloud beta iam workforce-pools operations describe + diff --git a/gcloud/alpha/iam/workforce-pools/operations/help b/gcloud/alpha/iam/workforce-pools/operations/help new file mode 100644 index 000000000..6a30fcbb6 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/operations/help @@ -0,0 +1,31 @@ +NAME + gcloud alpha iam workforce-pools operations - manage IAM workforce pool + long-running operations + +SYNOPSIS + gcloud alpha iam workforce-pools operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Commands for managing IAM workforce pool long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a workforce pool operation. + +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 iam workforce-pools operations + + $ gcloud beta iam workforce-pools operations + diff --git a/gcloud/alpha/iam/workforce-pools/providers/create-oidc b/gcloud/alpha/iam/workforce-pools/providers/create-oidc new file mode 100644 index 000000000..9f7fea88f --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/create-oidc @@ -0,0 +1,206 @@ +NAME + gcloud alpha iam workforce-pools providers create-oidc - create a new OIDC + workforce pool provider + +SYNOPSIS + gcloud alpha iam workforce-pools providers create-oidc + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + --attribute-mapping=[ATTRIBUTE_MAPPING,...] --client-id=CLIENT_ID + --issuer-uri=ISSUER_URI [--async] + [--attribute-condition=ATTRIBUTE_CONDITION] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new OIDC workforce pool provider. + +EXAMPLES + The following command creates a disabled OIDC workforce pool provider with + the ID my-workforce-pool-provider. Explicit values for all required and + optional parameters are provided. + + $ gcloud alpha iam workforce-pools providers create-oidc \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" --client-id="client-id" \ + --issuer-uri="https://test-idp.com" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to create. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +REQUIRED FLAGS + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --client-id=CLIENT_ID + The OIDC client ID. This must match the audience claim of the JWT + issued by the identity provider. + + --issuer-uri=ISSUER_URI + The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers create-oidc + + $ gcloud beta iam workforce-pools providers create-oidc + diff --git a/gcloud/alpha/iam/workforce-pools/providers/delete b/gcloud/alpha/iam/workforce-pools/providers/delete new file mode 100644 index 000000000..682704ce2 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/delete @@ -0,0 +1,80 @@ +NAME + gcloud alpha iam workforce-pools providers delete - delete a workforce pool + provider + +SYNOPSIS + gcloud alpha iam workforce-pools providers delete + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a workforce pool provider. + +EXAMPLES + The following command deletes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud alpha iam workforce-pools providers delete \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to delete. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers delete + + $ gcloud beta iam workforce-pools providers delete + diff --git a/gcloud/alpha/iam/workforce-pools/providers/describe b/gcloud/alpha/iam/workforce-pools/providers/describe new file mode 100644 index 000000000..4f3a6a78a --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/describe @@ -0,0 +1,75 @@ +NAME + gcloud alpha iam workforce-pools providers describe - describe a workforce + pool provider + +SYNOPSIS + gcloud alpha iam workforce-pools providers describe + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a workforce pool provider. + +EXAMPLES + The following command describes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud alpha iam workforce-pools providers describe \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to + describe. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers describe + + $ gcloud beta iam workforce-pools providers describe + diff --git a/gcloud/alpha/iam/workforce-pools/providers/help b/gcloud/alpha/iam/workforce-pools/providers/help new file mode 100644 index 000000000..cafb69382 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/help @@ -0,0 +1,54 @@ +NAME + gcloud alpha iam workforce-pools providers - create and manage workforce + pool providers + +SYNOPSIS + gcloud alpha iam workforce-pools providers GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud alpha iam workforce-pools providers group lets you + create and manage workforce pool providers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + (ALPHA) Manage IAM workforce pool provider long-running operations. + +COMMANDS + COMMAND is one of the following: + + create-oidc + (ALPHA) Create a new OIDC workforce pool provider. + + delete + (ALPHA) Delete a workforce pool provider. + + describe + (ALPHA) Describe a workforce pool provider. + + list + (ALPHA) List workforce pool providers. + + undelete + (ALPHA) Undelete a workforce pool provider. + + update-oidc + (ALPHA) Update an OIDC workforce pool provider. + +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 iam workforce-pools providers + + $ gcloud beta iam workforce-pools providers + diff --git a/gcloud/alpha/iam/workforce-pools/providers/list b/gcloud/alpha/iam/workforce-pools/providers/list new file mode 100644 index 000000000..fe6bd5d54 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/list @@ -0,0 +1,94 @@ +NAME + gcloud alpha iam workforce-pools providers list - list workforce pool + providers + +SYNOPSIS + gcloud alpha iam workforce-pools providers list + (--workforce-pool=WORKFORCE_POOL : --location=LOCATION) + [--show-deleted] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List workforce pool providers. + +EXAMPLES + The following command lists the workforce pool providers in the workforce + pool with ID my-workforce-pool, including soft-deleted pools: + + $ gcloud alpha iam workforce-pools providers list \ + --workforce-pool="my-workforce-pool" --location="global" \ + --show-deleted + +REQUIRED FLAGS + Workforce pool resource - The parent workforce pool of the workforce pool + providers to list. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + --workforce-pool=WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce-pool attribute: + ▸ provide the argument --workforce-pool on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The location for the workforce pool. To set the location attribute: + ▸ provide the argument --workforce-pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --show-deleted + Show soft-deleted workforce pool providers by specifying this flag. + +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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers list + + $ gcloud beta iam workforce-pools providers list + diff --git a/gcloud/alpha/iam/workforce-pools/providers/operations/describe b/gcloud/alpha/iam/workforce-pools/providers/operations/describe new file mode 100644 index 000000000..e11c79688 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/operations/describe @@ -0,0 +1,89 @@ +NAME + gcloud alpha iam workforce-pools providers operations describe - describe a + workforce pool provider operation + +SYNOPSIS + gcloud alpha iam workforce-pools providers operations describe + (OPERATION : --location=LOCATION + --provider=PROVIDER --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a workforce pool provider operation. + +EXAMPLES + To describe the long-running workforce pool provider operation with the ID + my-operation, run: + + $ gcloud alpha iam workforce-pools providers operations describe \ + my-operation --workforce-pool="my-workforce-pool" \ + --provider="my-provider" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider operation resource - The workforce pool provider + long-running operation to describe. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool provider operation or fully qualified + identifier for the workforce pool provider operation. To set the + operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --provider=PROVIDER + The ID to use for the workforce pool provider, which becomes the + final component of the resource name. This value must be unique + within the workforce pool, 4-32 characters in length, and may contain + the characters [a-z0-9-]. The prefix gcp- is reserved for use by + Google, and may not be specified. + + To set the provider attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --provider on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers operations describe + + $ gcloud beta iam workforce-pools providers operations describe + diff --git a/gcloud/alpha/iam/workforce-pools/providers/operations/help b/gcloud/alpha/iam/workforce-pools/providers/operations/help new file mode 100644 index 000000000..5808716d2 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/operations/help @@ -0,0 +1,33 @@ +NAME + gcloud alpha iam workforce-pools providers operations - manage IAM + workforce pool provider long-running operations + +SYNOPSIS + gcloud alpha iam workforce-pools providers operations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Commands for managing IAM workforce pool provider long-running + operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a workforce pool provider operation. + +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 iam workforce-pools providers operations + + $ gcloud beta iam workforce-pools providers operations + diff --git a/gcloud/alpha/iam/workforce-pools/providers/undelete b/gcloud/alpha/iam/workforce-pools/providers/undelete new file mode 100644 index 000000000..0bfeb6db9 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/undelete @@ -0,0 +1,80 @@ +NAME + gcloud alpha iam workforce-pools providers undelete - undelete a workforce + pool provider + +SYNOPSIS + gcloud alpha iam workforce-pools providers undelete + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Undelete a workforce pool provider. + +EXAMPLES + The following command undeletes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud alpha iam workforce-pools providers undelete \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to + undelete. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers undelete + + $ gcloud beta iam workforce-pools providers undelete + diff --git a/gcloud/alpha/iam/workforce-pools/providers/update-oidc b/gcloud/alpha/iam/workforce-pools/providers/update-oidc new file mode 100644 index 000000000..a304dac20 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/providers/update-oidc @@ -0,0 +1,205 @@ +NAME + gcloud alpha iam workforce-pools providers update-oidc - update an OIDC + workforce pool provider + +SYNOPSIS + gcloud alpha iam workforce-pools providers update-oidc + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [--attribute-condition=ATTRIBUTE_CONDITION] + [--attribute-mapping=[ATTRIBUTE_MAPPING,...]] [--client-id=CLIENT_ID] + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [--issuer-uri=ISSUER_URI] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an OIDC workforce pool provider. + +EXAMPLES + The following command updates the OIDC workforce pool provider with the ID + my-workforce-pool-provider in the workforce pool my-workforce-pool. + Explicit values for all required and optional parameters are provided: + + $ gcloud alpha iam workforce-pools providers update-oidc \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" --client-id="client-id" \ + --issuer-uri="https://test-idp.com" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to update. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --client-id=CLIENT_ID + The OIDC client ID. This must match the audience claim of the JWT + issued by the identity provider. + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + + --issuer-uri=ISSUER_URI + The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools providers update-oidc + + $ gcloud beta iam workforce-pools providers update-oidc + diff --git a/gcloud/alpha/iam/workforce-pools/undelete b/gcloud/alpha/iam/workforce-pools/undelete new file mode 100644 index 000000000..252408bdc --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/undelete @@ -0,0 +1,63 @@ +NAME + gcloud alpha iam workforce-pools undelete - undelete a workforce pool + +SYNOPSIS + gcloud alpha iam workforce-pools undelete + (WORKFORCE_POOL : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Undelete a workforce pool. + +EXAMPLES + The following command undeletes a workforce pool with ID my-workforce-pool: + + $ gcloud alpha iam workforce-pools undelete my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to undelete. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools undelete + + $ gcloud beta iam workforce-pools undelete + diff --git a/gcloud/alpha/iam/workforce-pools/update b/gcloud/alpha/iam/workforce-pools/update new file mode 100644 index 000000000..925b20768 --- /dev/null +++ b/gcloud/alpha/iam/workforce-pools/update @@ -0,0 +1,88 @@ +NAME + gcloud alpha iam workforce-pools update - update a workforce pool + +SYNOPSIS + gcloud alpha iam workforce-pools update + (WORKFORCE_POOL : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [--session-duration=SESSION_DURATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a workforce pool. + +EXAMPLES + The following command updates a workforce pool with ID my-workforce-pool + with explicit values for all required and optional parameters: + + $ gcloud alpha iam workforce-pools update my-workforce-pool \ + --location=global --display-name="My Workforce Pool" \ + --description="My workforce pool description." \ + --session-duration="7200s" --disabled + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to update. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + + --description=DESCRIPTION + A description for the workforce pool. Cannot exceed 256 characters in + length. + + --disabled + Whether or not the workforce pool is disabled. You cannot use a + disabled workforce pool to perform new token exchanges or sign-ins + using any provider in the workforce pool. + + --display-name=DISPLAY_NAME + A display name for the workforce pool. Cannot exceed 32 characters in + length. + + --session-duration=SESSION_DURATION + How long the Google Cloud access tokens, console sign-in sessions, and + gcloud sign-in sessions from this workforce pool are valid. Must be + greater than 15 minutes (900s) and less than 12 hours (43200s). If not + configured, minted credentials will have a default duration of one hour + (3600s). + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +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 iam workforce-pools update + + $ gcloud beta iam workforce-pools update + diff --git a/gcloud/alpha/init b/gcloud/alpha/init index 5248b0c53..8119a305f 100644 --- a/gcloud/alpha/init +++ b/gcloud/alpha/init @@ -39,14 +39,14 @@ EXAMPLES FLAGS --no-browser - Prevent the command from launching a browser for authorization. + Prevent the command from launching a browser for authorization. Use + this flag if you are on a machine that does not have a browser but you + can install the gcloud CLI on another machine with a browser. --console-only, --no-launch-browser - (DEPRECATED) Prevent the command from launching a browser for - authorization. - - The --console-only/--no-launch-browser are deprecated and will be - removed in future updates. Use --no-browser as a replacement. + Prevent the command from launching a browser for authorization. Use + this flag if you are on a machine that does not have a browser and you + cannot install the gcloud CLI on another machine with a browser. --skip-diagnostics Do not run diagnostics. diff --git a/gcloud/alpha/iot/devices/list b/gcloud/alpha/iot/devices/list index b632f970f..48aaf0879 100644 --- a/gcloud/alpha/iot/devices/list +++ b/gcloud/alpha/iot/devices/list @@ -3,10 +3,11 @@ NAME SYNOPSIS gcloud alpha iot devices list (--registry=REGISTRY : --region=REGION) - [--device-ids=[DEVICE_IDS,...]] [--device-num-ids=[DEVICE_NUM_IDS,...]] - [--device-type=DEVICE_TYPE] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--device-field-mask=DEVICE_FIELD_MASK; + default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]] + [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) List devices. @@ -45,6 +46,12 @@ REQUIRED FLAGS ▸ provide the argument --region on the command line. FLAGS + --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig" + If given, returns all specified device fields instead of the default + set. The value is a comma-separated list of field names. Example: + "lastErrorStatus,config,metadata". See full list of device fields at: + https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices + --device-ids=[DEVICE_IDS,...] If given, show only devices with one of the provided IDs. diff --git a/gcloud/alpha/notebooks/environments/create b/gcloud/alpha/notebooks/environments/create index ba455c6f7..b29825ca6 100644 --- a/gcloud/alpha/notebooks/environments/create +++ b/gcloud/alpha/notebooks/environments/create @@ -15,7 +15,10 @@ SYNOPSIS [--post-startup-script=POST_STARTUP_SCRIPT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for creating environments. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for creating environments. EXAMPLES To create an environment with id 'example-environment' in location diff --git a/gcloud/alpha/notebooks/environments/delete b/gcloud/alpha/notebooks/environments/delete index 5e137b60d..c7278a7c8 100644 --- a/gcloud/alpha/notebooks/environments/delete +++ b/gcloud/alpha/notebooks/environments/delete @@ -7,7 +7,10 @@ SYNOPSIS (ENVIRONMENT : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for deleting environments. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for deleting environments. EXAMPLES To delete environment with id 'example-environment' in location diff --git a/gcloud/alpha/notebooks/environments/describe b/gcloud/alpha/notebooks/environments/describe index 307e9b998..8356a63fc 100644 --- a/gcloud/alpha/notebooks/environments/describe +++ b/gcloud/alpha/notebooks/environments/describe @@ -7,7 +7,10 @@ SYNOPSIS (ENVIRONMENT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for describing environments. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for describing environments. EXAMPLES To describe an environment with id 'example-environment' in location diff --git a/gcloud/alpha/notebooks/environments/help b/gcloud/alpha/notebooks/environments/help index 3d6012f76..4d141a892 100644 --- a/gcloud/alpha/notebooks/environments/help +++ b/gcloud/alpha/notebooks/environments/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud alpha notebooks environments COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Notebooks Environments Command Group. + (ALPHA) (DEPRECATED) Notebooks Environments Command Group. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,16 +18,16 @@ COMMANDS COMMAND is one of the following: create - (ALPHA) Request for creating environments. + (ALPHA) (DEPRECATED) Request for creating environments. delete - (ALPHA) Request for deleting environments. + (ALPHA) (DEPRECATED) Request for deleting environments. describe - (ALPHA) Request for describing environments. + (ALPHA) (DEPRECATED) Request for describing environments. list - (ALPHA) Request for listing environments. + (ALPHA) (DEPRECATED) Request for listing environments. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/notebooks/environments/list b/gcloud/alpha/notebooks/environments/list index 5feeecb91..ad58cb99e 100644 --- a/gcloud/alpha/notebooks/environments/list +++ b/gcloud/alpha/notebooks/environments/list @@ -7,7 +7,10 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for listing environments. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for listing environments. EXAMPLES To list environments in location 'us-central1-a', run: diff --git a/gcloud/alpha/notebooks/help b/gcloud/alpha/notebooks/help index 18406c5b8..a9df47e89 100644 --- a/gcloud/alpha/notebooks/help +++ b/gcloud/alpha/notebooks/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud alpha notebooks GROUP [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Notebooks Command Group. + (ALPHA) (DEPRECATED) Notebooks Command Group. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,13 +18,13 @@ GROUPS GROUP is one of the following: environments - (ALPHA) Notebooks Environments Command Group. + (ALPHA) (DEPRECATED) Notebooks Environments Command Group. instances - (ALPHA) Notebooks Instances command group. + (ALPHA) (DEPRECATED) Notebooks Instances command group. locations - (ALPHA) View locations available for a project. + (ALPHA) (DEPRECATED) View locations available for a project. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/notebooks/instances/add-iam-policy-binding b/gcloud/alpha/notebooks/instances/add-iam-policy-binding index 4127d97bd..acab85f35 100644 --- a/gcloud/alpha/notebooks/instances/add-iam-policy-binding +++ b/gcloud/alpha/notebooks/instances/add-iam-policy-binding @@ -8,8 +8,11 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Adds a policy binding to the IAM policy of an instance, given an - instance ID and the binding. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Adds a policy binding to the IAM policy of an instance, given an instance + ID and the binding. EXAMPLES To add an IAM policy binding for the role of roles/notebooks.admin for the diff --git a/gcloud/alpha/notebooks/instances/create b/gcloud/alpha/notebooks/instances/create index 31533433b..6f7df9a14 100644 --- a/gcloud/alpha/notebooks/instances/create +++ b/gcloud/alpha/notebooks/instances/create @@ -30,7 +30,10 @@ SYNOPSIS default="TYPE_UNSPECIFIED"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for creating notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for creating notebook instances. EXAMPLES To create an instance from an environment, run: diff --git a/gcloud/alpha/notebooks/instances/delete b/gcloud/alpha/notebooks/instances/delete index 12f1544bb..91006e3e3 100644 --- a/gcloud/alpha/notebooks/instances/delete +++ b/gcloud/alpha/notebooks/instances/delete @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for deleting notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for deleting notebook instances. EXAMPLES To delete an instance, run: diff --git a/gcloud/alpha/notebooks/instances/describe b/gcloud/alpha/notebooks/instances/describe index 41858851e..a9d16ee03 100644 --- a/gcloud/alpha/notebooks/instances/describe +++ b/gcloud/alpha/notebooks/instances/describe @@ -7,7 +7,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for describing notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for describing notebook instances. EXAMPLES To describe an instance, run: diff --git a/gcloud/alpha/notebooks/instances/diagnose b/gcloud/alpha/notebooks/instances/diagnose index bf28abf9e..7735d9252 100644 --- a/gcloud/alpha/notebooks/instances/diagnose +++ b/gcloud/alpha/notebooks/instances/diagnose @@ -8,7 +8,10 @@ SYNOPSIS [--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for diagnose notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for diagnose notebook instances. EXAMPLES To diagnose an instance, run: diff --git a/gcloud/alpha/notebooks/instances/get-iam-policy b/gcloud/alpha/notebooks/instances/get-iam-policy index f3cdc071d..010ad45c8 100644 --- a/gcloud/alpha/notebooks/instances/get-iam-policy +++ b/gcloud/alpha/notebooks/instances/get-iam-policy @@ -8,12 +8,14 @@ SYNOPSIS [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha notebooks instances get-iam-policy displays the IAM - policy associated with an instance. If formatted as JSON, the output can be - edited and used as a policy file for set-iam-policy. The output includes an - "etag" field identifying the version emitted and allowing detection of - concurrent policy updates; see $ {parent} set-iam-policy for additional - details. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + gcloud alpha notebooks instances get-iam-policy displays the IAM policy + associated with an instance. If formatted as JSON, the output can be edited + and used as a policy file for set-iam-policy. The output includes an "etag" + field identifying the version emitted and allowing detection of concurrent + policy updates; see $ {parent} set-iam-policy for additional details. EXAMPLES To print the IAM policy for a given folder, run: diff --git a/gcloud/alpha/notebooks/instances/help b/gcloud/alpha/notebooks/instances/help index 374e277dd..8aa6e7a14 100644 --- a/gcloud/alpha/notebooks/instances/help +++ b/gcloud/alpha/notebooks/instances/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud alpha notebooks instances COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Notebooks Instances command group. + (ALPHA) (DEPRECATED) Notebooks Instances command group. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,52 +18,53 @@ COMMANDS COMMAND is one of the following: add-iam-policy-binding - (ALPHA) Add IAM policy binding for an instance. + (ALPHA) (DEPRECATED) Add IAM policy binding for an instance. create - (ALPHA) Request for creating an instance. + (ALPHA) (DEPRECATED) Request for creating an instance. delete - (ALPHA) Request for deleting instances. + (ALPHA) (DEPRECATED) Request for deleting instances. describe - (ALPHA) Request for describing instances. + (ALPHA) (DEPRECATED) Request for describing instances. diagnose - (ALPHA) Request for diagnose instances. + (ALPHA) (DEPRECATED) Request for diagnose instances. get-iam-policy - (ALPHA) Get IAM policy for an instance. + (ALPHA) (DEPRECATED) Get IAM policy for an instance. is-upgradeable - (ALPHA) Request for checking if a notebook instance is upgradeable. + (ALPHA) (DEPRECATED) Request for checking if a notebook instance is + upgradeable. list - (ALPHA) Request for listing instances. + (ALPHA) (DEPRECATED) Request for listing instances. register - (ALPHA) Request for registering instances. + (ALPHA) (DEPRECATED) Request for registering instances. remove-iam-policy-binding - (ALPHA) Remove IAM policy binding for an instance. + (ALPHA) (DEPRECATED) Remove IAM policy binding for an instance. reset - (ALPHA) Request for resetting instances. + (ALPHA) (DEPRECATED) Request for resetting instances. set-iam-policy - (ALPHA) Set the IAM policy for an Instance. + (ALPHA) (DEPRECATED) Set the IAM policy for an Instance. start - (ALPHA) Request for starting instances. + (ALPHA) (DEPRECATED) Request for starting instances. stop - (ALPHA) Request for stopping instances. + (ALPHA) (DEPRECATED) Request for stopping instances. update - (ALPHA) Request for updating instances. + (ALPHA) (DEPRECATED) Request for updating instances. upgrade - (ALPHA) Request for upgrading instances. + (ALPHA) (DEPRECATED) Request for upgrading instances. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/notebooks/instances/is-upgradeable b/gcloud/alpha/notebooks/instances/is-upgradeable index a85f22ede..c371100b2 100644 --- a/gcloud/alpha/notebooks/instances/is-upgradeable +++ b/gcloud/alpha/notebooks/instances/is-upgradeable @@ -7,7 +7,10 @@ SYNOPSIS (INSTANCE : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for checking if a notebook instance is upgradeable. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for checking if a notebook instance is upgradeable. EXAMPLES To check if an instance can be upgraded, run: diff --git a/gcloud/alpha/notebooks/instances/list b/gcloud/alpha/notebooks/instances/list index 5e986a04b..95e26ad5f 100644 --- a/gcloud/alpha/notebooks/instances/list +++ b/gcloud/alpha/notebooks/instances/list @@ -7,7 +7,10 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for listing instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for listing instances. EXAMPLES To list instances in a particular location, run: diff --git a/gcloud/alpha/notebooks/instances/register b/gcloud/alpha/notebooks/instances/register index 6d59fabc9..a02f0b535 100644 --- a/gcloud/alpha/notebooks/instances/register +++ b/gcloud/alpha/notebooks/instances/register @@ -7,7 +7,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for registering notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for registering notebook instances. EXAMPLES To register an old type instance, run: diff --git a/gcloud/alpha/notebooks/instances/remove-iam-policy-binding b/gcloud/alpha/notebooks/instances/remove-iam-policy-binding index a1b9727f9..4e6985c70 100644 --- a/gcloud/alpha/notebooks/instances/remove-iam-policy-binding +++ b/gcloud/alpha/notebooks/instances/remove-iam-policy-binding @@ -8,7 +8,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Removes a policy binding to the IAM policy of an instance, given an + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Removes a policy binding to the IAM policy of an instance, given an instance ID and the binding. EXAMPLES diff --git a/gcloud/alpha/notebooks/instances/reset b/gcloud/alpha/notebooks/instances/reset index fce944bce..db88209cd 100644 --- a/gcloud/alpha/notebooks/instances/reset +++ b/gcloud/alpha/notebooks/instances/reset @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for reseting notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for reseting notebook instances. EXAMPLES To reset an instance, run: diff --git a/gcloud/alpha/notebooks/instances/set-iam-policy b/gcloud/alpha/notebooks/instances/set-iam-policy index 3c0412aef..6e6b14e75 100644 --- a/gcloud/alpha/notebooks/instances/set-iam-policy +++ b/gcloud/alpha/notebooks/instances/set-iam-policy @@ -7,8 +7,11 @@ SYNOPSIS (INSTANCE : --location=LOCATION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha notebooks instances set-iam-policy sets the IAM policy - for a Notebook instance given an instance ID and a JSON or YAML file that + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + gcloud alpha notebooks instances set-iam-policy sets the IAM policy for a + Notebook instance given an instance ID and a JSON or YAML file that describes the IAM policy. Note: Setting the IAM policy for an Instance replaces existing IAM bindings diff --git a/gcloud/alpha/notebooks/instances/start b/gcloud/alpha/notebooks/instances/start index 7827bfb25..7bd43147d 100644 --- a/gcloud/alpha/notebooks/instances/start +++ b/gcloud/alpha/notebooks/instances/start @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for starting notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for starting notebook instances. EXAMPLES To start an instance, run: diff --git a/gcloud/alpha/notebooks/instances/stop b/gcloud/alpha/notebooks/instances/stop index 07b5f2dbf..3bad90abc 100644 --- a/gcloud/alpha/notebooks/instances/stop +++ b/gcloud/alpha/notebooks/instances/stop @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for stopping notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for stopping notebook instances. EXAMPLES To stop an instance, run: diff --git a/gcloud/alpha/notebooks/instances/update b/gcloud/alpha/notebooks/instances/update index 6fe252699..45d9ae02c 100644 --- a/gcloud/alpha/notebooks/instances/update +++ b/gcloud/alpha/notebooks/instances/update @@ -9,7 +9,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for updating notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for updating notebook instances. EXAMPLES To update machine type for an instance, run: diff --git a/gcloud/alpha/notebooks/instances/upgrade b/gcloud/alpha/notebooks/instances/upgrade index dcdd2d797..4d500d169 100644 --- a/gcloud/alpha/notebooks/instances/upgrade +++ b/gcloud/alpha/notebooks/instances/upgrade @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for upgrading notebook instances. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for upgrading notebook instances. EXAMPLES To upgrade an instance, run: diff --git a/gcloud/alpha/notebooks/locations/help b/gcloud/alpha/notebooks/locations/help index 7012b7eed..f53ed5526 100644 --- a/gcloud/alpha/notebooks/locations/help +++ b/gcloud/alpha/notebooks/locations/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud alpha notebooks locations COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) View locations available for a project. + (ALPHA) (DEPRECATED) View locations available for a project. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,7 +18,7 @@ COMMANDS COMMAND is one of the following: list - (ALPHA) Request for listing locations. + (ALPHA) (DEPRECATED) Request for listing locations. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/notebooks/locations/list b/gcloud/alpha/notebooks/locations/list index aa40b2e4c..f9bc975cf 100644 --- a/gcloud/alpha/notebooks/locations/list +++ b/gcloud/alpha/notebooks/locations/list @@ -7,7 +7,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Request for listing locations. + (ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud + notebooks instead. + + Request for listing locations. EXAMPLES To list locations, run: $ gcloud alpha notebooks locations list diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index 726d3eed0..69c11d9b5 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -357,7 +357,7 @@ FLAGS details. The location can be a directory on a local disk or a gzipped archive file (.tar.gz) in Google Cloud Storage. If the source is a local directory, this command skips the files specified in the - --ignore-file. If --ignore-file is not specified, use.gcloudignore + --ignore-file. If --ignore-file is not specified, use .gcloudignore file. If a .gcloudignore file is absent and a .gitignore file is present in the local source directory, gcloud will use a generated Git-compatible .gcloudignore file that respects your .gitignored diff --git a/gcloud/alpha/run/jobs/create b/gcloud/alpha/run/jobs/create index 0d712fbd2..8b3bbc01c 100644 --- a/gcloud/alpha/run/jobs/create +++ b/gcloud/alpha/run/jobs/create @@ -17,7 +17,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Deploys a new job to Google Cloud Run. + (ALPHA) Creates a new Cloud Run job. EXAMPLES To deploy a new job my-data-transformation on Cloud Run: diff --git a/gcloud/alpha/run/jobs/deploy b/gcloud/alpha/run/jobs/deploy index 0c3059c2c..cf007ef7c 100644 --- a/gcloud/alpha/run/jobs/deploy +++ b/gcloud/alpha/run/jobs/deploy @@ -204,7 +204,7 @@ FLAGS details. The location can be a directory on a local disk or a gzipped archive file (.tar.gz) in Google Cloud Storage. If the source is a local directory, this command skips the files specified in the - --ignore-file. If --ignore-file is not specified, use.gcloudignore + --ignore-file. If --ignore-file is not specified, use .gcloudignore file. If a .gcloudignore file is absent and a .gitignore file is present in the local source directory, gcloud will use a generated Git-compatible .gcloudignore file that respects your .gitignored @@ -223,5 +223,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run jobs deploy diff --git a/gcloud/alpha/run/jobs/help b/gcloud/alpha/run/jobs/help index 01c5dd518..a6ffbd4a3 100644 --- a/gcloud/alpha/run/jobs/help +++ b/gcloud/alpha/run/jobs/help @@ -64,7 +64,7 @@ COMMANDS (ALPHA) Remove IAM policy binding of a Cloud Run job. replace - (ALPHA) Creates or replaces a job from a YAML Job specification. + (ALPHA) Create or replace a job from a YAML job specification. set-iam-policy (ALPHA) Set the IAM policy for a job. diff --git a/gcloud/alpha/run/jobs/replace b/gcloud/alpha/run/jobs/replace index e889c961c..29ab60a79 100644 --- a/gcloud/alpha/run/jobs/replace +++ b/gcloud/alpha/run/jobs/replace @@ -1,5 +1,5 @@ NAME - gcloud alpha run jobs replace - creates or replaces a job from a YAML Job + gcloud alpha run jobs replace - create or replace a job from a YAML job specification SYNOPSIS @@ -7,10 +7,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Creates or replaces a job from a YAML Job specification. + (ALPHA) Creates or replaces a job from a YAML job specification. EXAMPLES - To replace the specification for myjob + To replace the specification for a job defined in myjob.yaml $ gcloud alpha run jobs replace myjob.yaml diff --git a/gcloud/alpha/run/services/help b/gcloud/alpha/run/services/help index 9037aaedd..da34220f5 100644 --- a/gcloud/alpha/run/services/help +++ b/gcloud/alpha/run/services/help @@ -132,8 +132,7 @@ COMMANDS (ALPHA) Remove IAM policy binding of a Cloud Run service. replace - (ALPHA) Creates or replaces a service from a YAML Service - specification. + (ALPHA) Create or replace a service from a YAML service specification. set-iam-policy (ALPHA) Set the IAM policy for a service. diff --git a/gcloud/alpha/run/services/replace b/gcloud/alpha/run/services/replace index a10f0399e..4606e4c99 100644 --- a/gcloud/alpha/run/services/replace +++ b/gcloud/alpha/run/services/replace @@ -1,6 +1,6 @@ NAME - gcloud alpha run services replace - creates or replaces a service from a - YAML Service specification + gcloud alpha run services replace - create or replace a service from a YAML + service specification SYNOPSIS gcloud alpha run services replace FILE [--async] [--namespace=NAMESPACE] @@ -10,10 +10,10 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Creates or replaces a service from a YAML Service specification. + (ALPHA) Creates or replaces a service from a YAML service specification. EXAMPLES - To replace the specification for myservice + To replace the specification for a service defined in myservice.yaml $ gcloud alpha run services replace myservice.yaml diff --git a/gcloud/alpha/scc/custom-modules/help b/gcloud/alpha/scc/custom-modules/help new file mode 100644 index 000000000..9acafa55a --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/help @@ -0,0 +1,26 @@ +NAME + gcloud alpha scc custom-modules - manage custom modules + +SYNOPSIS + gcloud alpha scc custom-modules GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + sha + (ALPHA) Manage custom modules. + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/create b/gcloud/alpha/scc/custom-modules/sha/create new file mode 100644 index 000000000..c24b41449 --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/create @@ -0,0 +1,112 @@ +NAME + gcloud alpha scc custom-modules sha create - create a Security Health + Analytics custom module + +SYNOPSIS + gcloud alpha scc custom-modules sha create + --custom-config-from-file=CUSTOM_CONFIG_FROM_FILE + --display-name=DISPLAY_NAME --enablement-state=ENABLEMENT_STATE + [--description=DESCRIPTION] + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Security Health Analytics custom module. + +EXAMPLES + To create a Security Health Analytics custom module for given organization + 123, run: + + $ gcloud alpha scc custom-modules sha create \ + --organization=organizations/123 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha create --organization=123 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + + To create a Security Health Analytics custom module for given folder 456, + run: + + $ gcloud alpha scc custom-modules sha create --folder=folders/456 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha create --folder=456 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + + To create a Security Health Analytics custom module for given project 789, + run: + + $ gcloud alpha scc custom-modules sha create \ + --project=projects/789 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + + $ gcloud alpha scc custom-modules sha create --project=789 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + +REQUIRED FLAGS + --custom-config-from-file=CUSTOM_CONFIG_FROM_FILE + Path to a yaml file containing the custom configuration for the + Security Health Analytics custom module. + + --display-name=DISPLAY_NAME + The text that will be used to represent a Security Health Analytics + custom module display name. Display name must be at most 64 characters + + --enablement-state=ENABLEMENT_STATE + The enablement state of the Security Health Analytics custom module. + ENABLEMENT_STATE must be one of: disabled, enabled, + enablement-state-unspecified, inherited. + +OPTIONAL FLAGS + --description=DESCRIPTION + The text that will be used to describe a Security Health Analytics + custom module. Description must be at most 1024 characters + + At most one of these can be specified: + + --folder=FOLDER + Folder where the Security Health Analytics custom module resides. + Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Security Health Analytics custom module + resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Security Health Analytics custom + module resides. Formatted as projects/789 or just 789. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/delete b/gcloud/alpha/scc/custom-modules/sha/delete new file mode 100644 index 000000000..ee93f0875 --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/delete @@ -0,0 +1,81 @@ +NAME + gcloud alpha scc custom-modules sha delete - delete a Security Health + Analytics custom module + +SYNOPSIS + gcloud alpha scc custom-modules sha delete CUSTOM_MODULE + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Security Health Analytics custom module. + +EXAMPLES + To delete a Security Health Analytics custom module with id 123456 for + organization 123, run: + + $ gcloud alpha scc custom-modules sha delete 123456 \ + --organization=organizations/123 + $ gcloud alpha scc custom-modules sha delete 123456 \ + --organization=123 + $ gcloud alpha scc custom-modules sha delete \ + organizations/123/securityHealthAnalyticsSettings/\ + customModules/123456 + + To delete a Security Health Analytics custom module with id 123456 for + folder 456 , run: + + $ gcloud alpha scc custom-modules sha delete 123456 \ + --folder=folders/456 + $ gcloud alpha scc custom-modules sha delete 123456 --folder=456 + $ gcloud alpha scc custom-modules sha delete \ + folders/456/securityHealthAnalyticsSettings/customModules/123456 + + To delete a Security Health Analytics custom module with id 123456 for + project 789, run: + + $ gcloud alpha scc custom-modules sha delete 123456 \ + --project=projects/789 + $ gcloud alpha scc custom-modules sha delete 123456 --project=789 + $ gcloud alpha scc custom-modules sha delete \ + projects/789/securityHealthAnalyticsSettings/customModules/\ + 123456 + +POSITIONAL ARGUMENTS + CUSTOM_MODULE + Id or the full resource name of the Security Health Analytics custom + module. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER + Folder where the Security Health Analytics custom module resides. + Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Security Health Analytics custom module + resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Security Health Analytics custom + module resides. Formatted as projects/789 or just 789. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/get b/gcloud/alpha/scc/custom-modules/sha/get new file mode 100644 index 000000000..6bfaa9a12 --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/get @@ -0,0 +1,79 @@ +NAME + gcloud alpha scc custom-modules sha get - get a Security Health Analytics + custom module + +SYNOPSIS + gcloud alpha scc custom-modules sha get CUSTOM_MODULE + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get a Security Health Analytics custom module. + +EXAMPLES + To get a Security Health Analytics custom module with id 123456 for + organization 123 , run: + + $ gcloud alpha scc custom-modules sha get 123456 \ + --organization=organizations/123 + $ gcloud alpha scc custom-modules sha get 123456 --organization=123 + $ gcloud alpha scc custom-modules sha get \ + organizations/123/securityHealthAnalyticsSettings/\ + customModules/123456 + + To get a Security Health Analytics custom module with id 123456 for folder + 456, run: + + $ gcloud alpha scc custom-modules sha get 123456 --folder=folders/456 + $ gcloud alpha scc custom-modules sha get 123456 --folder=456 + $ gcloud alpha scc custom-modules sha get \ + folders/456/securityHealthAnalyticsSettings/customModules/123456 + + To get a Security Health Analytics custom module with id 123456 for project + 789, run: + + $ gcloud alpha scc custom-modules sha get 123456 \ + --project=projects/789 + $ gcloud alpha scc custom-modules sha get 123456 --project=789 + $ gcloud alpha scc custom-modules sha get \ + projects/789/securityHealthAnalyticsSettings/customModules/\ + 123456 + +POSITIONAL ARGUMENTS + CUSTOM_MODULE + Id or the full resource name of the Security Health Analytics custom + module. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER + Folder where the Security Health Analytics custom module resides. + Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Security Health Analytics custom module + resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Security Health Analytics custom + module resides. Formatted as projects/789 or just 789. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/get-effective b/gcloud/alpha/scc/custom-modules/sha/get-effective new file mode 100644 index 000000000..be4b2b0a5 --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/get-effective @@ -0,0 +1,84 @@ +NAME + gcloud alpha scc custom-modules sha get-effective - get an effective + Security Health Analytics custom module + +SYNOPSIS + gcloud alpha scc custom-modules sha get-effective CUSTOM_MODULE + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get an effective Security Health Analytics custom module. + +EXAMPLES + To get an effective Security Health Analytics custom module with id 123456 + for organization 123 , run: + + $ gcloud alpha scc custom-modules sha get-effective 123456 \ + --organization=organizations/123 + $ gcloud alpha scc custom-modules sha get-effective 123456 \ + --organization=123 + $ gcloud alpha scc custom-modules sha get-effective \ + organizations/123/securityHealthAnalyticsSettings/\ + effectiveCustomModules/123456 + + To get an effective Security Health Analytics custom module with id 123456 + for folder 456, run: + + $ gcloud alpha scc custom-modules sha get-effective 123456 \ + --folder=folders/456 + $ gcloud alpha scc custom-modules sha get-effective 123456 \ + --folder=456 + $ gcloud alpha scc custom-modules sha get-effective \ + folders/456/securityHealthAnalyticsSettings/\ + effectiveCustomModules/123456 + + To get an effective Security Health Analytics custom module with id 123456 + for project 789, run: + + $ gcloud alpha scc custom-modules sha get-effective 123456 \ + --project=projects/789 + $ gcloud alpha scc custom-modules sha get-effective 123456 \ + --project=789 + $ gcloud alpha scc custom-modules sha get-effective \ + projects/789/securityHealthAnalyticsSettings/\ + effectiveCustomModules/123456 + +POSITIONAL ARGUMENTS + CUSTOM_MODULE + Id or the full resource name of the effective Security Health Analytics + custom module. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER + Folder where the effective Security Health Analytics custom module + resides. Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the effective Security Health Analytics custom + module resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the effective Security Health Analytics + custom module resides. Formatted as projects/789 or just 789. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/help b/gcloud/alpha/scc/custom-modules/sha/help new file mode 100644 index 000000000..fdf2eb28e --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/help @@ -0,0 +1,50 @@ +NAME + gcloud alpha scc custom-modules sha - manage custom modules + +SYNOPSIS + gcloud alpha scc custom-modules sha COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage custom modules. + +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 a Security Health Analytics custom module. + + delete + (ALPHA) Delete a Security Health Analytics custom module. + + get + (ALPHA) Get a Security Health Analytics custom module. + + get-effective + (ALPHA) Get an effective Security Health Analytics custom module. + + list + (ALPHA) List Security Health Analytics custom modules. + + list-descendant + (ALPHA) List Descendant Security Health Analytics custom modules. + + list-effective + (ALPHA) List Effective Security Health Analytics custom modules. + + test + (ALPHA) Test a Security Health Analytics custom module. + + update + (ALPHA) Update a Security Health Analytics custom module. + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/list b/gcloud/alpha/scc/custom-modules/sha/list new file mode 100644 index 000000000..8d4da2478 --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/list @@ -0,0 +1,89 @@ +NAME + gcloud alpha scc custom-modules sha list - list Security Health Analytics + custom modules + +SYNOPSIS + gcloud alpha scc custom-modules sha list + (--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Security Health Analytics custom modules. + +EXAMPLES + List Security Health Analytics custom modules under organization 123: + + $ gcloud alpha scc custom-modules sha list \ + --organization=organizations/123 + $ gcloud alpha scc custom-modules sha list --organization=123 + + List Security Health Analytics custom modules under folder 456: + + $ gcloud alpha scc custom-modules sha list --folder=folders/456 + $ gcloud alpha scc custom-modules sha list --folder=456 + + List Security Health Analytics custom modules under project 789: + + $ gcloud alpha scc custom-modules sha list --project=projects/789 + $ gcloud alpha scc custom-modules sha list --project=789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER + Folder where the Security Health Analytics custom modules resides. + Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Security Health Analytics custom modules + resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Security Health Analytics custom + modules resides. Formatted as projects/789 or just 789. + +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. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/list-descendant b/gcloud/alpha/scc/custom-modules/sha/list-descendant new file mode 100644 index 000000000..0d5659f8f --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/list-descendant @@ -0,0 +1,93 @@ +NAME + gcloud alpha scc custom-modules sha list-descendant - list Descendant + Security Health Analytics custom modules + +SYNOPSIS + gcloud alpha scc custom-modules sha list-descendant + (--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Descendant Security Health Analytics custom modules. + +EXAMPLES + List Descendant Security Health Analytics custom modules under organization + 123: + + $ gcloud alpha scc custom-modules sha list-descendant \ + --organization=organizations/123 + $ gcloud alpha scc custom-modules sha list-descendant \ + --organization=123 + + List Descendant Security Health Analytics custom modules under folder 456: + + $ gcloud alpha scc custom-modules sha list-descendant \ + --folder=folders/456 + $ gcloud alpha scc custom-modules sha list-descendant --folder=456 + + List Descendant Security Health Analytics custom modules under project 789: + + $ gcloud alpha scc custom-modules sha list-descendant \ + --project=projects/789 + $ gcloud alpha scc custom-modules sha list-descendant --project=789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER + Folder where the Descendant Security Health Analytics custom modules + resides. Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Descendant Security Health Analytics custom + modules resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Descendant Security Health Analytics + custom modules resides. Formatted as projects/789 or just 789. + +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. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/list-effective b/gcloud/alpha/scc/custom-modules/sha/list-effective new file mode 100644 index 000000000..212cfe91d --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/list-effective @@ -0,0 +1,93 @@ +NAME + gcloud alpha scc custom-modules sha list-effective - list Effective + Security Health Analytics custom modules + +SYNOPSIS + gcloud alpha scc custom-modules sha list-effective + (--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Effective Security Health Analytics custom modules. + +EXAMPLES + List Effective Security Health Analytics custom modules under organization + 123: + + $ gcloud alpha scc custom-modules sha list-effective \ + --organization=organizations/123 + $ gcloud alpha scc custom-modules sha list-effective \ + --organization=123 + + List Effective Security Health Analytics custom modules under folder 456: + + $ gcloud alpha scc custom-modules sha list-effective \ + --folder=folders/456 + $ gcloud alpha scc custom-modules sha list-effective --folder=456 + + List Effective Security Health Analytics custom modules under project 789: + + $ gcloud alpha scc custom-modules sha list-effective \ + --project=projects/789 + $ gcloud alpha scc custom-modules sha list-effective --project=789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER + Folder where the Effective Security Health Analytics custom modules + resides. Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Effective Security Health Analytics custom + modules resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Effective Security Health Analytics + custom modules resides. Formatted as projects/789 or just 789. + +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. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/test b/gcloud/alpha/scc/custom-modules/sha/test new file mode 100644 index 000000000..af89ae799 --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/test @@ -0,0 +1,141 @@ +NAME + gcloud alpha scc custom-modules sha test - test a Security Health Analytics + custom module + +SYNOPSIS + gcloud alpha scc custom-modules sha test CUSTOM_MODULE + --test-data-from-file=TEST_DATA_FROM_FILE + [--custom-config-from-file=CUSTOM_CONFIG_FROM_FILE] + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--enablement-state=ENABLEMENT_STATE] + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Test a Security Health Analytics custom module. + +EXAMPLES + To test a Security Health Analytics custom module with id 123456 for + organization 123, run: + + $ gcloud alpha scc custom-modules sha test 123456 \ + --organization=organizations/123 \ + --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + $ gcloud alpha scc custom-modules sha test 123456 \ + --organization=123 \ + --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + $ gcloud alpha scc custom-modules sha test \ + organizations/123/securityHealthAnalyticsSettings/\ + customModules/123456 --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + + To test a Security Health Analytics custom module with id 123456 for folder + 456, run: + + $ gcloud alpha scc custom-modules sha test 123456 \ + --folder=folders/456 \ + --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + $ gcloud alpha scc custom-modules sha test 123456 --folder=456 \ + --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + $ gcloud alpha scc custom-modules sha test \ + folders/456/securityHealthAnalyticsSettings/customModules/\ + 123456 --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + + To test a Security Health Analytics custom module with id 123456 for + project 789, run: + + $ gcloud alpha scc custom-modules sha test 123456 \ + --project=projects/789 \ + --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + $ gcloud alpha scc custom-modules sha test 123456 --project=789 \ + --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + $ gcloud alpha scc custom-modules sha test \ + projects/789/securityHealthAnalyticsSettings/customModules/\ + 123456 --description="This is a test custom module" \ + --display-name="Test display name"--enablement-state="ENABLED" \ + --custom-config-from-file=/tmp/custom_config.yaml \ + --test-data-from-file=/tmp/test_data.yaml + +POSITIONAL ARGUMENTS + CUSTOM_MODULE + Id or the full resource name of the Security Health Analytics custom + module. + +REQUIRED FLAGS + --test-data-from-file=TEST_DATA_FROM_FILE + Path to a yaml file containing the resource data to test the Security + Health Analytics custom module against. + +OPTIONAL FLAGS + --custom-config-from-file=CUSTOM_CONFIG_FROM_FILE + Path to a yaml file containing the custom configuration for the + Security Health Analytics custom module. + + --description=DESCRIPTION + The text that will be used to describe a Security Health Analytics + custom module. Description must be at most 1024 characters. + + --display-name=DISPLAY_NAME + The text that will be used to represent a Security Health Analytics + custom module display name. Display name must be at most 64 characters. + + --enablement-state=ENABLEMENT_STATE + The enablement state of the Security Health Analytics custom module. + ENABLEMENT_STATE must be one of: disabled, enabled, + enablement-state-unspecified, inherited. + + At most one of these can be specified: + + --folder=FOLDER + Folder where the Security Health Analytics custom module resides. + Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Security Health Analytics custom module + resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Security Health Analytics custom + module resides. Formatted as projects/789 or just 789. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/custom-modules/sha/update b/gcloud/alpha/scc/custom-modules/sha/update new file mode 100644 index 000000000..3702b38dd --- /dev/null +++ b/gcloud/alpha/scc/custom-modules/sha/update @@ -0,0 +1,140 @@ +NAME + gcloud alpha scc custom-modules sha update - update a Security Health + Analytics custom module + +SYNOPSIS + gcloud alpha scc custom-modules sha update CUSTOM_MODULE + [--custom-config-from-file=CUSTOM_CONFIG_FROM_FILE] + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--enablement-state=ENABLEMENT_STATE] [--update-mask=UPDATE_MASK] + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Security Health Analytics custom module. + +EXAMPLES + Update a Security Health Analytics custom module with id 123456 for + organization 123: + + $ gcloud alpha scc custom-modules sha update 123456 \ + --organization=organizations/123 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha update 123456 \ + --organization=123 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha update \ + organizations/123/securityHealthAnalyticsSettings/\ + customModules/123456 --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + + Update a Security Health Analytics custom module with id 123456 for folder + 456: + + $ gcloud alpha scc custom-modules sha update 123456 \ + --folder=folders/456 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha update 123456 --folder=456 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha update \ + folders/456/securityHealthAnalyticsSettings/customModules/\ + 123456 --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + + Update a Security Health Analytics custom module with id 123456 for project + 789: + + $ gcloud alpha scc custom-modules sha update 123456 \ + --project=projects/789 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha update 123456 --project=789 \ + --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + $ gcloud alpha scc custom-modules sha update \ + projects/789/securityHealthAnalyticsSettings/customModules/\ + 123456 --description="This is a test custom module" \ + --display-name="Test display name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + +POSITIONAL ARGUMENTS + CUSTOM_MODULE + Id or the full resource name of the Security Health Analytics custom + module. + +FLAGS + --custom-config-from-file=CUSTOM_CONFIG_FROM_FILE + Path to a yaml file containing the custom configuration for the + Security Health Analytics custom module. + + --description=DESCRIPTION + The text that will be used to describe a Security Health Analytics + custom module. Description must be at most 1024 characters + + --display-name=DISPLAY_NAME + The text that will be used to represent a Security Health Analytics + custom module display name. Display name must be at most 64 characters + + --enablement-state=ENABLEMENT_STATE + The enablement state of the Security Health Analytics custom module. + ENABLEMENT_STATE must be one of: disabled, enabled, + enablement-state-unspecified, inherited. + + --update-mask=UPDATE_MASK + Optional: If left unspecified (default), an update-mask is + automatically created using the flags specified in the command and only + those values are updated. + + At most one of these can be specified: + + --folder=FOLDER + Folder where the Security Health Analytics custom module resides. + Formatted as folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the Security Health Analytics custom module + resides. Formatted as organizations/123 or just 123. + + --project=PROJECT + Project (id or number) where the Security Health Analytics custom + module resides. Formatted as projects/789 or just 789. + +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 securitycenter/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/security-command-center + +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. + diff --git a/gcloud/alpha/scc/help b/gcloud/alpha/scc/help index b6531f79f..a3ac1f2aa 100644 --- a/gcloud/alpha/scc/help +++ b/gcloud/alpha/scc/help @@ -19,6 +19,9 @@ GROUPS assets (ALPHA) Manage Cloud SCC (Security Command Center) assets. + custom-modules + (ALPHA) Manage custom modules. + findings (ALPHA) Manage Cloud SCC (Security Command Center) findings. diff --git a/gcloud/auth/application-default/set-quota-project b/gcloud/auth/application-default/set-quota-project index 32c64a9fb..c493a4a51 100644 --- a/gcloud/auth/application-default/set-quota-project +++ b/gcloud/auth/application-default/set-quota-project @@ -7,11 +7,14 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION + A quota project is a Google Cloud Project that will be used for billing and + quota limits. + Before running this command, an ADC must already be generated using $ - gcloud auth application-default login. The quota project can be used by - client libraries for the billing purpose. The existing application default - credentials must have the serviceusage.services.use permission on the given - project. + gcloud auth application-default login. The quota project defined in the ADC + will be used by the Google client libraries. The existing application + default credentials must have the serviceusage.services.use permission on + the given project. EXAMPLES To update the quota project in application default credentials to diff --git a/gcloud/beta/auth/application-default/set-quota-project b/gcloud/beta/auth/application-default/set-quota-project index 2ec996cd2..4bdb463ca 100644 --- a/gcloud/beta/auth/application-default/set-quota-project +++ b/gcloud/beta/auth/application-default/set-quota-project @@ -7,11 +7,14 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Before running this command, an ADC must already be generated using - $ gcloud auth application-default login. The quota project can be used by - client libraries for the billing purpose. The existing application default - credentials must have the serviceusage.services.use permission on the given - project. + (BETA) A quota project is a Google Cloud Project that will be used for + billing and quota limits. + + Before running this command, an ADC must already be generated using $ + gcloud auth application-default login. The quota project defined in the ADC + will be used by the Google client libraries. The existing application + default credentials must have the serviceusage.services.use permission on + the given project. EXAMPLES To update the quota project in application default credentials to diff --git a/gcloud/beta/compute/commitments/create b/gcloud/beta/compute/commitments/create index 2bb00c92e..7e935642f 100644 --- a/gcloud/beta/compute/commitments/create +++ b/gcloud/beta/compute/commitments/create @@ -98,9 +98,10 @@ OPTIONAL FLAGS --type=TYPE; default="general-purpose" Type of commitment. memory-optimized indicates that the commitment is for memory-optimized VMs. TYPE must be one of: accelerator-optimized, - compute-optimized, compute-optimized-c2d, general-purpose, - general-purpose-e2, general-purpose-n2, general-purpose-n2d, - general-purpose-t2d, memory-optimized, memory-optimized-m3. + compute-optimized, compute-optimized-c2d, compute-optimized-c3, + general-purpose, general-purpose-e2, general-purpose-n2, + general-purpose-n2d, general-purpose-t2d, memory-optimized, + memory-optimized-m3. Manage the reservations to be created with the commitment. diff --git a/gcloud/beta/compute/help b/gcloud/beta/compute/help index 34e25083f..b87f78f09 100644 --- a/gcloud/beta/compute/help +++ b/gcloud/beta/compute/help @@ -93,6 +93,9 @@ GROUPS machine-types (BETA) Read Compute Engine virtual machine types. + network-attachments + (BETA) Manage Compute Engine network attachment resources. + network-edge-security-services (BETA) Read and manipulate network edge security services. diff --git a/gcloud/beta/compute/instance-groups/managed/set-autoscaling b/gcloud/beta/compute/instance-groups/managed/set-autoscaling index d95b2d536..4e358f3d2 100644 --- a/gcloud/beta/compute/instance-groups/managed/set-autoscaling +++ b/gcloud/beta/compute/instance-groups/managed/set-autoscaling @@ -238,8 +238,14 @@ FLAGS autoscaler scales the group to have at least as many VMs as defined by the minimum required instances. After the configured duration, if there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after the + scaling schedule ends. --schedule-min-required-replicas=MIN_REQUIRED_REPLICAS How many VMs the autoscaler should provision for the duration of this diff --git a/gcloud/beta/compute/instance-groups/managed/set-instance-template b/gcloud/beta/compute/instance-groups/managed/set-instance-template index d0b60a723..3f8608671 100644 --- a/gcloud/beta/compute/instance-groups/managed/set-instance-template +++ b/gcloud/beta/compute/instance-groups/managed/set-instance-template @@ -22,6 +22,15 @@ DESCRIPTION ▪ Use the rolling-action start-update command. ▪ Use the API to set the group's updatePolicy.type to PROACTIVE. +EXAMPLES + Running: + + gcloud beta compute instance-groups managed set-instance-template \ + example-managed-instance-group --template=example-global-instance-template + + Sets the group's instance template to a global instance template resource: + 'example-global-instance-template'. + POSITIONAL ARGUMENTS NAME Name of the managed instance group to operate on. diff --git a/gcloud/beta/compute/instance-groups/managed/update-autoscaling b/gcloud/beta/compute/instance-groups/managed/update-autoscaling index 6c77fee0f..ed4169643 100644 --- a/gcloud/beta/compute/instance-groups/managed/update-autoscaling +++ b/gcloud/beta/compute/instance-groups/managed/update-autoscaling @@ -137,10 +137,14 @@ FLAGS scaling schedule that is currently active the disabled scaling schedule stops being effective immediately after it moves into DISABLED state. If there is no need to maintain capacity, the - autoscaler starts removing instances after a 10-minute stabilization - period and (if configured) following scale-in controls. This ensures - you don't accidentally lose capacity immediately after the scaling - schedule ends. + autoscaler starts removing instances after the usual stabilization + period and after scale-in controls (if configured). For more + information, see Delays in scaling in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after + the scaling schedule ends. --enable-schedule=SCHEDULE_NAME Name of the scaling schedule to be enabled. @@ -157,9 +161,14 @@ FLAGS scaling schedule that is currently active, the deleted scaling schedule stops being effective immediately after it is deleted. If there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. This ensures you don't accidentally lose - capacity immediately after the scaling schedule ends. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after + the scaling schedule ends. --set-schedule=SCHEDULE_NAME A unique name for the scaling schedule to be configured. @@ -212,8 +221,14 @@ FLAGS autoscaler scales the group to have at least as many VMs as defined by the minimum required instances. After the configured duration, if there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after the + scaling schedule ends. --schedule-min-required-replicas=MIN_REQUIRED_REPLICAS How many VMs the autoscaler should provision for the duration of this diff --git a/gcloud/beta/compute/instance-templates/create b/gcloud/beta/compute/instance-templates/create index f02dbf2c7..38580482e 100644 --- a/gcloud/beta/compute/instance-templates/create +++ b/gcloud/beta/compute/instance-templates/create @@ -613,10 +613,6 @@ FLAGS The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/beta/compute/instance-templates/create-with-container b/gcloud/beta/compute/instance-templates/create-with-container index 253130b78..8b15b45af 100644 --- a/gcloud/beta/compute/instance-templates/create-with-container +++ b/gcloud/beta/compute/instance-templates/create-with-container @@ -551,10 +551,6 @@ FLAGS The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-tier=NETWORK_TIER Specifies the network tier that will be used to configure the instance. NETWORK_TIER must be one of: PREMIUM, STANDARD, FIXED_STANDARD. The diff --git a/gcloud/beta/compute/instances/create b/gcloud/beta/compute/instances/create index db679998b..97253c5d7 100644 --- a/gcloud/beta/compute/instances/create +++ b/gcloud/beta/compute/instances/create @@ -669,10 +669,6 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/beta/compute/instances/create-with-container b/gcloud/beta/compute/instances/create-with-container index cc2cf062f..ac9787d71 100644 --- a/gcloud/beta/compute/instances/create-with-container +++ b/gcloud/beta/compute/instances/create-with-container @@ -593,10 +593,6 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/beta/compute/network-attachments/create b/gcloud/beta/compute/network-attachments/create new file mode 100644 index 000000000..11aa48c08 --- /dev/null +++ b/gcloud/beta/compute/network-attachments/create @@ -0,0 +1,102 @@ +NAME + gcloud beta compute network-attachments create - create a Google Compute + Engine network attachment + +SYNOPSIS + gcloud beta compute network-attachments create NAME + --subnets=SUBNETS,[SUBNETS,...] + [--connection-preference=CONNECTION_PREFERENCE; + default="ACCEPT_AUTOMATIC"] [--description=DESCRIPTION] + [--producer-accept-list=[ACCEPT_LIST,...]] + [--producer-reject-list=[REJECT_LIST,...]] [--region=REGION] + [--subnets-region=SUBNETS_REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta compute network-attachments create is used to create + network attachments. A service consumer creates network attachments and + makes it available to producers. Service producers then use a multi-NIC VM + to form a bi-directional, non-NAT'd communication channel. + +EXAMPLES + $ gcloud beta compute network-attachments create \ + NETWORK_ATTACHMENT_NAME --region=us-central1 \ + --subnets=MY_SUBNET --connection-preference=ACCEPT_MANUAL \ + --producer-accept-list=PROJECT1,PROJECT2 \ + --producer-reject-list=PROJECT3,PROJECT4 + + To create a network attachment with a textual description, run: + + $ gcloud beta compute network-attachments create \ + NETWORK_ATTACHMENT_NAME --region=us-central1 \ + --subnets=MY_SUBNET --connection-preference=ACCEPT_MANUAL \ + --producer-accept-list=PROJECT1,PROJECT2 \ + --producer-reject-list=PROJECT3,PROJECT4 \ + --description='default network attachment' + +POSITIONAL ARGUMENTS + NAME + Name of the network attachment to create. + +REQUIRED FLAGS + --subnets=SUBNETS,[SUBNETS,...] + The subnetworks provided by the consumer for the producers + +OPTIONAL FLAGS + --connection-preference=CONNECTION_PREFERENCE; default="ACCEPT_AUTOMATIC" + The connection preference of network attachment. The value can be set + to ACCEPT_AUTOMATIC or ACCEPT_MANUAL. An ACCEPT_AUTOMATIC network + attachment is one that always accepts the connection from producer NIC. + An ACCEPT_MANUAL network attachment is one that requires an explicit + addition of the producer project id or project number to the producer + accept list. CONNECTION_PREFERENCE must be one of: ACCEPT_AUTOMATIC, + ACCEPT_MANUAL. + + --description=DESCRIPTION + An optional, textual description for the network attachment. + + --producer-accept-list=[ACCEPT_LIST,...] + Projects that are allowed to connect to this network attachment. + + --producer-reject-list=[REJECT_LIST,...] + Projects that are not allowed to connect to this network attachment. + + --region=REGION + Region of the network attachment to create. If not specified, you might + be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --subnets-region=SUBNETS_REGION + Region of the subnetworks to operate on. Overrides the default + compute/region property value for this command invocation. + +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 beta and might change without notice. These + variants are also available: + + $ gcloud compute network-attachments create + + $ gcloud alpha compute network-attachments create + diff --git a/gcloud/beta/compute/network-attachments/delete b/gcloud/beta/compute/network-attachments/delete new file mode 100644 index 000000000..c8d7777dd --- /dev/null +++ b/gcloud/beta/compute/network-attachments/delete @@ -0,0 +1,58 @@ +NAME + gcloud beta compute network-attachments delete - delete one or more Google + Compute Engine network attachments + +SYNOPSIS + gcloud beta compute network-attachments delete NAME [NAME ...] + [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete one or more Google Compute Engine network attachments. + +EXAMPLES + To delete a network attachment, run: + + $ gcloud beta compute network-attachments delete \ + NETWORK_ATTACHMENT_NAME --region=us-central1 + +POSITIONAL ARGUMENTS + NAME [NAME ...] + Names of the network attachments to delete. + +FLAGS + --region=REGION + Region of the network attachments to delete. If not specified, you + might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + +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 beta and might change without notice. These + variants are also available: + + $ gcloud compute network-attachments delete + + $ gcloud alpha compute network-attachments delete + diff --git a/gcloud/beta/compute/network-attachments/describe b/gcloud/beta/compute/network-attachments/describe new file mode 100644 index 000000000..20d251a36 --- /dev/null +++ b/gcloud/beta/compute/network-attachments/describe @@ -0,0 +1,58 @@ +NAME + gcloud beta compute network-attachments describe - describes a Google + Compute Engine network attachment + +SYNOPSIS + gcloud beta compute network-attachments describe NAME [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describes a Google Compute Engine network attachment. + +EXAMPLES + To describe a network attachment, run: + + $ gcloud beta compute network-attachments describe \ + NETWORK_ATTACHMENT_NAME --region=us-central1 + +POSITIONAL ARGUMENTS + NAME + Name of the network attachment to describe. + +FLAGS + --region=REGION + Region of the network attachment to describe. If not specified, you + might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + +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 beta and might change without notice. These + variants are also available: + + $ gcloud compute network-attachments describe + + $ gcloud alpha compute network-attachments describe + diff --git a/gcloud/beta/compute/network-attachments/help b/gcloud/beta/compute/network-attachments/help new file mode 100644 index 000000000..0dc01558a --- /dev/null +++ b/gcloud/beta/compute/network-attachments/help @@ -0,0 +1,38 @@ +NAME + gcloud beta compute network-attachments - manage Compute Engine network + attachment resources + +SYNOPSIS + gcloud beta compute network-attachments COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List, create, describe, update and delete network attachments. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a Google Compute Engine network attachment. + + delete + (BETA) Delete one or more Google Compute Engine network attachments. + + describe + (BETA) Describes a Google Compute Engine network attachment. + + list + (BETA) List Google Compute Engine network attachments. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-attachments + + $ gcloud alpha compute network-attachments + diff --git a/gcloud/beta/compute/network-attachments/list b/gcloud/beta/compute/network-attachments/list new file mode 100644 index 000000000..2d5fa0629 --- /dev/null +++ b/gcloud/beta/compute/network-attachments/list @@ -0,0 +1,90 @@ +NAME + gcloud beta compute network-attachments list - list Google Compute Engine + network attachments + +SYNOPSIS + gcloud beta compute network-attachments list [NAME ...] + [--regexp=REGEXP, -r REGEXP] [--regions=REGION,[REGION,...]] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Google Compute Engine network attachments. + +EXAMPLES + To list all the network attachments, run: + + $ gcloud beta compute network-attachments list + + To list the network attachments in given region(s), run: + + $ gcloud beta compute network-attachments list \ + --regions=region-1,region-2 + +POSITIONAL ARGUMENTS + [NAME ...] + (DEPRECATED) If provided, show details for the specified names and/or + URIs of resources. + + Argument NAME is deprecated. Use --filter="name=( 'NAME' ... )" + instead. + +FLAGS + --regexp=REGEXP, -r REGEXP + (DEPRECATED) Regular expression to filter the names of the results on. + Any names that do not match the entire regular expression will be + filtered out. + + Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. + + --regions=REGION,[REGION,...] + If provided, only resources from the given regions are queried. + +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 beta and might change without notice. These + variants are also available: + + $ gcloud compute network-attachments list + + $ gcloud alpha compute network-attachments list + diff --git a/gcloud/beta/container/backup-restore/backup-plans/create b/gcloud/beta/container/backup-restore/backup-plans/create index 94bbe8fb7..357f75a36 100644 --- a/gcloud/beta/container/backup-restore/backup-plans/create +++ b/gcloud/beta/container/backup-restore/backup-plans/create @@ -127,7 +127,7 @@ OPTIONAL FLAGS Schedule on which backups will be automatically created. Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, "10 3 * * " will automatically create a backup at 0310 + For example, 10 3 * * * will automatically create a backup at 0310 every day. All times are interpreted as UTC. The minimum interval between scheduled backups is 10 minutes. diff --git a/gcloud/beta/container/backup-restore/backup-plans/update b/gcloud/beta/container/backup-restore/backup-plans/update index 284e89bd1..dbed05811 100644 --- a/gcloud/beta/container/backup-restore/backup-plans/update +++ b/gcloud/beta/container/backup-restore/backup-plans/update @@ -144,7 +144,7 @@ FLAGS Schedule on which backups will be automatically created. Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. - For example, "10 3 * * " will automatically create a backup at 0310 + For example, 10 3 * * * will automatically create a backup at 0310 every day. All times are interpreted as UTC. The minimum interval between scheduled backups is 10 minutes. diff --git a/gcloud/beta/container/fleet/memberships/register b/gcloud/beta/container/fleet/memberships/register index 491a58005..ce10f1105 100644 --- a/gcloud/beta/container/fleet/memberships/register +++ b/gcloud/beta/container/fleet/memberships/register @@ -45,72 +45,73 @@ DESCRIPTION avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific + kubeconfig file, and install the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE URI: + Register a GKE cluster referenced from a GKE URI: $ gcloud beta container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect agent using service account key file: $ gcloud beta container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster first, and install the Connect agent later. + Register a GKE cluster first, and install the Connect agent later. $ gcloud beta container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud beta container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --enable-workload-identity + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity - Register a GKE cluster, and install a specific version of the Connect - agent: + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud beta container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=20220819-00-00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=20220819-00-00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install the - Connect agent: + Register a GKE cluster and output a manifest that can be used to install + the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME diff --git a/gcloud/beta/container/hub/memberships/register b/gcloud/beta/container/hub/memberships/register index 904af3e00..def1cf60c 100644 --- a/gcloud/beta/container/hub/memberships/register +++ b/gcloud/beta/container/hub/memberships/register @@ -45,72 +45,73 @@ DESCRIPTION avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific + kubeconfig file, and install the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE URI: + Register a GKE cluster referenced from a GKE URI: $ gcloud beta container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect agent using service account key file: $ gcloud beta container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster first, and install the Connect agent later. + Register a GKE cluster first, and install the Connect agent later. $ gcloud beta container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud beta container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --enable-workload-identity + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity - Register a GKE cluster, and install a specific version of the Connect - agent: + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud beta container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=20220819-00-00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=20220819-00-00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install the - Connect agent: + Register a GKE cluster and output a manifest that can be used to install + the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME diff --git a/gcloud/beta/firebase/test/android/run b/gcloud/beta/firebase/test/android/run index a5daa31cd..6627c4b11 100644 --- a/gcloud/beta/firebase/test/android/run +++ b/gcloud/beta/firebase/test/android/run @@ -504,7 +504,7 @@ DEPRECATED DEVICE DIMENSIONS FLAGS --device-ids=MODEL_ID,[MODEL_ID,...], -d MODEL_ID,[MODEL_ID,...] The list of MODEL_IDs to test against (default: one device model determined by the Firebase Test Lab device catalog; see TAGS listed by - the $ gcloud beta firebase test android devices list command). + the $ gcloud beta firebase test android models list command). --locales=LOCALE,[LOCALE,...], -l LOCALE,[LOCALE,...] The list of LOCALEs to test against (default: a single locale diff --git a/gcloud/beta/iam/help b/gcloud/beta/iam/help index c496bea05..484469638 100644 --- a/gcloud/beta/iam/help +++ b/gcloud/beta/iam/help @@ -36,6 +36,9 @@ GROUPS service-accounts (BETA) Create and manipulate service accounts. + workforce-pools + (BETA) Create and manage workforce pools. + workload-identity-pools (BETA) Manage IAM workload identity pools. diff --git a/gcloud/beta/iam/workforce-pools/create b/gcloud/beta/iam/workforce-pools/create new file mode 100644 index 000000000..14f29c22b --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/create @@ -0,0 +1,94 @@ +NAME + gcloud beta iam workforce-pools create - create a new workforce pool under + an organization + +SYNOPSIS + gcloud beta iam workforce-pools create + (WORKFORCE_POOL : --location=LOCATION) --organization=ORGANIZATION + [--async] [--description=DESCRIPTION] [--disabled] + [--display-name=DISPLAY_NAME] [--session-duration=SESSION_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Creates a workforce pool under an organization given a valid + organization ID. + +EXAMPLES + The following command creates a workforce pool with ID my-workforce-pool in + the organization 12345: + + $ gcloud beta iam workforce-pools create my-workforce-pool \ + --organization=12345 + + The following command creates a workforce pool with ID my-workforce-pool + with explicit values for all required and optional parameters: + + $ gcloud beta iam workforce-pools create my-workforce-pool \ + --organization=12345 --location=global \ + --display-name="My Workforce Pool" \ + --description="My workforce pool + description." --session-duration="7200s" --disabled + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to create. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --organization=ORGANIZATION + The parent organization of the workforce pool to create. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description for the workforce pool. Cannot exceed 256 characters in + length. + + --disabled + Whether or not the workforce pool is disabled. + + --display-name=DISPLAY_NAME + A display name for the workforce pool. Cannot exceed 32 characters in + length. + + --session-duration=SESSION_DURATION + How long the Google Cloud access tokens, console sign-in sessions, and + gcloud sign-in sessions from this workforce pool are valid. Must be + greater than 15 minutes (900s) and less than 12 hours (43200s). If not + configured, minted credentials will have a default duration of one hour + (3600s). + +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 beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools create + + $ gcloud alpha iam workforce-pools create + diff --git a/gcloud/beta/iam/workforce-pools/create-cred-config b/gcloud/beta/iam/workforce-pools/create-cred-config new file mode 100644 index 000000000..4b34a910b --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/create-cred-config @@ -0,0 +1,145 @@ +NAME + gcloud beta iam workforce-pools create-cred-config - create a configuration + file for generated credentials + +SYNOPSIS + gcloud beta iam workforce-pools create-cred-config AUDIENCE + --output-file=OUTPUT_FILE + --workforce-pool-user-project=WORKFORCE_POOL_USER_PROJECT + (--credential-source-file=CREDENTIAL_SOURCE_FILE + | --credential-source-url=CREDENTIAL_SOURCE_URL + | --executable-command=EXECUTABLE_COMMAND) + [--credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME] + [--credential-source-headers=[key=value,...]] + [--credential-source-type=CREDENTIAL_SOURCE_TYPE] + [--subject-token-type=SUBJECT_TOKEN_TYPE] + [--executable-interactive-timeout-millis=EXECUTABLE_INTERACTIVE_TIMEOUT_MILLIS --executable-output-file=EXECUTABLE_OUTPUT_FILE --executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS] + [--service-account=SERVICE_ACCOUNT + : --service-account-token-lifetime-seconds=SERVICE_ACCOUNT_TOKEN_LIFETIME_SECONDS] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) This command creates a configuration file to allow access to + authenticated Google Cloud actions from a variety of external user + accounts. + +EXAMPLES + To create a file-sourced credential configuration for your project, run: + + $ gcloud beta iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --credential-source-file=$PATH_TO_OIDC_ID_TOKEN \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To create a URL-sourced credential configuration for your project, run: + + $ gcloud beta iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --credential-source-url=$URL_FOR_OIDC_TOKEN \ + --credential-source-headers=Key=Value \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To create an executable-source credential configuration for your project, + run the following command: + + $ gcloud beta iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --executable-command=$EXECUTABLE_COMMAND \ + --executable-timeout-millis=30000 \ + --executable-output-file=$CACHE_FILE \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To use the resulting file for any of these commands, set the + GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the + generated file. + +POSITIONAL ARGUMENTS + AUDIENCE + The workforce pool provider resource name. + +REQUIRED FLAGS + --output-file=OUTPUT_FILE + Location to store the generated credential configuration file. + + --workforce-pool-user-project=WORKFORCE_POOL_USER_PROJECT + The client project number used to identify the application (client + project) to the server when calling Google APIs. The user principal + must have serviceusage.services.use IAM permission to use the specified + project. + + Credential types. + + Exactly one of these must be specified: + + --credential-source-file=CREDENTIAL_SOURCE_FILE + The location of the file which stores the credential. + + --credential-source-url=CREDENTIAL_SOURCE_URL + The URL to obtain the credential from. + + --executable-command=EXECUTABLE_COMMAND + The full command to run to retrieve the credential. Must be an + absolute path for the program including arguments. + +OPTIONAL FLAGS + --credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME + The subject token field name (key) in a JSON credential source. + + --credential-source-headers=[key=value,...] + Headers to use when querying the credential-source-url. + + --credential-source-type=CREDENTIAL_SOURCE_TYPE + The format of the credential source (JSON or text). + + --subject-token-type=SUBJECT_TOKEN_TYPE + The type of token being used for authorization. This defaults to + urn:ietf:params:oauth:token-type:id_token. + + Arguments for an executable type credential source. + + --executable-interactive-timeout-millis=EXECUTABLE_INTERACTIVE_TIMEOUT_MILLIS + The timeout duration, in milliseconds, to wait for the executable to + finish when the command is running in interactive mode. + + --executable-output-file=EXECUTABLE_OUTPUT_FILE + The absolute path to the file storing the executable response. + + --executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS + The timeout duration in milliseconds for waiting for the executable + to finish. + + Service account impersonation options. + + --service-account=SERVICE_ACCOUNT + The email of the service account to impersonate. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --service-account-token-lifetime-seconds=SERVICE_ACCOUNT_TOKEN_LIFETIME_SECONDS + The desired lifetime duration of the service account access token in + seconds. This defaults to one hour when not provided. If a lifetime + greater than one hour is required, the service account must be added + as an allowed value in an Organization Policy that enforces the + constraints/iam.allowServiceAccountCredentialLifetimeExtension + constraint. + +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 beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools create-cred-config + + $ gcloud alpha iam workforce-pools create-cred-config + diff --git a/gcloud/beta/iam/workforce-pools/delete b/gcloud/beta/iam/workforce-pools/delete new file mode 100644 index 000000000..e4466e6c2 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/delete @@ -0,0 +1,61 @@ +NAME + gcloud beta iam workforce-pools delete - delete a workforce pool + +SYNOPSIS + gcloud beta iam workforce-pools delete + (WORKFORCE_POOL : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a workforce pool. + +EXAMPLES + The following command deletes a workforce pool with ID my-workforce-pool: + + $ gcloud beta iam workforce-pools delete my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to delete. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools delete + + $ gcloud alpha iam workforce-pools delete + diff --git a/gcloud/beta/iam/workforce-pools/describe b/gcloud/beta/iam/workforce-pools/describe new file mode 100644 index 000000000..382f6f3bd --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/describe @@ -0,0 +1,56 @@ +NAME + gcloud beta iam workforce-pools describe - describe a workforce pool + +SYNOPSIS + gcloud beta iam workforce-pools describe + (WORKFORCE_POOL : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a workforce pool. + +EXAMPLES + The following command describes a workforce pool with ID my-workforce-pool: + + $ gcloud beta iam workforce-pools describe my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to describe. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools describe + + $ gcloud alpha iam workforce-pools describe + diff --git a/gcloud/beta/iam/workforce-pools/help b/gcloud/beta/iam/workforce-pools/help new file mode 100644 index 000000000..8c394977d --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/help @@ -0,0 +1,56 @@ +NAME + gcloud beta iam workforce-pools - create and manage workforce pools + +SYNOPSIS + gcloud beta iam workforce-pools GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) The gcloud beta iam workforce-pools group lets you create and manage + workforce pools for organizations on the Google Cloud Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + (BETA) Manage IAM workforce pool long-running operations. + + providers + (BETA) Create and manage workforce pool providers. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a new workforce pool under an organization. + + create-cred-config + (BETA) Create a configuration file for generated credentials. + + delete + (BETA) Delete a workforce pool. + + describe + (BETA) Describe a workforce pool. + + list + (BETA) List the workforce pools for an organization. + + undelete + (BETA) Undelete a workforce pool. + + update + (BETA) Update a workforce pool. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools + + $ gcloud alpha iam workforce-pools + diff --git a/gcloud/beta/iam/workforce-pools/list b/gcloud/beta/iam/workforce-pools/list new file mode 100644 index 000000000..823414e9a --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/list @@ -0,0 +1,79 @@ +NAME + gcloud beta iam workforce-pools list - list the workforce pools for an + organization + +SYNOPSIS + gcloud beta iam workforce-pools list --location=LOCATION + --organization=ORGANIZATION [--show-deleted] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Lists all of the workforce pools for an organization given a valid + organization ID. + + This command can fail for the following reasons: + ▪ The organization specified does not exist. + ▪ The active account does not have permission to access the + organization. + +EXAMPLES + The following command lists the workforce pools for an organization with + the ID 12345, including soft-deleted pools: + + $ gcloud beta iam workforce-pools list --organization=12345 \ + --location=global --show-deleted + +REQUIRED FLAGS + --location=LOCATION + The location of the workforce pools to list. + + --organization=ORGANIZATION + The parent organization of the workforce pools to list. + +FLAGS + --show-deleted + Show soft-deleted workforce pools by specifying this flag. + +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. + +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 beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools list + + $ gcloud alpha iam workforce-pools list + diff --git a/gcloud/beta/iam/workforce-pools/operations/describe b/gcloud/beta/iam/workforce-pools/operations/describe new file mode 100644 index 000000000..3fb10f600 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/operations/describe @@ -0,0 +1,72 @@ +NAME + gcloud beta iam workforce-pools operations describe - describe a workforce + pool operation + +SYNOPSIS + gcloud beta iam workforce-pools operations describe + (OPERATION : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a workforce pool operation. + +EXAMPLES + To describe the long-running workforce pool operation with the ID + my-operation, run: + + $ gcloud beta iam workforce-pools operations describe my-operation \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool operation resource - The workforce pool long-running + operation to describe. The arguments in this group can be used to specify + the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool operation or fully qualified identifier for + the workforce pool operation. To set the operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools operations describe + + $ gcloud alpha iam workforce-pools operations describe + diff --git a/gcloud/beta/iam/workforce-pools/operations/help b/gcloud/beta/iam/workforce-pools/operations/help new file mode 100644 index 000000000..93a3bbb63 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/operations/help @@ -0,0 +1,29 @@ +NAME + gcloud beta iam workforce-pools operations - manage IAM workforce pool + long-running operations + +SYNOPSIS + gcloud beta iam workforce-pools operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Commands for managing IAM workforce pool long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describe a workforce pool operation. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools operations + + $ gcloud alpha iam workforce-pools operations + diff --git a/gcloud/beta/iam/workforce-pools/providers/create-oidc b/gcloud/beta/iam/workforce-pools/providers/create-oidc new file mode 100644 index 000000000..65f52e89e --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/create-oidc @@ -0,0 +1,204 @@ +NAME + gcloud beta iam workforce-pools providers create-oidc - create a new OIDC + workforce pool provider + +SYNOPSIS + gcloud beta iam workforce-pools providers create-oidc + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + --attribute-mapping=[ATTRIBUTE_MAPPING,...] --client-id=CLIENT_ID + --issuer-uri=ISSUER_URI [--async] + [--attribute-condition=ATTRIBUTE_CONDITION] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a new OIDC workforce pool provider. + +EXAMPLES + The following command creates a disabled OIDC workforce pool provider with + the ID my-workforce-pool-provider. Explicit values for all required and + optional parameters are provided. + + $ gcloud beta iam workforce-pools providers create-oidc \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" --client-id="client-id" \ + --issuer-uri="https://test-idp.com" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to create. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +REQUIRED FLAGS + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --client-id=CLIENT_ID + The OIDC client ID. This must match the audience claim of the JWT + issued by the identity provider. + + --issuer-uri=ISSUER_URI + The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers create-oidc + + $ gcloud alpha iam workforce-pools providers create-oidc + diff --git a/gcloud/beta/iam/workforce-pools/providers/delete b/gcloud/beta/iam/workforce-pools/providers/delete new file mode 100644 index 000000000..3211140b3 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/delete @@ -0,0 +1,78 @@ +NAME + gcloud beta iam workforce-pools providers delete - delete a workforce pool + provider + +SYNOPSIS + gcloud beta iam workforce-pools providers delete + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a workforce pool provider. + +EXAMPLES + The following command deletes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud beta iam workforce-pools providers delete \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to delete. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers delete + + $ gcloud alpha iam workforce-pools providers delete + diff --git a/gcloud/beta/iam/workforce-pools/providers/describe b/gcloud/beta/iam/workforce-pools/providers/describe new file mode 100644 index 000000000..484d779a0 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/describe @@ -0,0 +1,73 @@ +NAME + gcloud beta iam workforce-pools providers describe - describe a workforce + pool provider + +SYNOPSIS + gcloud beta iam workforce-pools providers describe + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a workforce pool provider. + +EXAMPLES + The following command describes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud beta iam workforce-pools providers describe \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to + describe. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers describe + + $ gcloud alpha iam workforce-pools providers describe + diff --git a/gcloud/beta/iam/workforce-pools/providers/help b/gcloud/beta/iam/workforce-pools/providers/help new file mode 100644 index 000000000..186304d36 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/help @@ -0,0 +1,52 @@ +NAME + gcloud beta iam workforce-pools providers - create and manage workforce + pool providers + +SYNOPSIS + gcloud beta iam workforce-pools providers GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) The gcloud beta iam workforce-pools providers group lets you create + and manage workforce pool providers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + (BETA) Manage IAM workforce pool provider long-running operations. + +COMMANDS + COMMAND is one of the following: + + create-oidc + (BETA) Create a new OIDC workforce pool provider. + + delete + (BETA) Delete a workforce pool provider. + + describe + (BETA) Describe a workforce pool provider. + + list + (BETA) List workforce pool providers. + + undelete + (BETA) Undelete a workforce pool provider. + + update-oidc + (BETA) Update an OIDC workforce pool provider. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers + + $ gcloud alpha iam workforce-pools providers + diff --git a/gcloud/beta/iam/workforce-pools/providers/list b/gcloud/beta/iam/workforce-pools/providers/list new file mode 100644 index 000000000..9c49cd9be --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/list @@ -0,0 +1,92 @@ +NAME + gcloud beta iam workforce-pools providers list - list workforce pool + providers + +SYNOPSIS + gcloud beta iam workforce-pools providers list + (--workforce-pool=WORKFORCE_POOL : --location=LOCATION) + [--show-deleted] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List workforce pool providers. + +EXAMPLES + The following command lists the workforce pool providers in the workforce + pool with ID my-workforce-pool, including soft-deleted pools: + + $ gcloud beta iam workforce-pools providers list \ + --workforce-pool="my-workforce-pool" --location="global" \ + --show-deleted + +REQUIRED FLAGS + Workforce pool resource - The parent workforce pool of the workforce pool + providers to list. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + --workforce-pool=WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce-pool attribute: + ▸ provide the argument --workforce-pool on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The location for the workforce pool. To set the location attribute: + ▸ provide the argument --workforce-pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --show-deleted + Show soft-deleted workforce pool providers by specifying this flag. + +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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers list + + $ gcloud alpha iam workforce-pools providers list + diff --git a/gcloud/beta/iam/workforce-pools/providers/operations/describe b/gcloud/beta/iam/workforce-pools/providers/operations/describe new file mode 100644 index 000000000..a6665980c --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/operations/describe @@ -0,0 +1,87 @@ +NAME + gcloud beta iam workforce-pools providers operations describe - describe a + workforce pool provider operation + +SYNOPSIS + gcloud beta iam workforce-pools providers operations describe + (OPERATION : --location=LOCATION + --provider=PROVIDER --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a workforce pool provider operation. + +EXAMPLES + To describe the long-running workforce pool provider operation with the ID + my-operation, run: + + $ gcloud beta iam workforce-pools providers operations describe \ + my-operation --workforce-pool="my-workforce-pool" \ + --provider="my-provider" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider operation resource - The workforce pool provider + long-running operation to describe. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool provider operation or fully qualified + identifier for the workforce pool provider operation. To set the + operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --provider=PROVIDER + The ID to use for the workforce pool provider, which becomes the + final component of the resource name. This value must be unique + within the workforce pool, 4-32 characters in length, and may contain + the characters [a-z0-9-]. The prefix gcp- is reserved for use by + Google, and may not be specified. + + To set the provider attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --provider on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers operations describe + + $ gcloud alpha iam workforce-pools providers operations describe + diff --git a/gcloud/beta/iam/workforce-pools/providers/operations/help b/gcloud/beta/iam/workforce-pools/providers/operations/help new file mode 100644 index 000000000..e650cd729 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/operations/help @@ -0,0 +1,31 @@ +NAME + gcloud beta iam workforce-pools providers operations - manage IAM workforce + pool provider long-running operations + +SYNOPSIS + gcloud beta iam workforce-pools providers operations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Commands for managing IAM workforce pool provider long-running + operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describe a workforce pool provider operation. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers operations + + $ gcloud alpha iam workforce-pools providers operations + diff --git a/gcloud/beta/iam/workforce-pools/providers/undelete b/gcloud/beta/iam/workforce-pools/providers/undelete new file mode 100644 index 000000000..c36d6fd8d --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/undelete @@ -0,0 +1,78 @@ +NAME + gcloud beta iam workforce-pools providers undelete - undelete a workforce + pool provider + +SYNOPSIS + gcloud beta iam workforce-pools providers undelete + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Undelete a workforce pool provider. + +EXAMPLES + The following command undeletes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud beta iam workforce-pools providers undelete \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to + undelete. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers undelete + + $ gcloud alpha iam workforce-pools providers undelete + diff --git a/gcloud/beta/iam/workforce-pools/providers/update-oidc b/gcloud/beta/iam/workforce-pools/providers/update-oidc new file mode 100644 index 000000000..1f35b24e7 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/providers/update-oidc @@ -0,0 +1,203 @@ +NAME + gcloud beta iam workforce-pools providers update-oidc - update an OIDC + workforce pool provider + +SYNOPSIS + gcloud beta iam workforce-pools providers update-oidc + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [--attribute-condition=ATTRIBUTE_CONDITION] + [--attribute-mapping=[ATTRIBUTE_MAPPING,...]] [--client-id=CLIENT_ID] + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [--issuer-uri=ISSUER_URI] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update an OIDC workforce pool provider. + +EXAMPLES + The following command updates the OIDC workforce pool provider with the ID + my-workforce-pool-provider in the workforce pool my-workforce-pool. + Explicit values for all required and optional parameters are provided: + + $ gcloud beta iam workforce-pools providers update-oidc \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" --client-id="client-id" \ + --issuer-uri="https://test-idp.com" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to update. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --client-id=CLIENT_ID + The OIDC client ID. This must match the audience claim of the JWT + issued by the identity provider. + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + + --issuer-uri=ISSUER_URI + The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools providers update-oidc + + $ gcloud alpha iam workforce-pools providers update-oidc + diff --git a/gcloud/beta/iam/workforce-pools/undelete b/gcloud/beta/iam/workforce-pools/undelete new file mode 100644 index 000000000..7db94777c --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/undelete @@ -0,0 +1,61 @@ +NAME + gcloud beta iam workforce-pools undelete - undelete a workforce pool + +SYNOPSIS + gcloud beta iam workforce-pools undelete + (WORKFORCE_POOL : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Undelete a workforce pool. + +EXAMPLES + The following command undeletes a workforce pool with ID my-workforce-pool: + + $ gcloud beta iam workforce-pools undelete my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to undelete. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools undelete + + $ gcloud alpha iam workforce-pools undelete + diff --git a/gcloud/beta/iam/workforce-pools/update b/gcloud/beta/iam/workforce-pools/update new file mode 100644 index 000000000..db33317d1 --- /dev/null +++ b/gcloud/beta/iam/workforce-pools/update @@ -0,0 +1,86 @@ +NAME + gcloud beta iam workforce-pools update - update a workforce pool + +SYNOPSIS + gcloud beta iam workforce-pools update + (WORKFORCE_POOL : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [--session-duration=SESSION_DURATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a workforce pool. + +EXAMPLES + The following command updates a workforce pool with ID my-workforce-pool + with explicit values for all required and optional parameters: + + $ gcloud beta iam workforce-pools update my-workforce-pool \ + --location=global --display-name="My Workforce Pool" \ + --description="My workforce pool description." \ + --session-duration="7200s" --disabled + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to update. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + + --description=DESCRIPTION + A description for the workforce pool. Cannot exceed 256 characters in + length. + + --disabled + Whether or not the workforce pool is disabled. You cannot use a + disabled workforce pool to perform new token exchanges or sign-ins + using any provider in the workforce pool. + + --display-name=DISPLAY_NAME + A display name for the workforce pool. Cannot exceed 32 characters in + length. + + --session-duration=SESSION_DURATION + How long the Google Cloud access tokens, console sign-in sessions, and + gcloud sign-in sessions from this workforce pool are valid. Must be + greater than 15 minutes (900s) and less than 12 hours (43200s). If not + configured, minted credentials will have a default duration of one hour + (3600s). + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud iam workforce-pools update + + $ gcloud alpha iam workforce-pools update + diff --git a/gcloud/beta/init b/gcloud/beta/init index f4fb9a35e..42ad098b3 100644 --- a/gcloud/beta/init +++ b/gcloud/beta/init @@ -39,14 +39,14 @@ EXAMPLES FLAGS --no-browser - Prevent the command from launching a browser for authorization. + Prevent the command from launching a browser for authorization. Use + this flag if you are on a machine that does not have a browser but you + can install the gcloud CLI on another machine with a browser. --console-only, --no-launch-browser - (DEPRECATED) Prevent the command from launching a browser for - authorization. - - The --console-only/--no-launch-browser are deprecated and will be - removed in future updates. Use --no-browser as a replacement. + Prevent the command from launching a browser for authorization. Use + this flag if you are on a machine that does not have a browser and you + cannot install the gcloud CLI on another machine with a browser. --skip-diagnostics Do not run diagnostics. diff --git a/gcloud/beta/iot/devices/list b/gcloud/beta/iot/devices/list index b62b44c02..bf36cf893 100644 --- a/gcloud/beta/iot/devices/list +++ b/gcloud/beta/iot/devices/list @@ -3,10 +3,11 @@ NAME SYNOPSIS gcloud beta iot devices list (--registry=REGISTRY : --region=REGION) - [--device-ids=[DEVICE_IDS,...]] [--device-num-ids=[DEVICE_NUM_IDS,...]] - [--device-type=DEVICE_TYPE] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--device-field-mask=DEVICE_FIELD_MASK; + default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]] + [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) List devices. @@ -45,6 +46,12 @@ REQUIRED FLAGS ▸ provide the argument --region on the command line. FLAGS + --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig" + If given, returns all specified device fields instead of the default + set. The value is a comma-separated list of field names. Example: + "lastErrorStatus,config,metadata". See full list of device fields at: + https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices + --device-ids=[DEVICE_IDS,...] If given, show only devices with one of the provided IDs. diff --git a/gcloud/beta/notebooks/environments/create b/gcloud/beta/notebooks/environments/create index afc911508..226c0a4ec 100644 --- a/gcloud/beta/notebooks/environments/create +++ b/gcloud/beta/notebooks/environments/create @@ -15,7 +15,10 @@ SYNOPSIS [--post-startup-script=POST_STARTUP_SCRIPT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for creating environments. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for creating environments. EXAMPLES To create an environment with id 'example-environment' in location diff --git a/gcloud/beta/notebooks/environments/delete b/gcloud/beta/notebooks/environments/delete index f4a56cafc..b5bac0651 100644 --- a/gcloud/beta/notebooks/environments/delete +++ b/gcloud/beta/notebooks/environments/delete @@ -7,7 +7,10 @@ SYNOPSIS (ENVIRONMENT : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for deleting environments. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for deleting environments. EXAMPLES To delete environment with id 'example-environment' in location diff --git a/gcloud/beta/notebooks/environments/describe b/gcloud/beta/notebooks/environments/describe index 15b078fc9..00bc91d58 100644 --- a/gcloud/beta/notebooks/environments/describe +++ b/gcloud/beta/notebooks/environments/describe @@ -7,7 +7,10 @@ SYNOPSIS (ENVIRONMENT : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for describing environments. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for describing environments. EXAMPLES To describe an environment with id 'example-environment' in location diff --git a/gcloud/beta/notebooks/environments/help b/gcloud/beta/notebooks/environments/help index 887f628d3..8139f5272 100644 --- a/gcloud/beta/notebooks/environments/help +++ b/gcloud/beta/notebooks/environments/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud beta notebooks environments COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Notebooks Environments Command Group. + (BETA) (DEPRECATED) Notebooks Environments Command Group. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,16 +18,16 @@ COMMANDS COMMAND is one of the following: create - (BETA) Request for creating environments. + (BETA) (DEPRECATED) Request for creating environments. delete - (BETA) Request for deleting environments. + (BETA) (DEPRECATED) Request for deleting environments. describe - (BETA) Request for describing environments. + (BETA) (DEPRECATED) Request for describing environments. list - (BETA) Request for listing environments. + (BETA) (DEPRECATED) Request for listing environments. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/notebooks/environments/list b/gcloud/beta/notebooks/environments/list index a0b423207..5dd852af1 100644 --- a/gcloud/beta/notebooks/environments/list +++ b/gcloud/beta/notebooks/environments/list @@ -7,7 +7,10 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for listing environments. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for listing environments. EXAMPLES To list environments in location 'us-central1-a', run: diff --git a/gcloud/beta/notebooks/help b/gcloud/beta/notebooks/help index e517aa45b..5f92b261c 100644 --- a/gcloud/beta/notebooks/help +++ b/gcloud/beta/notebooks/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud beta notebooks GROUP [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Notebooks Command Group. + (BETA) (DEPRECATED) Notebooks Command Group. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,13 +18,13 @@ GROUPS GROUP is one of the following: environments - (BETA) Notebooks Environments Command Group. + (BETA) (DEPRECATED) Notebooks Environments Command Group. instances - (BETA) Notebooks Instances command group. + (BETA) (DEPRECATED) Notebooks Instances command group. locations - (BETA) View locations available for a project. + (BETA) (DEPRECATED) View locations available for a project. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/notebooks/instances/add-iam-policy-binding b/gcloud/beta/notebooks/instances/add-iam-policy-binding index 95268fcc3..f02902dc6 100644 --- a/gcloud/beta/notebooks/instances/add-iam-policy-binding +++ b/gcloud/beta/notebooks/instances/add-iam-policy-binding @@ -8,8 +8,11 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Adds a policy binding to the IAM policy of an instance, given an - instance ID and the binding. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Adds a policy binding to the IAM policy of an instance, given an instance + ID and the binding. EXAMPLES To add an IAM policy binding for the role of roles/notebooks.admin for the diff --git a/gcloud/beta/notebooks/instances/create b/gcloud/beta/notebooks/instances/create index 947a54fcc..2349f0232 100644 --- a/gcloud/beta/notebooks/instances/create +++ b/gcloud/beta/notebooks/instances/create @@ -30,7 +30,10 @@ SYNOPSIS default="TYPE_UNSPECIFIED"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for creating notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for creating notebook instances. EXAMPLES To create an instance from an environment, run: diff --git a/gcloud/beta/notebooks/instances/delete b/gcloud/beta/notebooks/instances/delete index 667eb373f..c79992005 100644 --- a/gcloud/beta/notebooks/instances/delete +++ b/gcloud/beta/notebooks/instances/delete @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for deleting notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for deleting notebook instances. EXAMPLES To delete an instance, run: diff --git a/gcloud/beta/notebooks/instances/describe b/gcloud/beta/notebooks/instances/describe index 4c9dbefa8..8f674382c 100644 --- a/gcloud/beta/notebooks/instances/describe +++ b/gcloud/beta/notebooks/instances/describe @@ -6,7 +6,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for describing notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for describing notebook instances. EXAMPLES To describe an instance, run: diff --git a/gcloud/beta/notebooks/instances/diagnose b/gcloud/beta/notebooks/instances/diagnose index 7cf84819c..d6cffe48c 100644 --- a/gcloud/beta/notebooks/instances/diagnose +++ b/gcloud/beta/notebooks/instances/diagnose @@ -8,7 +8,10 @@ SYNOPSIS [--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for diagnose notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for diagnose notebook instances. EXAMPLES To diagnose an instance, run: diff --git a/gcloud/beta/notebooks/instances/get-iam-policy b/gcloud/beta/notebooks/instances/get-iam-policy index c796d53ae..f406c1ac9 100644 --- a/gcloud/beta/notebooks/instances/get-iam-policy +++ b/gcloud/beta/notebooks/instances/get-iam-policy @@ -8,12 +8,14 @@ SYNOPSIS [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) gcloud beta notebooks instances get-iam-policy displays the IAM - policy associated with an instance. If formatted as JSON, the output can be - edited and used as a policy file for set-iam-policy. The output includes an - "etag" field identifying the version emitted and allowing detection of - concurrent policy updates; see $ {parent} set-iam-policy for additional - details. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + gcloud beta notebooks instances get-iam-policy displays the IAM policy + associated with an instance. If formatted as JSON, the output can be edited + and used as a policy file for set-iam-policy. The output includes an "etag" + field identifying the version emitted and allowing detection of concurrent + policy updates; see $ {parent} set-iam-policy for additional details. EXAMPLES To print the IAM policy for a given folder, run: diff --git a/gcloud/beta/notebooks/instances/help b/gcloud/beta/notebooks/instances/help index ad7ed254a..5c4507131 100644 --- a/gcloud/beta/notebooks/instances/help +++ b/gcloud/beta/notebooks/instances/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud beta notebooks instances COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Notebooks Instances command group. + (BETA) (DEPRECATED) Notebooks Instances command group. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,52 +18,53 @@ COMMANDS COMMAND is one of the following: add-iam-policy-binding - (BETA) Add IAM policy binding for an instance. + (BETA) (DEPRECATED) Add IAM policy binding for an instance. create - (BETA) Request for creating an instance. + (BETA) (DEPRECATED) Request for creating an instance. delete - (BETA) Request for deleting instances. + (BETA) (DEPRECATED) Request for deleting instances. describe - (BETA) Request for describing instances. + (BETA) (DEPRECATED) Request for describing instances. diagnose - (BETA) Request for diagnose instances. + (BETA) (DEPRECATED) Request for diagnose instances. get-iam-policy - (BETA) Get IAM policy for an instance. + (BETA) (DEPRECATED) Get IAM policy for an instance. is-upgradeable - (BETA) Request for checking if a notebook instance is upgradeable. + (BETA) (DEPRECATED) Request for checking if a notebook instance is + upgradeable. list - (BETA) Request for listing instances. + (BETA) (DEPRECATED) Request for listing instances. register - (BETA) Request for registering instances. + (BETA) (DEPRECATED) Request for registering instances. remove-iam-policy-binding - (BETA) Remove IAM policy binding for an instance. + (BETA) (DEPRECATED) Remove IAM policy binding for an instance. reset - (BETA) Request for resetting instances. + (BETA) (DEPRECATED) Request for resetting instances. set-iam-policy - (BETA) Set the IAM policy for an Instance. + (BETA) (DEPRECATED) Set the IAM policy for an Instance. start - (BETA) Request for starting instances. + (BETA) (DEPRECATED) Request for starting instances. stop - (BETA) Request for stopping instances. + (BETA) (DEPRECATED) Request for stopping instances. update - (BETA) Request for updating instances. + (BETA) (DEPRECATED) Request for updating instances. upgrade - (BETA) Request for upgrading instances. + (BETA) (DEPRECATED) Request for upgrading instances. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/notebooks/instances/is-upgradeable b/gcloud/beta/notebooks/instances/is-upgradeable index 27d9d9e21..486e48b0a 100644 --- a/gcloud/beta/notebooks/instances/is-upgradeable +++ b/gcloud/beta/notebooks/instances/is-upgradeable @@ -7,7 +7,10 @@ SYNOPSIS (INSTANCE : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for checking if a notebook instance is upgradeable. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for checking if a notebook instance is upgradeable. EXAMPLES To check if an instance can be upgraded, run: diff --git a/gcloud/beta/notebooks/instances/list b/gcloud/beta/notebooks/instances/list index 50080d1a4..93d02d9d8 100644 --- a/gcloud/beta/notebooks/instances/list +++ b/gcloud/beta/notebooks/instances/list @@ -7,7 +7,10 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for listing instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for listing instances. EXAMPLES To list instances in a particular location, run: diff --git a/gcloud/beta/notebooks/instances/register b/gcloud/beta/notebooks/instances/register index fc80953c5..2f17a0261 100644 --- a/gcloud/beta/notebooks/instances/register +++ b/gcloud/beta/notebooks/instances/register @@ -7,7 +7,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for registering notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for registering notebook instances. EXAMPLES To register an old type instance, run: diff --git a/gcloud/beta/notebooks/instances/remove-iam-policy-binding b/gcloud/beta/notebooks/instances/remove-iam-policy-binding index 9fdc2e303..bbf149fcf 100644 --- a/gcloud/beta/notebooks/instances/remove-iam-policy-binding +++ b/gcloud/beta/notebooks/instances/remove-iam-policy-binding @@ -8,7 +8,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Removes a policy binding to the IAM policy of an instance, given an + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Removes a policy binding to the IAM policy of an instance, given an instance ID and the binding. EXAMPLES diff --git a/gcloud/beta/notebooks/instances/reset b/gcloud/beta/notebooks/instances/reset index c01d13c28..664f93f6a 100644 --- a/gcloud/beta/notebooks/instances/reset +++ b/gcloud/beta/notebooks/instances/reset @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for reseting notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for reseting notebook instances. EXAMPLES To reset an instance, run: diff --git a/gcloud/beta/notebooks/instances/set-iam-policy b/gcloud/beta/notebooks/instances/set-iam-policy index 56e0f1038..8c5e5badd 100644 --- a/gcloud/beta/notebooks/instances/set-iam-policy +++ b/gcloud/beta/notebooks/instances/set-iam-policy @@ -7,8 +7,11 @@ SYNOPSIS (INSTANCE : --location=LOCATION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) gcloud beta notebooks instances set-iam-policy sets the IAM policy - for a Notebook instance given an instance ID and a JSON or YAML file that + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + gcloud beta notebooks instances set-iam-policy sets the IAM policy for a + Notebook instance given an instance ID and a JSON or YAML file that describes the IAM policy. Note: Setting the IAM policy for an Instance replaces existing IAM bindings diff --git a/gcloud/beta/notebooks/instances/start b/gcloud/beta/notebooks/instances/start index be529b8fc..14d40d131 100644 --- a/gcloud/beta/notebooks/instances/start +++ b/gcloud/beta/notebooks/instances/start @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for starting notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for starting notebook instances. EXAMPLES To start an instance, run: diff --git a/gcloud/beta/notebooks/instances/stop b/gcloud/beta/notebooks/instances/stop index c8bfbdf98..2dae6acbe 100644 --- a/gcloud/beta/notebooks/instances/stop +++ b/gcloud/beta/notebooks/instances/stop @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for stopping notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for stopping notebook instances. EXAMPLES To stop an instance, run: diff --git a/gcloud/beta/notebooks/instances/update b/gcloud/beta/notebooks/instances/update index ff7fc00bc..31c470fd6 100644 --- a/gcloud/beta/notebooks/instances/update +++ b/gcloud/beta/notebooks/instances/update @@ -9,7 +9,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for updating notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for updating notebook instances. EXAMPLES To update machine type for an instance, run: diff --git a/gcloud/beta/notebooks/instances/upgrade b/gcloud/beta/notebooks/instances/upgrade index a5a20ca3d..9449d91da 100644 --- a/gcloud/beta/notebooks/instances/upgrade +++ b/gcloud/beta/notebooks/instances/upgrade @@ -6,7 +6,10 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for upgrading notebook instances. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for upgrading notebook instances. EXAMPLES To upgrade an instance, run: diff --git a/gcloud/beta/notebooks/locations/help b/gcloud/beta/notebooks/locations/help index 811ce01ae..b3b380f3e 100644 --- a/gcloud/beta/notebooks/locations/help +++ b/gcloud/beta/notebooks/locations/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud beta notebooks locations COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) View locations available for a project. + (BETA) (DEPRECATED) View locations available for a project. + + This command is deprecated. Please use gcloud notebooks instead. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,7 +18,7 @@ COMMANDS COMMAND is one of the following: list - (BETA) Request for listing locations. + (BETA) (DEPRECATED) Request for listing locations. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/notebooks/locations/list b/gcloud/beta/notebooks/locations/list index 258dc81cb..c7eb36480 100644 --- a/gcloud/beta/notebooks/locations/list +++ b/gcloud/beta/notebooks/locations/list @@ -7,7 +7,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Request for listing locations. + (BETA) (DEPRECATED) This command is deprecated. Please use gcloud notebooks + instead. + + Request for listing locations. EXAMPLES To list locations, run: $ gcloud beta notebooks locations list diff --git a/gcloud/beta/run/deploy b/gcloud/beta/run/deploy index b8270079a..9fdec6759 100644 --- a/gcloud/beta/run/deploy +++ b/gcloud/beta/run/deploy @@ -353,7 +353,7 @@ FLAGS details. The location can be a directory on a local disk or a gzipped archive file (.tar.gz) in Google Cloud Storage. If the source is a local directory, this command skips the files specified in the - --ignore-file. If --ignore-file is not specified, use.gcloudignore + --ignore-file. If --ignore-file is not specified, use .gcloudignore file. If a .gcloudignore file is absent and a .gitignore file is present in the local source directory, gcloud will use a generated Git-compatible .gcloudignore file that respects your .gitignored diff --git a/gcloud/beta/run/jobs/create b/gcloud/beta/run/jobs/create index 4d88e296f..eed8dbe06 100644 --- a/gcloud/beta/run/jobs/create +++ b/gcloud/beta/run/jobs/create @@ -1,5 +1,5 @@ NAME - gcloud beta run jobs create - deploy a new job to Cloud Run + gcloud beta run jobs create - create a Cloud Run job SYNOPSIS gcloud beta run jobs create [JOB] --image=IMAGE [--args=[ARG,...]] @@ -17,7 +17,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Deploys a new job to Google Cloud Run. + (BETA) Creates a new Cloud Run job. EXAMPLES To deploy a new job my-data-transformation on Cloud Run: diff --git a/gcloud/beta/run/jobs/deploy b/gcloud/beta/run/jobs/deploy new file mode 100644 index 000000000..b20d7e2e9 --- /dev/null +++ b/gcloud/beta/run/jobs/deploy @@ -0,0 +1,226 @@ +NAME + gcloud beta run jobs deploy - create or update a Cloud Run job + +SYNOPSIS + gcloud beta run jobs deploy [JOB] [--args=[ARG,...]] + [--binary-authorization=POLICY] [--breakglass=JUSTIFICATION] + [--command=[COMMAND,...]] [--cpu=CPU] [--execute-now] [--key=KEY] + [--labels=[KEY=VALUE,...]] [--max-retries=MAX_RETRIES] + [--memory=MEMORY] [--parallelism=PARALLELISM] [--region=REGION] + [--service-account=SERVICE_ACCOUNT] + [--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]] + [--set-secrets=[KEY=SECRET_NAME:SECRET_VERSION,...]] + [--task-timeout=TASK_TIMEOUT] [--tasks=TASKS; default=1] + [--vpc-connector=VPC_CONNECTOR] [--vpc-egress=VPC_EGRESS] + [--async | --wait] + [--clear-env-vars | --env-vars-file=FILE_PATH + | --set-env-vars=[KEY=VALUE,...] + | --remove-env-vars=[KEY,...] --update-env-vars=[KEY=VALUE,...]] + [--image=IMAGE | --source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Creates or updates a Cloud Run job. + +EXAMPLES + To deploy a new job my-data-transformation to Cloud Run: + + $ gcloud beta run jobs deploy my-data-transformation \ + --image=us-docker.pkg.dev/project/image + + You may also omit the job name. Then a prompt will be displayed with a + suggested default value: + + $ gcloud beta run jobs deploy --image=us-docker.pkg.dev/project/image + +POSITIONAL ARGUMENTS + Job resource - Job to deploy. 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 JOB on the command line with a fully specified + name; + ◆ specify the job name from an interactive prompt with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + [JOB] + ID of the Job or fully qualified identifier for the Job. To set the + jobs attribute: + ▸ provide the argument JOB on the command line; + ▸ specify the job name from an interactive prompt. + +FLAGS + --args=[ARG,...] + Comma-separated arguments passed to the command run by the container + image. If not specified and no '--command' is provided, the container + image's default Cmd is used. Otherwise, if not specified, no arguments + are passed. To reset this field to its default, pass an empty string. + + --binary-authorization=POLICY + Binary Authorization policy to check against. This must be set to + "default". + + --breakglass=JUSTIFICATION + Justification to bypass Binary Authorization policy constraints and + allow the operation. See + https://cloud.google.com/binary-authorization/docs/using-breakglass for + more information. Next update or deploy command will automatically + clear existing breakglass justification. + + --command=[COMMAND,...] + Entrypoint for the container image. If not specified, the container + image's default Entrypoint is run. To reset this field to its default, + pass an empty string. + + --cpu=CPU + Set a CPU limit in Kubernetes cpu units. + + Cloud Run (fully managed) supports values 1, 2 and 4. For Cloud Run + (fully managed), 4 cpus also requires a minimum 2Gi --memory value. + Examples 2, 2.0, 2000m + + --execute-now + Execute the job immediately after creation. + + --key=KEY + CMEK key reference to encrypt the container with. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + --max-retries=MAX_RETRIES + Number of times a task is allowed to restart in case of failure before + being failed permanently. This applies per-task, not per-job. If set to + 0, tasks will only run once and never be retried on failure. + + --memory=MEMORY + Set a memory limit. Ex: 1024Mi, 4Gi. + + --parallelism=PARALLELISM + Number of tasks that may run concurrently. Must be less than or equal + to the number of tasks. Set to 0 to unset. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + --service-account=SERVICE_ACCOUNT + Service account associated with the revision of the service. The + service account represents the identity of the running revision, and + determines what permissions the revision has. This is the email address + of an IAM service account. + + --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...] + You can specify a name of a Cloud SQL instance if it's in the same + project and region as your Cloud Run resource; otherwise specify + :: for the instance. + + --set-secrets=[KEY=SECRET_NAME:SECRET_VERSION,...] + Specify secrets to provide as environment variables. For example: + '--set-secrets=ENV=mysecret:latest,OTHER_ENV=othersecret:1' will create + an environment variable named ENV whose value is the latest version of + secret 'mysecret' and an environment variable OTHER_ENV whose value is + version of 1 of secret 'othersecret'. + + --task-timeout=TASK_TIMEOUT + Set the maximum time (deadline) a job task attempt can run for. In the + case of retries, this deadline applies to each attempt of a task. If + the task attempt does not complete within this time, it will be killed. + It is specified as a duration; for example, "10m5s" is ten minutes, and + five seconds. If you don't specify a unit, seconds is assumed. For + example, "10" is 10 seconds. + + --tasks=TASKS; default=1 + Number of tasks that must run to completion for the job to be + considered done. Use this flag to trigger multiple runs of the job. + + --vpc-connector=VPC_CONNECTOR + Set a VPC connector for this resource. + + --vpc-egress=VPC_EGRESS + The outbound traffic to send through the VPC connector for this + resource. This resource must have a VPC connector to set VPC egress. + VPC_EGRESS must be one of: + + all + (DEPRECATED) Sends all outbound traffic through the VPC connector. + Provides the same functionality as 'all-traffic'. Prefer to use + 'all-traffic' instead. + all-traffic + Sends all outbound traffic through the VPC connector. + private-ranges-only + Default option. Sends outbound traffic to private IP addresses + defined by RFC1918 through the VPC connector. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --wait + Wait until the execution has completed running before exiting. If not + set, gcloud exits successfully when the execution has started. + Implies --execute-now. + + At most one of these can be specified: + + --clear-env-vars + Remove all environment variables. + + --env-vars-file=FILE_PATH + Path to a local YAML file with definitions for all environment + variables. All existing environment variables will be removed before + the new environment variables are added. Example YAML content: + + KEY_1: "value1" + KEY_2: "value 2" + + --set-env-vars=[KEY=VALUE,...] + List of key-value pairs to set as environment variables. All existing + environment variables will be removed first. + + Only --update-env-vars and --remove-env-vars can be used together. If + both are specified, --remove-env-vars will be applied first. + + --remove-env-vars=[KEY,...] + List of environment variables to be removed. + + --update-env-vars=[KEY=VALUE,...] + List of key-value pairs to set as environment variables. + + At most one of these can be specified: + + --image=IMAGE + Name of the container image to deploy (e.g. + us-docker.pkg.dev/cloudrun/container/job:latest). + + --source=SOURCE + The location of the source to build. If a Dockerfile is present in + the source code directory, it will be built using that Dockerfile, + otherwise it will use Google Cloud buildpacks. See + https://cloud.google.com/run/docs/deploying-source-code for more + details. The location can be a directory on a local disk or a gzipped + archive file (.tar.gz) in Google Cloud Storage. If the source is a + local directory, this command skips the files specified in the + --ignore-file. If --ignore-file is not specified, use .gcloudignore + file. If a .gcloudignore file is absent and a .gitignore file is + present in the local source directory, gcloud will use a generated + Git-compatible .gcloudignore file that respects your .gitignored + files. The global .gitignore is not respected. For more information + on .gcloudignore, see gcloud topic gcloudignore. + +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 beta and might change without notice. This + variant is also available: + + $ gcloud alpha run jobs deploy + diff --git a/gcloud/beta/run/jobs/help b/gcloud/beta/run/jobs/help index 5f838259a..3e49b1078 100644 --- a/gcloud/beta/run/jobs/help +++ b/gcloud/beta/run/jobs/help @@ -40,11 +40,14 @@ COMMANDS (BETA) Add IAM policy binding to a Cloud Run job. create - (BETA) Deploy a new job to Cloud Run. + (BETA) Create a Cloud Run job. delete (BETA) Delete a job. + deploy + (BETA) Create or update a Cloud Run job. + describe (BETA) Obtain details about jobs. @@ -61,7 +64,7 @@ COMMANDS (BETA) Remove IAM policy binding of a Cloud Run job. replace - (BETA) Creates or replaces a job from a YAML Job specification. + (BETA) Create or replace a job from a YAML job specification. set-iam-policy (BETA) Set the IAM policy for a job. diff --git a/gcloud/beta/run/jobs/replace b/gcloud/beta/run/jobs/replace index 751e7cb63..696e15695 100644 --- a/gcloud/beta/run/jobs/replace +++ b/gcloud/beta/run/jobs/replace @@ -1,5 +1,5 @@ NAME - gcloud beta run jobs replace - creates or replaces a job from a YAML Job + gcloud beta run jobs replace - create or replace a job from a YAML job specification SYNOPSIS @@ -7,10 +7,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Creates or replaces a job from a YAML Job specification. + (BETA) Creates or replaces a job from a YAML job specification. EXAMPLES - To replace the specification for myjob + To replace the specification for a job defined in myjob.yaml $ gcloud beta run jobs replace myjob.yaml diff --git a/gcloud/beta/run/services/help b/gcloud/beta/run/services/help index 458e41f9d..6d5d20e59 100644 --- a/gcloud/beta/run/services/help +++ b/gcloud/beta/run/services/help @@ -132,7 +132,7 @@ COMMANDS (BETA) Remove IAM policy binding of a Cloud Run service. replace - (BETA) Creates or replaces a service from a YAML Service specification. + (BETA) Create or replace a service from a YAML service specification. set-iam-policy (BETA) Set the IAM policy for a service. diff --git a/gcloud/beta/run/services/replace b/gcloud/beta/run/services/replace index e615b66d7..504a6aa73 100644 --- a/gcloud/beta/run/services/replace +++ b/gcloud/beta/run/services/replace @@ -1,6 +1,6 @@ NAME - gcloud beta run services replace - creates or replaces a service from a - YAML Service specification + gcloud beta run services replace - create or replace a service from a YAML + service specification SYNOPSIS gcloud beta run services replace FILE [--async] [--namespace=NAMESPACE] @@ -10,10 +10,10 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Creates or replaces a service from a YAML Service specification. + (BETA) Creates or replaces a service from a YAML service specification. EXAMPLES - To replace the specification for myservice + To replace the specification for a service defined in myservice.yaml $ gcloud beta run services replace myservice.yaml diff --git a/gcloud/compute/commitments/create b/gcloud/compute/commitments/create index 3b47c3010..50f99bf0b 100644 --- a/gcloud/compute/commitments/create +++ b/gcloud/compute/commitments/create @@ -96,9 +96,10 @@ OPTIONAL FLAGS --type=TYPE; default="general-purpose" Type of commitment. memory-optimized indicates that the commitment is for memory-optimized VMs. TYPE must be one of: accelerator-optimized, - compute-optimized, compute-optimized-c2d, general-purpose, - general-purpose-e2, general-purpose-n2, general-purpose-n2d, - general-purpose-t2d, memory-optimized, memory-optimized-m3. + compute-optimized, compute-optimized-c2d, compute-optimized-c3, + general-purpose, general-purpose-e2, general-purpose-n2, + general-purpose-n2d, general-purpose-t2d, memory-optimized, + memory-optimized-m3. Manage the reservations to be created with the commitment. diff --git a/gcloud/compute/help b/gcloud/compute/help index e95ba48ab..53705a750 100644 --- a/gcloud/compute/help +++ b/gcloud/compute/help @@ -90,6 +90,9 @@ GROUPS machine-types Read Compute Engine virtual machine types. + network-attachments + Manage Compute Engine network attachment resources. + network-edge-security-services Read and manipulate network edge security services. diff --git a/gcloud/compute/instance-groups/managed/set-autoscaling b/gcloud/compute/instance-groups/managed/set-autoscaling index b4ef99fbb..0cda3580a 100644 --- a/gcloud/compute/instance-groups/managed/set-autoscaling +++ b/gcloud/compute/instance-groups/managed/set-autoscaling @@ -235,8 +235,14 @@ OPTIONAL FLAGS autoscaler scales the group to have at least as many VMs as defined by the minimum required instances. After the configured duration, if there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after the + scaling schedule ends. --schedule-min-required-replicas=MIN_REQUIRED_REPLICAS How many VMs the autoscaler should provision for the duration of this diff --git a/gcloud/compute/instance-groups/managed/set-instance-template b/gcloud/compute/instance-groups/managed/set-instance-template index 7eb6b6b17..f840216bb 100644 --- a/gcloud/compute/instance-groups/managed/set-instance-template +++ b/gcloud/compute/instance-groups/managed/set-instance-template @@ -22,6 +22,15 @@ DESCRIPTION ▪ Use the rolling-action start-update command. ▪ Use the API to set the group's updatePolicy.type to PROACTIVE. +EXAMPLES + Running: + + gcloud compute instance-groups managed set-instance-template \ + example-managed-instance-group --template=example-global-instance-template + + Sets the group's instance template to a global instance template resource: + 'example-global-instance-template'. + POSITIONAL ARGUMENTS NAME Name of the managed instance group to operate on. diff --git a/gcloud/compute/instance-groups/managed/update-autoscaling b/gcloud/compute/instance-groups/managed/update-autoscaling index 76106fdd1..228435a36 100644 --- a/gcloud/compute/instance-groups/managed/update-autoscaling +++ b/gcloud/compute/instance-groups/managed/update-autoscaling @@ -130,10 +130,14 @@ FLAGS scaling schedule that is currently active the disabled scaling schedule stops being effective immediately after it moves into DISABLED state. If there is no need to maintain capacity, the - autoscaler starts removing instances after a 10-minute stabilization - period and (if configured) following scale-in controls. This ensures - you don't accidentally lose capacity immediately after the scaling - schedule ends. + autoscaler starts removing instances after the usual stabilization + period and after scale-in controls (if configured). For more + information, see Delays in scaling in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after + the scaling schedule ends. --enable-schedule=SCHEDULE_NAME Name of the scaling schedule to be enabled. @@ -150,9 +154,14 @@ FLAGS scaling schedule that is currently active, the deleted scaling schedule stops being effective immediately after it is deleted. If there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. This ensures you don't accidentally lose - capacity immediately after the scaling schedule ends. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after + the scaling schedule ends. --set-schedule=SCHEDULE_NAME A unique name for the scaling schedule to be configured. @@ -205,8 +214,14 @@ FLAGS autoscaler scales the group to have at least as many VMs as defined by the minimum required instances. After the configured duration, if there is no need to maintain capacity, the autoscaler starts removing - instances after a 10-minute stabilization period and (if configured) - following scale-in controls. + instances after the usual stabilization period and after scale-in + controls (if configured). For more information, see Delays in scaling + in + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#delays_in_scaling_in) + and Scale-in controls + (https://cloud.google.com/compute/docs/autoscaler/understanding-autoscaler-decisions#scale-in_controls). + This ensures you don't accidentally lose capacity immediately after the + scaling schedule ends. --schedule-min-required-replicas=MIN_REQUIRED_REPLICAS How many VMs the autoscaler should provision for the duration of this diff --git a/gcloud/compute/instance-templates/create b/gcloud/compute/instance-templates/create index cafb56ac7..8843ede15 100644 --- a/gcloud/compute/instance-templates/create +++ b/gcloud/compute/instance-templates/create @@ -556,10 +556,6 @@ FLAGS The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/compute/instance-templates/create-with-container b/gcloud/compute/instance-templates/create-with-container index 9e2fb8273..19e21f74a 100644 --- a/gcloud/compute/instance-templates/create-with-container +++ b/gcloud/compute/instance-templates/create-with-container @@ -515,10 +515,6 @@ FLAGS The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-tier=NETWORK_TIER Specifies the network tier that will be used to configure the instance. NETWORK_TIER must be one of: PREMIUM, STANDARD, FIXED_STANDARD. The diff --git a/gcloud/compute/instances/create b/gcloud/compute/instances/create index 5f8e704b2..db3c708fc 100644 --- a/gcloud/compute/instances/create +++ b/gcloud/compute/instances/create @@ -634,10 +634,6 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/compute/instances/create-with-container b/gcloud/compute/instances/create-with-container index 5bfd6ef27..361da7db6 100644 --- a/gcloud/compute/instances/create-with-container +++ b/gcloud/compute/instances/create-with-container @@ -565,10 +565,6 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. - network-attachment - Specifies the network attachment that this interface should connect - to. Mutually exclusive with --network and --subnet flags. - --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/compute/network-attachments/create b/gcloud/compute/network-attachments/create new file mode 100644 index 000000000..5b4eda451 --- /dev/null +++ b/gcloud/compute/network-attachments/create @@ -0,0 +1,101 @@ +NAME + gcloud compute network-attachments create - create a Google Compute Engine + network attachment + +SYNOPSIS + gcloud compute network-attachments create NAME + --subnets=SUBNETS,[SUBNETS,...] + [--connection-preference=CONNECTION_PREFERENCE; + default="ACCEPT_AUTOMATIC"] [--description=DESCRIPTION] + [--producer-accept-list=[ACCEPT_LIST,...]] + [--producer-reject-list=[REJECT_LIST,...]] [--region=REGION] + [--subnets-region=SUBNETS_REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + gcloud compute network-attachments create is used to create network + attachments. A service consumer creates network attachments and makes it + available to producers. Service producers then use a multi-NIC VM to form a + bi-directional, non-NAT'd communication channel. + +EXAMPLES + $ gcloud compute network-attachments create \ + NETWORK_ATTACHMENT_NAME --region=us-central1 \ + --subnets=MY_SUBNET --connection-preference=ACCEPT_MANUAL \ + --producer-accept-list=PROJECT1,PROJECT2 \ + --producer-reject-list=PROJECT3,PROJECT4 + + To create a network attachment with a textual description, run: + + $ gcloud compute network-attachments create \ + NETWORK_ATTACHMENT_NAME --region=us-central1 \ + --subnets=MY_SUBNET --connection-preference=ACCEPT_MANUAL \ + --producer-accept-list=PROJECT1,PROJECT2 \ + --producer-reject-list=PROJECT3,PROJECT4 \ + --description='default network attachment' + +POSITIONAL ARGUMENTS + NAME + Name of the network attachment to create. + +REQUIRED FLAGS + --subnets=SUBNETS,[SUBNETS,...] + The subnetworks provided by the consumer for the producers + +OPTIONAL FLAGS + --connection-preference=CONNECTION_PREFERENCE; default="ACCEPT_AUTOMATIC" + The connection preference of network attachment. The value can be set + to ACCEPT_AUTOMATIC or ACCEPT_MANUAL. An ACCEPT_AUTOMATIC network + attachment is one that always accepts the connection from producer NIC. + An ACCEPT_MANUAL network attachment is one that requires an explicit + addition of the producer project id or project number to the producer + accept list. CONNECTION_PREFERENCE must be one of: ACCEPT_AUTOMATIC, + ACCEPT_MANUAL. + + --description=DESCRIPTION + An optional, textual description for the network attachment. + + --producer-accept-list=[ACCEPT_LIST,...] + Projects that are allowed to connect to this network attachment. + + --producer-reject-list=[REJECT_LIST,...] + Projects that are not allowed to connect to this network attachment. + + --region=REGION + Region of the network attachment to create. If not specified, you might + be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --subnets-region=SUBNETS_REGION + Region of the subnetworks to operate on. Overrides the default + compute/region property value for this command invocation. + +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 compute network-attachments create + + $ gcloud beta compute network-attachments create + diff --git a/gcloud/compute/network-attachments/delete b/gcloud/compute/network-attachments/delete new file mode 100644 index 000000000..9e707e279 --- /dev/null +++ b/gcloud/compute/network-attachments/delete @@ -0,0 +1,57 @@ +NAME + gcloud compute network-attachments delete - delete one or more Google + Compute Engine network attachments + +SYNOPSIS + gcloud compute network-attachments delete NAME [NAME ...] [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete one or more Google Compute Engine network attachments. + +EXAMPLES + To delete a network attachment, run: + + $ gcloud compute network-attachments delete \ + NETWORK_ATTACHMENT_NAME --region=us-central1 + +POSITIONAL ARGUMENTS + NAME [NAME ...] + Names of the network attachments to delete. + +FLAGS + --region=REGION + Region of the network attachments to delete. If not specified, you + might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + +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 compute network-attachments delete + + $ gcloud beta compute network-attachments delete + diff --git a/gcloud/compute/network-attachments/describe b/gcloud/compute/network-attachments/describe new file mode 100644 index 000000000..f099ea601 --- /dev/null +++ b/gcloud/compute/network-attachments/describe @@ -0,0 +1,57 @@ +NAME + gcloud compute network-attachments describe - describes a Google Compute + Engine network attachment + +SYNOPSIS + gcloud compute network-attachments describe NAME [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describes a Google Compute Engine network attachment. + +EXAMPLES + To describe a network attachment, run: + + $ gcloud compute network-attachments describe \ + NETWORK_ATTACHMENT_NAME --region=us-central1 + +POSITIONAL ARGUMENTS + NAME + Name of the network attachment to describe. + +FLAGS + --region=REGION + Region of the network attachment to describe. If not specified, you + might be prompted to select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + +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 compute network-attachments describe + + $ gcloud beta compute network-attachments describe + diff --git a/gcloud/compute/network-attachments/help b/gcloud/compute/network-attachments/help new file mode 100644 index 000000000..99e496e19 --- /dev/null +++ b/gcloud/compute/network-attachments/help @@ -0,0 +1,37 @@ +NAME + gcloud compute network-attachments - manage Compute Engine network + attachment resources + +SYNOPSIS + gcloud compute network-attachments COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List, create, describe, update and delete network attachments. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Google Compute Engine network attachment. + + delete + Delete one or more Google Compute Engine network attachments. + + describe + Describes a Google Compute Engine network attachment. + + list + List Google Compute Engine network attachments. + +NOTES + These variants are also available: + + $ gcloud alpha compute network-attachments + + $ gcloud beta compute network-attachments + diff --git a/gcloud/compute/network-attachments/list b/gcloud/compute/network-attachments/list new file mode 100644 index 000000000..ff897e909 --- /dev/null +++ b/gcloud/compute/network-attachments/list @@ -0,0 +1,88 @@ +NAME + gcloud compute network-attachments list - list Google Compute Engine + network attachments + +SYNOPSIS + gcloud compute network-attachments list [NAME ...] + [--regexp=REGEXP, -r REGEXP] [--regions=REGION,[REGION,...]] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Google Compute Engine network attachments. + +EXAMPLES + To list all the network attachments, run: + + $ gcloud compute network-attachments list + + To list the network attachments in given region(s), run: + + $ gcloud compute network-attachments list --regions=region-1,region-2 + +POSITIONAL ARGUMENTS + [NAME ...] + (DEPRECATED) If provided, show details for the specified names and/or + URIs of resources. + + Argument NAME is deprecated. Use --filter="name=( 'NAME' ... )" + instead. + +FLAGS + --regexp=REGEXP, -r REGEXP + (DEPRECATED) Regular expression to filter the names of the results on. + Any names that do not match the entire regular expression will be + filtered out. + + Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. + + --regions=REGION,[REGION,...] + If provided, only resources from the given regions are queried. + +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 compute network-attachments list + + $ gcloud beta compute network-attachments list + diff --git a/gcloud/container/azure/clients/create b/gcloud/container/azure/clients/create index 9bdd1cb4e..ba3f864e7 100644 --- a/gcloud/container/azure/clients/create +++ b/gcloud/container/azure/clients/create @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud container azure clients create (CLIENT : --location=LOCATION) - --application-id=APP_ID --tenant-id=TENANT_ID [--validate-only] - [GCLOUD_WIDE_FLAG ...] + --application-id=APP_ID --tenant-id=TENANT_ID [--async] + [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create an Azure client. @@ -52,6 +52,10 @@ REQUIRED FLAGS client. OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --validate-only Validate the creation of the client, but don't actually perform it. diff --git a/gcloud/container/azure/clients/delete b/gcloud/container/azure/clients/delete index 387c62eb8..db49232d4 100644 --- a/gcloud/container/azure/clients/delete +++ b/gcloud/container/azure/clients/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud container azure clients delete (CLIENT : --location=LOCATION) - [--allow-missing] [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete an Azure client. @@ -45,6 +45,10 @@ FLAGS Allow idempotent deletion of cluster. The request will still succeed in case the cluster does not exist. + --async + Return immediately, without waiting for the operation in progress to + complete. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/container/fleet/memberships/register b/gcloud/container/fleet/memberships/register index 28198c66c..8ebefeae4 100644 --- a/gcloud/container/fleet/memberships/register +++ b/gcloud/container/fleet/memberships/register @@ -45,72 +45,73 @@ DESCRIPTION avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific + kubeconfig file, and install the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE URI: + Register a GKE cluster referenced from a GKE URI: $ gcloud container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect agent using service account key file: $ gcloud container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster first, and install the Connect agent later. + Register a GKE cluster first, and install the Connect agent later. $ gcloud container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --enable-workload-identity + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity - Register a GKE cluster, and install a specific version of the Connect - agent: + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=20220819-00-00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=20220819-00-00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install the - Connect agent: + Register a GKE cluster and output a manifest that can be used to install + the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME diff --git a/gcloud/container/hub/memberships/register b/gcloud/container/hub/memberships/register index 9f7f6b763..eac1b711e 100644 --- a/gcloud/container/hub/memberships/register +++ b/gcloud/container/hub/memberships/register @@ -44,72 +44,73 @@ DESCRIPTION avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific + kubeconfig file, and install the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE URI: + Register a GKE cluster referenced from a GKE URI: $ gcloud container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect agent using service account key file: $ gcloud container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster first, and install the Connect agent later. + Register a GKE cluster first, and install the Connect agent later. $ gcloud container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --enable-workload-identity + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity - Register a GKE cluster, and install a specific version of the Connect - agent: + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=20220819-00-00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=20220819-00-00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install the - Connect agent: + Register a GKE cluster and output a manifest that can be used to install + the Connect agent: $ gcloud container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri --install-connect-agent \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME diff --git a/gcloud/edge-cloud/container/vpn-connections/create b/gcloud/edge-cloud/container/vpn-connections/create index 721099922..7a9de3eb1 100644 --- a/gcloud/edge-cloud/container/vpn-connections/create +++ b/gcloud/edge-cloud/container/vpn-connections/create @@ -7,7 +7,7 @@ SYNOPSIS (VPN_CONNECTION : --location=LOCATION) --cluster=CLUSTER --vpc-network=VPC_NETWORK [--async] [--high-availability] [--labels=[KEY=VALUE,...]] [--nat-gateway-ip=NAT_GATEWAY_IP] - [GCLOUD_WIDE_FLAG ...] + [--vpc-project=VPC_PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Creates a new VPN connection. @@ -81,6 +81,10 @@ OPTIONAL FLAGS The NAT gateway IP for the gateway floating IPs. Required if cluster sits behind NAT. + --vpc-project=VPC_PROJECT + The project of the VPC network. Required if the project of VPC network + differs from the project of the cluster. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firebase/test/android/help b/gcloud/firebase/test/android/help index aac446005..409532340 100644 --- a/gcloud/firebase/test/android/help +++ b/gcloud/firebase/test/android/help @@ -63,6 +63,9 @@ GROUPS COMMANDS COMMAND is one of the following: + list-device-capacities + List capacity information for Android models & versions. + run Invoke a test in Firebase Test Lab for Android and view test results. diff --git a/gcloud/alpha/firebase/test/ios/list-device-capacities b/gcloud/firebase/test/android/list-device-capacities similarity index 66% rename from gcloud/alpha/firebase/test/ios/list-device-capacities rename to gcloud/firebase/test/android/list-device-capacities index 264fee575..7d706d226 100644 --- a/gcloud/alpha/firebase/test/ios/list-device-capacities +++ b/gcloud/firebase/test/android/list-device-capacities @@ -1,35 +1,35 @@ NAME - gcloud alpha firebase test ios list-device-capacities - list capacity - information for all supported iOS models & versions + gcloud firebase test android list-device-capacities - list capacity + information for Android models & versions SYNOPSIS - gcloud alpha firebase test ios list-device-capacities [--filter=EXPRESSION] + gcloud firebase test android list-device-capacities [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List device capacity (high/medium/low/none) for all iOS models & - versions. + List device capacity information (high/medium/low/none) for all Android + models & versions which are available for testing and have capacity + information published. Device capacity is the number of online devices in Firebase Test Lab. For physical devices, the number is the average of online devices in the last 30 days. It's important to note that device capacity does not directly - reflect any real-time data, like the length of the test queue, traffic, or - the available/busy state of the devices. + reflect any real-time data, like the length of the test queue, or the + available/busy state of the devices based on current test traffic. EXAMPLES - To list capacity information for all online devices which are available for - testing, run: + To list all published capacity information for Android devices, run: - $ gcloud alpha firebase test ios list-device-capacities + $ gcloud firebase test android list-device-capacities - To list capacity for only ipad devices, run: + To list capacity only for the model named 'redfin', run: - $ gcloud alpha firebase test ios list-device-capacities --filter=ipad + $ gcloud firebase test android list-device-capacities --filter=redfin - To list capacity for only iOS version 14.2 devices, run: + To list capacities only for models that support API version 30, run: - $ gcloud alpha firebase test ios list-device-capacities --filter=14.2 + $ gcloud firebase test android list-device-capacities --filter=30 LIST COMMAND FLAGS --filter=EXPRESSION @@ -64,10 +64,3 @@ GCLOUD WIDE FLAGS --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. - diff --git a/gcloud/firebase/test/android/run b/gcloud/firebase/test/android/run index fe41f3f55..1c9636ed0 100644 --- a/gcloud/firebase/test/android/run +++ b/gcloud/firebase/test/android/run @@ -420,7 +420,7 @@ DEPRECATED DEVICE DIMENSIONS FLAGS --device-ids=MODEL_ID,[MODEL_ID,...], -d MODEL_ID,[MODEL_ID,...] The list of MODEL_IDs to test against (default: one device model determined by the Firebase Test Lab device catalog; see TAGS listed by - the $ gcloud firebase test android devices list command). + the $ gcloud firebase test android models list command). --locales=LOCALE,[LOCALE,...], -l LOCALE,[LOCALE,...] The list of LOCALEs to test against (default: a single locale diff --git a/gcloud/firebase/test/ios/help b/gcloud/firebase/test/ios/help index 47aef93fa..aa283ac42 100644 --- a/gcloud/firebase/test/ios/help +++ b/gcloud/firebase/test/ios/help @@ -50,6 +50,9 @@ GROUPS COMMANDS COMMAND is one of the following: + list-device-capacities + List capacity information for iOS models & versions. + run Invoke a test in Firebase Test Lab for iOS and view test results. diff --git a/gcloud/alpha/firebase/test/android/list-device-capacities b/gcloud/firebase/test/ios/list-device-capacities similarity index 62% rename from gcloud/alpha/firebase/test/android/list-device-capacities rename to gcloud/firebase/test/ios/list-device-capacities index ed09186b1..c8df580fa 100644 --- a/gcloud/alpha/firebase/test/android/list-device-capacities +++ b/gcloud/firebase/test/ios/list-device-capacities @@ -1,37 +1,35 @@ NAME - gcloud alpha firebase test android list-device-capacities - list capacity - information for all supported Android models & versions + gcloud firebase test ios list-device-capacities - list capacity information + for iOS models & versions SYNOPSIS - gcloud alpha firebase test android list-device-capacities - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + gcloud firebase test ios list-device-capacities [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List device capacity (high/medium/low/none) for all Android models - & versions. + List device capacity information (high/medium/low/none) for all iOS models + & versions which are available for testing and have capacity information + published. Device capacity is the number of online devices in Firebase Test Lab. For physical devices, the number is the average of online devices in the last 30 days. It's important to note that device capacity does not directly - reflect any real-time data, like the length of the test queue, traffic, or - the available/busy state of the devices. + reflect any real-time data, like the length of the test queue, or the + available/busy state of the devices based on current test traffic. EXAMPLES - To list capacity information for all online devices which are available for - testing, run: + To list all published capacity information for iOS devices, run: - $ gcloud alpha firebase test android list-device-capacities + $ gcloud firebase test ios list-device-capacities - To list capacity only for model named redfin, run: + To list capacities for only iPad devices, run: - $ gcloud alpha firebase test android list-device-capacities \ - --filter=redfin + $ gcloud firebase test ios list-device-capacities --filter=ipad - To list capacity only for API version 30, run: + To list capacities for only iOS version 14.2 devices, run: - $ gcloud alpha firebase test android list-device-capacities \ - --filter=30 + $ gcloud firebase test ios list-device-capacities --filter=14.2 LIST COMMAND FLAGS --filter=EXPRESSION @@ -66,10 +64,3 @@ GCLOUD WIDE FLAGS --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. - diff --git a/gcloud/iam/help b/gcloud/iam/help index 9d77a1607..5c38afd24 100644 --- a/gcloud/iam/help +++ b/gcloud/iam/help @@ -40,6 +40,9 @@ GROUPS Understand how an IAM policy change could impact access before deploying the change. + workforce-pools + Create and manage workforce pools. + workload-identity-pools Manage IAM workload identity pools. diff --git a/gcloud/iam/workforce-pools/create b/gcloud/iam/workforce-pools/create new file mode 100644 index 000000000..ed2e8dcbb --- /dev/null +++ b/gcloud/iam/workforce-pools/create @@ -0,0 +1,92 @@ +NAME + gcloud iam workforce-pools create - create a new workforce pool under an + organization + +SYNOPSIS + gcloud iam workforce-pools create (WORKFORCE_POOL : --location=LOCATION) + --organization=ORGANIZATION [--async] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] + [--session-duration=SESSION_DURATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Creates a workforce pool under an organization given a valid organization + ID. + +EXAMPLES + The following command creates a workforce pool with ID my-workforce-pool in + the organization 12345: + + $ gcloud iam workforce-pools create my-workforce-pool \ + --organization=12345 + + The following command creates a workforce pool with ID my-workforce-pool + with explicit values for all required and optional parameters: + + $ gcloud iam workforce-pools create my-workforce-pool \ + --organization=12345 --location=global \ + --display-name="My Workforce Pool" \ + --description="My workforce pool + description." --session-duration="7200s" --disabled + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to create. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +REQUIRED FLAGS + --organization=ORGANIZATION + The parent organization of the workforce pool to create. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description for the workforce pool. Cannot exceed 256 characters in + length. + + --disabled + Whether or not the workforce pool is disabled. + + --display-name=DISPLAY_NAME + A display name for the workforce pool. Cannot exceed 32 characters in + length. + + --session-duration=SESSION_DURATION + How long the Google Cloud access tokens, console sign-in sessions, and + gcloud sign-in sessions from this workforce pool are valid. Must be + greater than 15 minutes (900s) and less than 12 hours (43200s). If not + configured, minted credentials will have a default duration of one hour + (3600s). + +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 iam workforce-pools create + + $ gcloud beta iam workforce-pools create + diff --git a/gcloud/iam/workforce-pools/create-cred-config b/gcloud/iam/workforce-pools/create-cred-config new file mode 100644 index 000000000..2467dd32f --- /dev/null +++ b/gcloud/iam/workforce-pools/create-cred-config @@ -0,0 +1,143 @@ +NAME + gcloud iam workforce-pools create-cred-config - create a configuration file + for generated credentials + +SYNOPSIS + gcloud iam workforce-pools create-cred-config AUDIENCE + --output-file=OUTPUT_FILE + --workforce-pool-user-project=WORKFORCE_POOL_USER_PROJECT + (--credential-source-file=CREDENTIAL_SOURCE_FILE + | --credential-source-url=CREDENTIAL_SOURCE_URL + | --executable-command=EXECUTABLE_COMMAND) + [--credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME] + [--credential-source-headers=[key=value,...]] + [--credential-source-type=CREDENTIAL_SOURCE_TYPE] + [--subject-token-type=SUBJECT_TOKEN_TYPE] + [--executable-interactive-timeout-millis=EXECUTABLE_INTERACTIVE_TIMEOUT_MILLIS --executable-output-file=EXECUTABLE_OUTPUT_FILE --executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS] + [--service-account=SERVICE_ACCOUNT + : --service-account-token-lifetime-seconds=SERVICE_ACCOUNT_TOKEN_LIFETIME_SECONDS] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + This command creates a configuration file to allow access to authenticated + Google Cloud actions from a variety of external user accounts. + +EXAMPLES + To create a file-sourced credential configuration for your project, run: + + $ gcloud iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --credential-source-file=$PATH_TO_OIDC_ID_TOKEN \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To create a URL-sourced credential configuration for your project, run: + + $ gcloud iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --credential-source-url=$URL_FOR_OIDC_TOKEN \ + --credential-source-headers=Key=Value \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To create an executable-source credential configuration for your project, + run the following command: + + $ gcloud iam workforce-pools create-cred-config \ + locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\ + $PROVIDER_ID --executable-command=$EXECUTABLE_COMMAND \ + --executable-timeout-millis=30000 \ + --executable-output-file=$CACHE_FILE \ + --workforce-pool-user-project=$PROJECT_NUMBER \ + --output-file=credentials.json + + To use the resulting file for any of these commands, set the + GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the + generated file. + +POSITIONAL ARGUMENTS + AUDIENCE + The workforce pool provider resource name. + +REQUIRED FLAGS + --output-file=OUTPUT_FILE + Location to store the generated credential configuration file. + + --workforce-pool-user-project=WORKFORCE_POOL_USER_PROJECT + The client project number used to identify the application (client + project) to the server when calling Google APIs. The user principal + must have serviceusage.services.use IAM permission to use the specified + project. + + Credential types. + + Exactly one of these must be specified: + + --credential-source-file=CREDENTIAL_SOURCE_FILE + The location of the file which stores the credential. + + --credential-source-url=CREDENTIAL_SOURCE_URL + The URL to obtain the credential from. + + --executable-command=EXECUTABLE_COMMAND + The full command to run to retrieve the credential. Must be an + absolute path for the program including arguments. + +OPTIONAL FLAGS + --credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME + The subject token field name (key) in a JSON credential source. + + --credential-source-headers=[key=value,...] + Headers to use when querying the credential-source-url. + + --credential-source-type=CREDENTIAL_SOURCE_TYPE + The format of the credential source (JSON or text). + + --subject-token-type=SUBJECT_TOKEN_TYPE + The type of token being used for authorization. This defaults to + urn:ietf:params:oauth:token-type:id_token. + + Arguments for an executable type credential source. + + --executable-interactive-timeout-millis=EXECUTABLE_INTERACTIVE_TIMEOUT_MILLIS + The timeout duration, in milliseconds, to wait for the executable to + finish when the command is running in interactive mode. + + --executable-output-file=EXECUTABLE_OUTPUT_FILE + The absolute path to the file storing the executable response. + + --executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS + The timeout duration in milliseconds for waiting for the executable + to finish. + + Service account impersonation options. + + --service-account=SERVICE_ACCOUNT + The email of the service account to impersonate. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --service-account-token-lifetime-seconds=SERVICE_ACCOUNT_TOKEN_LIFETIME_SECONDS + The desired lifetime duration of the service account access token in + seconds. This defaults to one hour when not provided. If a lifetime + greater than one hour is required, the service account must be added + as an allowed value in an Organization Policy that enforces the + constraints/iam.allowServiceAccountCredentialLifetimeExtension + constraint. + +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 iam workforce-pools create-cred-config + + $ gcloud beta iam workforce-pools create-cred-config + diff --git a/gcloud/iam/workforce-pools/delete b/gcloud/iam/workforce-pools/delete new file mode 100644 index 000000000..eb637ef41 --- /dev/null +++ b/gcloud/iam/workforce-pools/delete @@ -0,0 +1,60 @@ +NAME + gcloud iam workforce-pools delete - delete a workforce pool + +SYNOPSIS + gcloud iam workforce-pools delete (WORKFORCE_POOL : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a workforce pool. + +EXAMPLES + The following command deletes a workforce pool with ID my-workforce-pool: + + $ gcloud iam workforce-pools delete my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to delete. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools delete + + $ gcloud beta iam workforce-pools delete + diff --git a/gcloud/iam/workforce-pools/describe b/gcloud/iam/workforce-pools/describe new file mode 100644 index 000000000..c05cecaa8 --- /dev/null +++ b/gcloud/iam/workforce-pools/describe @@ -0,0 +1,55 @@ +NAME + gcloud iam workforce-pools describe - describe a workforce pool + +SYNOPSIS + gcloud iam workforce-pools describe (WORKFORCE_POOL : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a workforce pool. + +EXAMPLES + The following command describes a workforce pool with ID my-workforce-pool: + + $ gcloud iam workforce-pools describe my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to describe. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools describe + + $ gcloud beta iam workforce-pools describe + diff --git a/gcloud/iam/workforce-pools/get-iam-policy b/gcloud/iam/workforce-pools/get-iam-policy new file mode 100644 index 000000000..6996cd587 --- /dev/null +++ b/gcloud/iam/workforce-pools/get-iam-policy @@ -0,0 +1,78 @@ +NAME + gcloud iam workforce-pools get-iam-policy - get the IAM policy for a + workforce pool + +SYNOPSIS + gcloud iam workforce-pools get-iam-policy + (WORKFORCE_POOL : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get the IAM policy for a workforce pool. + +EXAMPLES + The following command gets the IAM policy for the workforce pool with ID + my-workforce-pool: + + $ gcloud iam workforce-pools get-iam-policy my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool for which to display the IAM + policy. The arguments in this group can be used to specify the attributes + of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool on the command line with a + fully specified name; + ▸ 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/help b/gcloud/iam/workforce-pools/help new file mode 100644 index 000000000..8e9ad4b11 --- /dev/null +++ b/gcloud/iam/workforce-pools/help @@ -0,0 +1,64 @@ +NAME + gcloud iam workforce-pools - create and manage workforce pools + +SYNOPSIS + gcloud iam workforce-pools GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud iam workforce-pools group lets you create and manage workforce + pools for organizations on the Google Cloud Platform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + Manage IAM workforce pool long-running operations. + + providers + Create and manage workforce pool providers. + + subjects + Create and manage workforce pool subjects. + +COMMANDS + COMMAND is one of the following: + + create + Create a new workforce pool under an organization. + + create-cred-config + Create a configuration file for generated credentials. + + delete + Delete a workforce pool. + + describe + Describe a workforce pool. + + get-iam-policy + Get the IAM policy for a workforce pool. + + list + List the workforce pools for an organization. + + set-iam-policy + Set the IAM policy for a workforce pool. + + undelete + Undelete a workforce pool. + + update + Update a workforce pool. + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools + + $ gcloud beta iam workforce-pools + diff --git a/gcloud/iam/workforce-pools/list b/gcloud/iam/workforce-pools/list new file mode 100644 index 000000000..2db99879f --- /dev/null +++ b/gcloud/iam/workforce-pools/list @@ -0,0 +1,78 @@ +NAME + gcloud iam workforce-pools list - list the workforce pools for an + organization + +SYNOPSIS + gcloud iam workforce-pools list --location=LOCATION + --organization=ORGANIZATION [--show-deleted] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Lists all of the workforce pools for an organization given a valid + organization ID. + + This command can fail for the following reasons: + ▪ The organization specified does not exist. + ▪ The active account does not have permission to access the + organization. + +EXAMPLES + The following command lists the workforce pools for an organization with + the ID 12345, including soft-deleted pools: + + $ gcloud iam workforce-pools list --organization=12345 \ + --location=global --show-deleted + +REQUIRED FLAGS + --location=LOCATION + The location of the workforce pools to list. + + --organization=ORGANIZATION + The parent organization of the workforce pools to list. + +FLAGS + --show-deleted + Show soft-deleted workforce pools by specifying this flag. + +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. + +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 iam workforce-pools list + + $ gcloud beta iam workforce-pools list + diff --git a/gcloud/iam/workforce-pools/operations/describe b/gcloud/iam/workforce-pools/operations/describe new file mode 100644 index 000000000..e0a4a547c --- /dev/null +++ b/gcloud/iam/workforce-pools/operations/describe @@ -0,0 +1,71 @@ +NAME + gcloud iam workforce-pools operations describe - describe a workforce pool + operation + +SYNOPSIS + gcloud iam workforce-pools operations describe + (OPERATION : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a workforce pool operation. + +EXAMPLES + To describe the long-running workforce pool operation with the ID + my-operation, run: + + $ gcloud iam workforce-pools operations describe my-operation \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool operation resource - The workforce pool long-running + operation to describe. The arguments in this group can be used to specify + the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool operation or fully qualified identifier for + the workforce pool operation. To set the operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools operations describe + + $ gcloud beta iam workforce-pools operations describe + diff --git a/gcloud/iam/workforce-pools/operations/help b/gcloud/iam/workforce-pools/operations/help new file mode 100644 index 000000000..00fdd29a4 --- /dev/null +++ b/gcloud/iam/workforce-pools/operations/help @@ -0,0 +1,28 @@ +NAME + gcloud iam workforce-pools operations - manage IAM workforce pool + long-running operations + +SYNOPSIS + gcloud iam workforce-pools operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing IAM workforce pool long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe a workforce pool operation. + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools operations + + $ gcloud beta iam workforce-pools operations + diff --git a/gcloud/iam/workforce-pools/providers/create-oidc b/gcloud/iam/workforce-pools/providers/create-oidc new file mode 100644 index 000000000..c8952b7ed --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/create-oidc @@ -0,0 +1,203 @@ +NAME + gcloud iam workforce-pools providers create-oidc - create a new OIDC + workforce pool provider + +SYNOPSIS + gcloud iam workforce-pools providers create-oidc + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + --attribute-mapping=[ATTRIBUTE_MAPPING,...] --client-id=CLIENT_ID + --issuer-uri=ISSUER_URI [--async] + [--attribute-condition=ATTRIBUTE_CONDITION] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new OIDC workforce pool provider. + +EXAMPLES + The following command creates a disabled OIDC workforce pool provider with + the ID my-workforce-pool-provider. Explicit values for all required and + optional parameters are provided. + + $ gcloud iam workforce-pools providers create-oidc \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" --client-id="client-id" \ + --issuer-uri="https://test-idp.com" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to create. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +REQUIRED FLAGS + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --client-id=CLIENT_ID + The OIDC client ID. This must match the audience claim of the JWT + issued by the identity provider. + + --issuer-uri=ISSUER_URI + The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers create-oidc + + $ gcloud beta iam workforce-pools providers create-oidc + diff --git a/gcloud/iam/workforce-pools/providers/create-saml b/gcloud/iam/workforce-pools/providers/create-saml new file mode 100644 index 000000000..9a6f76c7d --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/create-saml @@ -0,0 +1,193 @@ +NAME + gcloud iam workforce-pools providers create-saml - create a new SAML + workforce pool provider + +SYNOPSIS + gcloud iam workforce-pools providers create-saml + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + --idp-metadata-path=IDP_METADATA_PATH [--async] + [--attribute-condition=ATTRIBUTE_CONDITION] [--description=DESCRIPTION] + [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new SAML workforce pool provider. + +EXAMPLES + The following command creates a disabled SAML workforce pool provider with + the ID my-workforce-pool-provider. Explicit values for all required and + optional parameters are provided. + + $ gcloud iam workforce-pools providers create-saml \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" \ + --idp-metadata-path="path/to/metdata/file.xml" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to create. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +REQUIRED FLAGS + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --idp-metadata-path=IDP_METADATA_PATH + XML file with configuration metadata for the SAML identity provider. + The metadata file must follow the SAML 2.0 metadata specification + (https://www.oasis-open.org/committees/download.php/35391/sstc-saml-metadata-errata-2.0-wd-04-diff.pdf). + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/providers/delete b/gcloud/iam/workforce-pools/providers/delete new file mode 100644 index 000000000..4acda28f1 --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/delete @@ -0,0 +1,77 @@ +NAME + gcloud iam workforce-pools providers delete - delete a workforce pool + provider + +SYNOPSIS + gcloud iam workforce-pools providers delete + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a workforce pool provider. + +EXAMPLES + The following command deletes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud iam workforce-pools providers delete \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to delete. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers delete + + $ gcloud beta iam workforce-pools providers delete + diff --git a/gcloud/iam/workforce-pools/providers/describe b/gcloud/iam/workforce-pools/providers/describe new file mode 100644 index 000000000..7bee8768d --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/describe @@ -0,0 +1,72 @@ +NAME + gcloud iam workforce-pools providers describe - describe a workforce pool + provider + +SYNOPSIS + gcloud iam workforce-pools providers describe + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a workforce pool provider. + +EXAMPLES + The following command describes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud iam workforce-pools providers describe \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to + describe. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers describe + + $ gcloud beta iam workforce-pools providers describe + diff --git a/gcloud/iam/workforce-pools/providers/help b/gcloud/iam/workforce-pools/providers/help new file mode 100644 index 000000000..db5960c53 --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/help @@ -0,0 +1,56 @@ +NAME + gcloud iam workforce-pools providers - create and manage workforce pool + providers + +SYNOPSIS + gcloud iam workforce-pools providers GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud iam workforce-pools providers group lets you create and manage + workforce pool providers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + Manage IAM workforce pool provider long-running operations. + +COMMANDS + COMMAND is one of the following: + + create-oidc + Create a new OIDC workforce pool provider. + + create-saml + Create a new SAML workforce pool provider. + + delete + Delete a workforce pool provider. + + describe + Describe a workforce pool provider. + + list + List workforce pool providers. + + undelete + Undelete a workforce pool provider. + + update-oidc + Update an OIDC workforce pool provider. + + update-saml + Update a new SAML workforce pool provider. + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers + + $ gcloud beta iam workforce-pools providers + diff --git a/gcloud/iam/workforce-pools/providers/list b/gcloud/iam/workforce-pools/providers/list new file mode 100644 index 000000000..cd9ed9db8 --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/list @@ -0,0 +1,90 @@ +NAME + gcloud iam workforce-pools providers list - list workforce pool providers + +SYNOPSIS + gcloud iam workforce-pools providers list + (--workforce-pool=WORKFORCE_POOL : --location=LOCATION) + [--show-deleted] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List workforce pool providers. + +EXAMPLES + The following command lists the workforce pool providers in the workforce + pool with ID my-workforce-pool, including soft-deleted pools: + + $ gcloud iam workforce-pools providers list \ + --workforce-pool="my-workforce-pool" --location="global" \ + --show-deleted + +REQUIRED FLAGS + Workforce pool resource - The parent workforce pool of the workforce pool + providers to list. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + --workforce-pool=WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce-pool attribute: + ▸ provide the argument --workforce-pool on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The location for the workforce pool. To set the location attribute: + ▸ provide the argument --workforce-pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --show-deleted + Show soft-deleted workforce pool providers by specifying this flag. + +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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers list + + $ gcloud beta iam workforce-pools providers list + diff --git a/gcloud/iam/workforce-pools/providers/operations/describe b/gcloud/iam/workforce-pools/providers/operations/describe new file mode 100644 index 000000000..0b8d2ae2b --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/operations/describe @@ -0,0 +1,86 @@ +NAME + gcloud iam workforce-pools providers operations describe - describe a + workforce pool provider operation + +SYNOPSIS + gcloud iam workforce-pools providers operations describe + (OPERATION : --location=LOCATION + --provider=PROVIDER --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a workforce pool provider operation. + +EXAMPLES + To describe the long-running workforce pool provider operation with the ID + my-operation, run: + + $ gcloud iam workforce-pools providers operations describe \ + my-operation --workforce-pool="my-workforce-pool" \ + --provider="my-provider" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider operation resource - The workforce pool provider + long-running operation to describe. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool provider operation or fully qualified + identifier for the workforce pool provider operation. To set the + operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --provider=PROVIDER + The ID to use for the workforce pool provider, which becomes the + final component of the resource name. This value must be unique + within the workforce pool, 4-32 characters in length, and may contain + the characters [a-z0-9-]. The prefix gcp- is reserved for use by + Google, and may not be specified. + + To set the provider attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --provider on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers operations describe + + $ gcloud beta iam workforce-pools providers operations describe + diff --git a/gcloud/iam/workforce-pools/providers/operations/help b/gcloud/iam/workforce-pools/providers/operations/help new file mode 100644 index 000000000..ea63fb3d9 --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/operations/help @@ -0,0 +1,29 @@ +NAME + gcloud iam workforce-pools providers operations - manage IAM workforce pool + provider long-running operations + +SYNOPSIS + gcloud iam workforce-pools providers operations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing IAM workforce pool provider long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe a workforce pool provider operation. + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers operations + + $ gcloud beta iam workforce-pools providers operations + diff --git a/gcloud/iam/workforce-pools/providers/undelete b/gcloud/iam/workforce-pools/providers/undelete new file mode 100644 index 000000000..57d8a5ce1 --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/undelete @@ -0,0 +1,77 @@ +NAME + gcloud iam workforce-pools providers undelete - undelete a workforce pool + provider + +SYNOPSIS + gcloud iam workforce-pools providers undelete + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Undelete a workforce pool provider. + +EXAMPLES + The following command undeletes a workforce pool provider with the ID + my-workforce-pool-provider: + + $ gcloud iam workforce-pools providers undelete \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to + undelete. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers undelete + + $ gcloud beta iam workforce-pools providers undelete + diff --git a/gcloud/iam/workforce-pools/providers/update-oidc b/gcloud/iam/workforce-pools/providers/update-oidc new file mode 100644 index 000000000..f82bfe8af --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/update-oidc @@ -0,0 +1,202 @@ +NAME + gcloud iam workforce-pools providers update-oidc - update an OIDC workforce + pool provider + +SYNOPSIS + gcloud iam workforce-pools providers update-oidc + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [--attribute-condition=ATTRIBUTE_CONDITION] + [--attribute-mapping=[ATTRIBUTE_MAPPING,...]] [--client-id=CLIENT_ID] + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [--issuer-uri=ISSUER_URI] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an OIDC workforce pool provider. + +EXAMPLES + The following command updates the OIDC workforce pool provider with the ID + my-workforce-pool-provider in the workforce pool my-workforce-pool. + Explicit values for all required and optional parameters are provided: + + $ gcloud iam workforce-pools providers update-oidc \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" --client-id="client-id" \ + --issuer-uri="https://test-idp.com" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to update. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --client-id=CLIENT_ID + The OIDC client ID. This must match the audience claim of the JWT + issued by the identity provider. + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + + --issuer-uri=ISSUER_URI + The OIDC issuer URI. Must be a valid URI using the 'https' scheme. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools providers update-oidc + + $ gcloud beta iam workforce-pools providers update-oidc + diff --git a/gcloud/iam/workforce-pools/providers/update-saml b/gcloud/iam/workforce-pools/providers/update-saml new file mode 100644 index 000000000..bfda1f0dc --- /dev/null +++ b/gcloud/iam/workforce-pools/providers/update-saml @@ -0,0 +1,192 @@ +NAME + gcloud iam workforce-pools providers update-saml - update a new SAML + workforce pool provider + +SYNOPSIS + gcloud iam workforce-pools providers update-saml + (PROVIDER : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [--attribute-condition=ATTRIBUTE_CONDITION] + [--attribute-mapping=[ATTRIBUTE_MAPPING,...]] + [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] + [--idp-metadata-path=IDP_METADATA_PATH] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a new SAML workforce pool provider. + +EXAMPLES + The following command updates the SAML workforce pool provider with the ID + my-workforce-pool-provider. Explicit values for all required and optional + parameters are provided. + + $ gcloud iam workforce-pools providers update-saml \ + my-workforce-pool-provider \ + --workforce-pool="my-workforce-pool" --location="global" \ + --display-name="My Workforce Pool Provider" \ + --description="My workforce pool provider description." \ + --disabled --attribute-mapping="google.subject=assertion.sub" \ + --attribute-condition="true" \ + --idp-metadata-path="path/to/metdata/file.xml" + +POSITIONAL ARGUMENTS + Workforce pool provider resource - The workforce pool provider to update. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + PROVIDER + ID of the workforce pool provider or fully qualified identifier for + the workforce pool provider. To set the provider attribute: + ▸ provide the argument provider 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 for the workforce pool. To set the location attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument provider on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --attribute-condition=ATTRIBUTE_CONDITION + A Common Expression Language (https://opensource.google/projects/cel) + expression, in plain text, to restrict which otherwise valid + authentication credentials issued by the provider should be accepted. + + The expression must output a boolean representing whether to allow the + federation. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Provider. + ◆ google: The Google attributes mapped from the assertion in the + attribute_mappings. google.profile_photo and google.display_name are + not supported. + ◆ attribute: The custom attributes mapped from the assertion in the + attribute_mappings. + + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credential will be + accepted. + + Example: Only allow credentials with a mapped google.groups value of + admins. + + "'admins' in google.groups" + + --attribute-mapping=[ATTRIBUTE_MAPPING,...] + Maps claims from the authentication credentials issued by the Identity + Provider into Google Cloud IAM attributes, e.g. subject, segment. + + Each key must be a string specifying the Google Cloud IAM attribute to + be produced. + + The following predefined keys are currently supported: + + ◆ google.subject: required field that indicates the principal that is + being authenticated to IAM, and will be logged in all API accesses + for which Cloud Audit Logging is configured. + + ◆ google.groups: optional field that indicates asserted groups that + the user should be considered to belong to. You can create IAM + bindings using the groups attribute and access to a resource will be + granted if any of the groups asserted here match a group in the + respective binding. + + ◆ google.display_name: optional field that overrides the name of the + user. If not set, google.subject will be displayed instead. This + attribute cannot be used in IAM policies. The maximum length of this + field is 100 characters. + + ◆ google.profile_photo: optional fields that may be set to a valid + URL specifying the user's thumbnail photo. When set, the image will + be visible as the user's profile picture. If not set, a generic user + icon will be displayed instead. This attribute cannot be used in IAM + policies. + + Custom attributes can also be mapped by specifying + attribute.{custom_attribute}, replacing {custom_attribute} with the + name of the custom attribute to be mapped. A maximum of 50 custom + attribute mappings can be defined. The maximum length of a mapped + attribute key is 2048 characters and may only contain the characters + [a-z0-9]. + + These attributes can then be referenced in IAM policies to define + fine-grained access for the workforce pool to Google Cloud resources by + specifying: + + ◆ google.subject: + principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} + + ◆ google.groups: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} + + ◆ attribute.{custom_attribute}: + principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value} + + Each value must be a Common Expression Language + (https://opensource.google/projects/cel) function that maps an Identity + Provider credential to the normalized attribute specified by the + corresponding map key. + + The following keywords may be referenced in the expressions: + + ◆ assertion: JSON representing the authentication credential issued + by the Identity Provider. + + The maximum length of an attribute mapping expression is 2048 + characters. When evaluated, the total size of all mapped attributes + must not exceed 8KB. + + Example: Map the sub claim of the incoming credential to the subject + Google Cloud IAM attribute. + + {"google.subject": "assertion.sub"} + + --description=DESCRIPTION + A description for the workforce pool provider. Cannot exceed 256 + characters in length. + + --disabled + Whether the workforce pool provider is disabled. You cannot use a + disabled provider to perform new token exchanges or sign-ins. However, + existing tokens still grant access. + + --display-name=DISPLAY_NAME + A display name for the workforce pool provider. Cannot exceed 32 + characters in length. + + --idp-metadata-path=IDP_METADATA_PATH + XML file with configuration metadata for the SAML identity provider. + The metadata file must follow the SAML 2.0 metadata specification + (https://www.oasis-open.org/committees/download.php/35391/sstc-saml-metadata-errata-2.0-wd-04-diff.pdf). + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/set-iam-policy b/gcloud/iam/workforce-pools/set-iam-policy new file mode 100644 index 000000000..317024d14 --- /dev/null +++ b/gcloud/iam/workforce-pools/set-iam-policy @@ -0,0 +1,58 @@ +NAME + gcloud iam workforce-pools set-iam-policy - set the IAM policy for a + workforce pool + +SYNOPSIS + gcloud iam workforce-pools set-iam-policy + (WORKFORCE_POOL : --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Set the IAM policy for a workforce pool. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file + policy.json and sets it for the workforce pool with ID my-workforce-pool: + + $ gcloud iam workforce-pools set-iam-policy my-workforce-pool \ + policy.json --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool for which to display the IAM + policy. The arguments in this group can be used to specify the attributes + of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/subjects/delete b/gcloud/iam/workforce-pools/subjects/delete new file mode 100644 index 000000000..68d1c1746 --- /dev/null +++ b/gcloud/iam/workforce-pools/subjects/delete @@ -0,0 +1,69 @@ +NAME + gcloud iam workforce-pools subjects delete - delete a workforce pool + subject + +SYNOPSIS + gcloud iam workforce-pools subjects delete + (SUBJECT : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a workforce pool subject. + +EXAMPLES + The following command deletes a workforce pool subject with the ID + my-workforce-pool-subject: + + $ gcloud iam workforce-pools subjects delete \ + my-workforce-pool-subject --workforce-pool="my-workforce-pool" \ + --location="global" + +POSITIONAL ARGUMENTS + Workforce pool subject resource - The workforce pool subject to delete. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + SUBJECT + ID of the workforce pool subject or fully qualified identifier for + the workforce pool subject. To set the subject attribute: + ▸ provide the argument subject 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 for the workforce pool. To set the location attribute: + ▸ provide the argument subject on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument subject on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/subjects/help b/gcloud/iam/workforce-pools/subjects/help new file mode 100644 index 000000000..d92cbd2a2 --- /dev/null +++ b/gcloud/iam/workforce-pools/subjects/help @@ -0,0 +1,30 @@ +NAME + gcloud iam workforce-pools subjects - create and manage workforce pool + subjects + +SYNOPSIS + gcloud iam workforce-pools subjects GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud iam workforce-pools subjects group lets you create and manage + workforce pool subjects. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + operations + Manage IAM workforce pool subject long-running operations. + +COMMANDS + COMMAND is one of the following: + + delete + Delete a workforce pool subject. + + undelete + Undelete a workforce pool subject. diff --git a/gcloud/iam/workforce-pools/subjects/operations/describe b/gcloud/iam/workforce-pools/subjects/operations/describe new file mode 100644 index 000000000..069ad6bb9 --- /dev/null +++ b/gcloud/iam/workforce-pools/subjects/operations/describe @@ -0,0 +1,75 @@ +NAME + gcloud iam workforce-pools subjects operations describe - describe a + workforce pool subject operation + +SYNOPSIS + gcloud iam workforce-pools subjects operations describe + (OPERATION : --location=LOCATION + --subject=SUBJECT --workforce-pool=WORKFORCE_POOL) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a workforce pool subject operation. + +EXAMPLES + To describe the long-running workforce pool subject operation with the ID + my-operation, run: + + $ gcloud iam workforce-pools subjects operations describe \ + my-operation --workforce-pool="my-workforce-pool" \ + --subject="my-subject" --location="global" + +POSITIONAL ARGUMENTS + Workforce pool subject operation resource - The workforce pool subject + long-running operation to describe. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + OPERATION + ID of the workforce pool subject operation or fully qualified + identifier for the workforce pool subject operation. To set the + operation attribute: + ▸ provide the argument operation 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 for the workforce pool. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --subject=SUBJECT + The ID to use for the workforce pool subject, which becomes the final + component of the resource name. + + To set the subject attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --subject on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool 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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/subjects/operations/help b/gcloud/iam/workforce-pools/subjects/operations/help new file mode 100644 index 000000000..2ce04ae80 --- /dev/null +++ b/gcloud/iam/workforce-pools/subjects/operations/help @@ -0,0 +1,21 @@ +NAME + gcloud iam workforce-pools subjects operations - manage IAM workforce pool + subject long-running operations + +SYNOPSIS + gcloud iam workforce-pools subjects operations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing IAM workforce pool subject long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe a workforce pool subject operation. diff --git a/gcloud/iam/workforce-pools/subjects/undelete b/gcloud/iam/workforce-pools/subjects/undelete new file mode 100644 index 000000000..ec245b755 --- /dev/null +++ b/gcloud/iam/workforce-pools/subjects/undelete @@ -0,0 +1,69 @@ +NAME + gcloud iam workforce-pools subjects undelete - undelete a workforce pool + subject + +SYNOPSIS + gcloud iam workforce-pools subjects undelete + (SUBJECT : --location=LOCATION --workforce-pool=WORKFORCE_POOL) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Undelete a workforce pool subject. + +EXAMPLES + The following command undeletes a workforce pool subject with the ID + my-workforce-pool-subject: + + $ gcloud iam workforce-pools subjects undelete \ + my-workforce-pool-subject --workforce-pool="my-workforce-pool" \ + --location="global" + +POSITIONAL ARGUMENTS + Workforce pool subject resource - The workforce pool subject to undelete. + The arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + SUBJECT + ID of the workforce pool subject or fully qualified identifier for + the workforce pool subject. To set the subject attribute: + ▸ provide the argument subject 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 for the workforce pool. To set the location attribute: + ▸ provide the argument subject on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + + --workforce-pool=WORKFORCE_POOL + The ID to use for the workforce pool, which becomes the final + component of the resource name. This value must be a globally unique + string of 6 to 63 lowercase letters, digits, or hyphens. It must + start with a letter, and cannot have a trailing hyphen. The prefix + gcp- is reserved for use by Google, and may not be specified. + + To set the workforce-pool attribute: + ▸ provide the argument subject on the command line with a fully + specified name; + ▸ provide the argument --workforce-pool on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ diff --git a/gcloud/iam/workforce-pools/undelete b/gcloud/iam/workforce-pools/undelete new file mode 100644 index 000000000..3e45b44fe --- /dev/null +++ b/gcloud/iam/workforce-pools/undelete @@ -0,0 +1,60 @@ +NAME + gcloud iam workforce-pools undelete - undelete a workforce pool + +SYNOPSIS + gcloud iam workforce-pools undelete (WORKFORCE_POOL : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Undelete a workforce pool. + +EXAMPLES + The following command undeletes a workforce pool with ID my-workforce-pool: + + $ gcloud iam workforce-pools undelete my-workforce-pool \ + --location=global + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to undelete. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools undelete + + $ gcloud beta iam workforce-pools undelete + diff --git a/gcloud/iam/workforce-pools/update b/gcloud/iam/workforce-pools/update new file mode 100644 index 000000000..a8edf143f --- /dev/null +++ b/gcloud/iam/workforce-pools/update @@ -0,0 +1,85 @@ +NAME + gcloud iam workforce-pools update - update a workforce pool + +SYNOPSIS + gcloud iam workforce-pools update (WORKFORCE_POOL : --location=LOCATION) + [--async] [--description=DESCRIPTION] [--disabled] + [--display-name=DISPLAY_NAME] [--session-duration=SESSION_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a workforce pool. + +EXAMPLES + The following command updates a workforce pool with ID my-workforce-pool + with explicit values for all required and optional parameters: + + $ gcloud iam workforce-pools update my-workforce-pool \ + --location=global --display-name="My Workforce Pool" \ + --description="My workforce pool description." \ + --session-duration="7200s" --disabled + +POSITIONAL ARGUMENTS + Workforce pool resource - The workforce pool to update. The arguments in + this group can be used to specify the attributes of this resource. + + This must be specified. + + WORKFORCE_POOL + ID of the workforce pool or fully qualified identifier for the + workforce pool. To set the workforce_pool attribute: + ▸ provide the argument workforce_pool 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 for the workforce pool. To set the location attribute: + ▸ provide the argument workforce_pool 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. + + --description=DESCRIPTION + A description for the workforce pool. Cannot exceed 256 characters in + length. + + --disabled + Whether or not the workforce pool is disabled. You cannot use a + disabled workforce pool to perform new token exchanges or sign-ins + using any provider in the workforce pool. + + --display-name=DISPLAY_NAME + A display name for the workforce pool. Cannot exceed 32 characters in + length. + + --session-duration=SESSION_DURATION + How long the Google Cloud access tokens, console sign-in sessions, and + gcloud sign-in sessions from this workforce pool are valid. Must be + greater than 15 minutes (900s) and less than 12 hours (43200s). If not + configured, minted credentials will have a default duration of one hour + (3600s). + +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 iam/v1 API. The full documentation for this API can + be found at: https://cloud.google.com/iam/ + +NOTES + These variants are also available: + + $ gcloud alpha iam workforce-pools update + + $ gcloud beta iam workforce-pools update + diff --git a/gcloud/init b/gcloud/init index 9ac705a4d..74eb791fb 100644 --- a/gcloud/init +++ b/gcloud/init @@ -39,14 +39,14 @@ EXAMPLES FLAGS --no-browser - Prevent the command from launching a browser for authorization. + Prevent the command from launching a browser for authorization. Use + this flag if you are on a machine that does not have a browser but you + can install the gcloud CLI on another machine with a browser. --console-only, --no-launch-browser - (DEPRECATED) Prevent the command from launching a browser for - authorization. - - The --console-only/--no-launch-browser are deprecated and will be - removed in future updates. Use --no-browser as a replacement. + Prevent the command from launching a browser for authorization. Use + this flag if you are on a machine that does not have a browser and you + cannot install the gcloud CLI on another machine with a browser. --skip-diagnostics Do not run diagnostics. diff --git a/gcloud/iot/devices/list b/gcloud/iot/devices/list index 2cb242b88..4cfabf259 100644 --- a/gcloud/iot/devices/list +++ b/gcloud/iot/devices/list @@ -3,10 +3,11 @@ NAME SYNOPSIS gcloud iot devices list (--registry=REGISTRY : --region=REGION) - [--device-ids=[DEVICE_IDS,...]] [--device-num-ids=[DEVICE_NUM_IDS,...]] - [--device-type=DEVICE_TYPE] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--device-field-mask=DEVICE_FIELD_MASK; + default="blocked,gatewayConfig"] [--device-ids=[DEVICE_IDS,...]] + [--device-num-ids=[DEVICE_NUM_IDS,...]] [--device-type=DEVICE_TYPE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION List devices. @@ -44,6 +45,12 @@ REQUIRED FLAGS ▸ provide the argument --region on the command line. FLAGS + --device-field-mask=DEVICE_FIELD_MASK; default="blocked,gatewayConfig" + If given, returns all specified device fields instead of the default + set. The value is a comma-separated list of field names. Example: + "lastErrorStatus,config,metadata". See full list of device fields at: + https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries.devices + --device-ids=[DEVICE_IDS,...] If given, show only devices with one of the provided IDs. diff --git a/gcloud/run/deploy b/gcloud/run/deploy index 46e7fd8f0..51f629f56 100644 --- a/gcloud/run/deploy +++ b/gcloud/run/deploy @@ -350,7 +350,7 @@ FLAGS details. The location can be a directory on a local disk or a gzipped archive file (.tar.gz) in Google Cloud Storage. If the source is a local directory, this command skips the files specified in the - --ignore-file. If --ignore-file is not specified, use.gcloudignore + --ignore-file. If --ignore-file is not specified, use .gcloudignore file. If a .gcloudignore file is absent and a .gitignore file is present in the local source directory, gcloud will use a generated Git-compatible .gcloudignore file that respects your .gitignored diff --git a/gcloud/run/services/help b/gcloud/run/services/help index 3c347072d..3690b367c 100644 --- a/gcloud/run/services/help +++ b/gcloud/run/services/help @@ -121,7 +121,7 @@ COMMANDS Remove IAM policy binding of a Cloud Run service. replace - Creates or replaces a service from a YAML Service specification. + Create or replace a service from a YAML service specification. set-iam-policy Set the IAM policy for a service. diff --git a/gcloud/run/services/replace b/gcloud/run/services/replace index 6a730ffee..ca00c2c34 100644 --- a/gcloud/run/services/replace +++ b/gcloud/run/services/replace @@ -1,6 +1,6 @@ NAME - gcloud run services replace - creates or replaces a service from a YAML - Service specification + gcloud run services replace - create or replace a service from a YAML + service specification SYNOPSIS gcloud run services replace FILE [--async] [--namespace=NAMESPACE] @@ -10,10 +10,10 @@ SYNOPSIS | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Creates or replaces a service from a YAML Service specification. + Creates or replaces a service from a YAML service specification. EXAMPLES - To replace the specification for myservice + To replace the specification for a service defined in myservice.yaml $ gcloud run services replace myservice.yaml diff --git a/gcloud/vmware/private-clouds/subnets/list b/gcloud/vmware/private-clouds/subnets/list index 5f9ae4264..d6e5560d9 100644 --- a/gcloud/vmware/private-clouds/subnets/list +++ b/gcloud/vmware/private-clouds/subnets/list @@ -12,11 +12,47 @@ DESCRIPTION List subnets in a VMware Engine private cloud. EXAMPLES - To list subnets in the my-privatecloud private cloud, run: + To list subnets that belong to the private cloud my-privatecloud in project + my-project and zone us-east2-b, run: $ gcloud vmware private-clouds subnets list \ - --private-cloud=my-privatecloud --project=my-project \ - --location=us-east2-b + --private-cloud=my-privatecloud --location=us-east2-b \ + --project=my-project + + Or: + + $ gcloud vmware private-clouds subnets list \ + --private-cloud=my-privatecloud + + In the above example, the project and the location are taken from gcloud + properties core/project and compute/zone, respectively. + + To list subnets that belong to all the private clouds in project my-project + and zone us-east2-b, run: + + $ gcloud vmware private-clouds subnets list --private-cloud=- \ + --location=us-east2-b --project=my-project + + Or: + + $ gcloud vmware private-clouds subnets list --private-cloud=- + + In the above example, the project and the location are taken from gcloud + properties core/project and compute/zone, respectively. + + To list subnets for all private clouds in all locations in project + my-project, run: + + $ gcloud vmware private-clouds subnets list --private-cloud=- \ + --location=- --project=my-project + + Or: + + $ gcloud vmware private-clouds subnets list --private-cloud=- \ + --location=- + + In the last example, the project is taken from gcloud properties + core/project. REQUIRED FLAGS Private cloud resource - private_cloud. The arguments in this group can be