diff --git a/gcloud/_version b/gcloud/_version index 33dbf92f7..5b0dfbf25 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 474.0.0 -alpha 2024.04.26 -beta 2024.04.26 +Google Cloud SDK 475.0.0 +alpha 2024.05.03 +beta 2024.05.03 bq 2.1.4 bundled-python3-unix 3.11.8 -core 2024.04.26 +core 2024.05.03 gcloud-crc32c 1.0.0 gsutil 5.27 diff --git a/gcloud/alpha/builds/submit b/gcloud/alpha/builds/submit index 285ba155e..54f777e39 100644 --- a/gcloud/alpha/builds/submit +++ b/gcloud/alpha/builds/submit @@ -58,6 +58,14 @@ EXAMPLES "projects/my-project/locations/us-west1/connections/my-conn/repo\ sitories/my-repo" --revision=main + To submit a build with source from a Developer Connect GitRepositoryLink + resource + projects/my-project/locations/us-west1/connections/my-conn/gitRepositoryLinks/my-repo-link: + + $ gcloud alpha builds submit \ + "projects/my-project/locations/us-west1/connections/my-conn/gitR\ + epositoryLinks/my-repo-link" --revision=main + POSITIONAL ARGUMENTS At most one of these can be specified: @@ -96,9 +104,9 @@ FLAGS --dir=DIR Directory, relative to the source root, in which to run the build. This is used when the build source is a 2nd-gen Cloud Build repository - resource. This must be a relative path. If a step's dir is specified - and is an absolute path, this value is ignored for that step's - execution. + resource, or a Developer Connect GitRepositoryLink resource. This must + be a relative path. If a step's dir is specified and is an absolute + path, this value is ignored for that step's execution. --disk-size=DISK_SIZE Machine disk size (GB) to run the build. @@ -157,7 +165,8 @@ FLAGS --revision=REVISION Revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref to run the build. This is used when the - build source is a 2nd-gen Cloud Build repository resource. + build source is a 2nd-gen Cloud Build repository resource, or a + Developer Connect GitRepositoryLink resource. Cloud Build uses git fetch to fetch the revision from the Git repository; therefore make sure that the string you provide for diff --git a/gcloud/alpha/compute/storage-pools/list b/gcloud/alpha/compute/storage-pools/list index 3b73f16ae..a7d2be434 100644 --- a/gcloud/alpha/compute/storage-pools/list +++ b/gcloud/alpha/compute/storage-pools/list @@ -9,7 +9,7 @@ SYNOPSIS DESCRIPTION (ALPHA) View storage pools. - The compact default output format is explained below: + The compact, default output format is explained below: The type column contains all three types -- storage pool type, capacity and performance. For example, the value @@ -29,8 +29,9 @@ DESCRIPTION ▪ Adv: Advanced ▪ Std: Standard - The capacity, iops and throughput columns describe used, provisioned, the - utilization rate. For example, the following value for capacity: + The capacity column, and standard-performance iops and throughput columns + describe the used, provisioned, and the utilization rate. For example, the + following value for capacity: 40 / 50 (80%) @@ -38,6 +39,9 @@ DESCRIPTION 80%. The utilization rate is equivalent to used capacity divided by provisioned capacity. + For advanced-performance storage pools, the iops and throughput columns + will simply show the provisioned values. + EXAMPLES To display all storage pools in all regions and zones, run the following command: diff --git a/gcloud/alpha/config/get b/gcloud/alpha/config/get index 2717f6583..151706baf 100644 --- a/gcloud/alpha/config/get +++ b/gcloud/alpha/config/get @@ -269,9 +269,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/alpha/config/help b/gcloud/alpha/config/help index 3c82aa0b9..11b74eb56 100644 --- a/gcloud/alpha/config/help +++ b/gcloud/alpha/config/help @@ -301,9 +301,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/alpha/config/list b/gcloud/alpha/config/list index be12c90c4..6912e6a6f 100644 --- a/gcloud/alpha/config/list +++ b/gcloud/alpha/config/list @@ -313,9 +313,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/alpha/config/set b/gcloud/alpha/config/set index 522805ac6..bb42c947a 100644 --- a/gcloud/alpha/config/set +++ b/gcloud/alpha/config/set @@ -316,9 +316,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/alpha/config/unset b/gcloud/alpha/config/unset index 8f18023ef..674b11404 100644 --- a/gcloud/alpha/config/unset +++ b/gcloud/alpha/config/unset @@ -277,9 +277,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/alpha/container/fleet/mesh/debug/proxy-config b/gcloud/alpha/container/fleet/mesh/debug/proxy-config index e225d8bc9..82a5f6756 100644 --- a/gcloud/alpha/container/fleet/mesh/debug/proxy-config +++ b/gcloud/alpha/container/fleet/mesh/debug/proxy-config @@ -24,21 +24,19 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --type=TYPE - Proxy configuration type, one of - all|clusters|listeners|routes|endpoints|bootstrap|log|secret + Proxy configuration type to retrieve. - all Retrieves all configuration for the Envoy in the specified pod - bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod - cluster Retrieves cluster configuration for the Envoy in the specified pod - ecds Retrieves typed extension configuration for the Envoy in the specified pod - endpoint Retrieves endpoint configuration for the Envoy in the specified pod - listener Retrieves listener configuration for the Envoy in the specified pod - log Retrieves logging levels of the Envoy in the specified pod - route Retrieves route configuration for the Envoy in the specified pod - secret Retrieves secret configuration for the Envoy in the specified pod + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + clusters/cluster Retrieves cluster configuration for the Envoy in the specified pod + endpoints/endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listeners/listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + routes/route Retrieves route configuration for the Envoy in the specified pod + secrets/secret Retrieves secret configuration for the Envoy in the specified pod - TYPE must be one of: all, bootstrap, cluster, listeners, routes, - endpoints, listener, log, secret. + TYPE must be one of: all, bootstrap, cluster, clusters, endpoint, + endpoints, listener, listeners, log, route, routes, secret, secrets. Membership resource - The group of arguments defining a membership. The arguments in this group can be used to specify the attributes of this diff --git a/gcloud/alpha/container/hub/mesh/debug/proxy-config b/gcloud/alpha/container/hub/mesh/debug/proxy-config index 3f9384b84..d1b7c59b7 100644 --- a/gcloud/alpha/container/hub/mesh/debug/proxy-config +++ b/gcloud/alpha/container/hub/mesh/debug/proxy-config @@ -24,21 +24,19 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --type=TYPE - Proxy configuration type, one of - all|clusters|listeners|routes|endpoints|bootstrap|log|secret + Proxy configuration type to retrieve. - all Retrieves all configuration for the Envoy in the specified pod - bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod - cluster Retrieves cluster configuration for the Envoy in the specified pod - ecds Retrieves typed extension configuration for the Envoy in the specified pod - endpoint Retrieves endpoint configuration for the Envoy in the specified pod - listener Retrieves listener configuration for the Envoy in the specified pod - log Retrieves logging levels of the Envoy in the specified pod - route Retrieves route configuration for the Envoy in the specified pod - secret Retrieves secret configuration for the Envoy in the specified pod + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + clusters/cluster Retrieves cluster configuration for the Envoy in the specified pod + endpoints/endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listeners/listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + routes/route Retrieves route configuration for the Envoy in the specified pod + secrets/secret Retrieves secret configuration for the Envoy in the specified pod - TYPE must be one of: all, bootstrap, cluster, listeners, routes, - endpoints, listener, log, secret. + TYPE must be one of: all, bootstrap, cluster, clusters, endpoint, + endpoints, listener, listeners, log, route, routes, secret, secrets. Membership resource - The group of arguments defining a membership. The arguments in this group can be used to specify the attributes of this diff --git a/gcloud/alpha/emulators/firestore/start b/gcloud/alpha/emulators/firestore/start index 32eb5c044..66b685504 100644 --- a/gcloud/alpha/emulators/firestore/start +++ b/gcloud/alpha/emulators/firestore/start @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud alpha emulators firestore start [--database-mode=DATABASE_MODE] - [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] + [--export-on-exit=EXPORT_ON_EXIT] [--host-port=HOST_PORT] + [--import-data=IMPORT_DATA] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command starts a local Firestore emulator. @@ -26,6 +27,15 @@ EXAMPLES $ gcloud alpha emulators firestore start \ --database-mode=datastore-mode + To import data at the start of the Firestore emulator, run: + + $ gcloud alpha emulators firestore start --import-data= + + To export emulator data upon emulator shutdown, run: + + $ gcloud alpha emulators firestore start \ + --export-on-exit= + FLAGS --database-mode=DATABASE_MODE The database mode to start the Firestore Emulator in. The valid options @@ -34,6 +44,10 @@ FLAGS `firestore-native` (default): start the emulator in Firestore Native `datastore-mode`: start the emulator in Datastore Mode + --export-on-exit=EXPORT_ON_EXIT + Directory path in which emulator data will be saved upon shutdown. + Example:/home/user/myexports/2024-03-26/ + --host-port=HOST_PORT The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port: @@ -46,6 +60,10 @@ FLAGS The default value is localhost:8080. + --import-data=IMPORT_DATA + File path to the data to be loaded into the emulator upon start up. + Example:/home/user/myexports/sampleExport/sampleExport.overall_export_metadata. + --rules=RULES If set, all projects will use the security rules in this file. More information on Firebase Rules and the syntax for this file is available diff --git a/gcloud/alpha/firestore/databases/list b/gcloud/alpha/firestore/databases/list index e79b198da..aee25837e 100644 --- a/gcloud/alpha/firestore/databases/list +++ b/gcloud/alpha/firestore/databases/list @@ -3,15 +3,23 @@ NAME the project SYNOPSIS - gcloud alpha firestore databases list [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore databases list [--show-deleted] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] EXAMPLES - To list all Firestore databases. + To list all active Firestore databases. $ gcloud alpha firestore databases list + To list all Firestore databases including deleted databases. + + $ gcloud alpha firestore databases list --show-deleted + +FLAGS + --show-deleted + Show the deleted databases. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/functions/deploy b/gcloud/alpha/functions/deploy index 5ef7c7acd..7560bb27f 100644 --- a/gcloud/alpha/functions/deploy +++ b/gcloud/alpha/functions/deploy @@ -149,7 +149,12 @@ FLAGS function and using its generation. --ignore-file=IGNORE_FILE - Override the .gcloudignore file and use the specified file instead. + Override the .gcloudignore file in the source directory and use the + specified file instead. By default, the source directory is your + current directory. Note that it could be changed by the --source flag, + in which case your .gcloudignore file will be searched in the + overridden directory. For example, --ignore-file=.mygcloudignore + combined with --source=./mydir would point to ./mydir/.mygcloudignore --ingress-settings=INGRESS_SETTINGS Ingress settings controls what traffic can reach the function. By diff --git a/gcloud/alpha/functions/local/deploy b/gcloud/alpha/functions/local/deploy index 1a5a71c0c..258499b55 100644 --- a/gcloud/alpha/functions/local/deploy +++ b/gcloud/alpha/functions/local/deploy @@ -34,7 +34,12 @@ FLAGS if not specified. --ignore-file=IGNORE_FILE - Override the .gcloudignore file and use the specified file instead. + Override the .gcloudignore file in the source directory and use the + specified file instead. By default, the source directory is your + current directory. Note that it could be changed by the --source flag, + in which case your .gcloudignore file will be searched in the + overridden directory. For example, --ignore-file=.mygcloudignore + combined with --source=./mydir would point to ./mydir/.mygcloudignore --port=PORT; default=8080 Port for the deployment to run on. The default port is 8080 for new diff --git a/gcloud/alpha/looker/instances/update b/gcloud/alpha/looker/instances/update index 854e86b06..bc0e93b09 100644 --- a/gcloud/alpha/looker/instances/update +++ b/gcloud/alpha/looker/instances/update @@ -5,6 +5,7 @@ SYNOPSIS gcloud alpha looker instances update (INSTANCE : --region=REGION) [--allowed-email-domains=[ALLOWED_EMAIL_DOMAINS,...]] [--async] [--custom-domain=CUSTOM_DOMAIN] [--enable-public-ip] + [--linked-lsp-project-number=LINKED_LSP_PROJECT_NUMBER] [--add-developer-users=ADD_DEVELOPER_USERS --add-standard-users=ADD_STANDARD_USERS --add-viewer-users=ADD_VIEWER_USERS] @@ -91,6 +92,9 @@ FLAGS --enable-public-ip This specifies whether public IP is enabled on the Looker instance. + --linked-lsp-project-number=LINKED_LSP_PROJECT_NUMBER + The Looker Studio Pro project number to be linked. + User Allocations - There are ten Standard and two Developer users included in the cost of the product. You can allocate additional Standard, Viewer, and Developer users for this instance. It is an optional step and can be diff --git a/gcloud/alpha/pam/check-onboarding-status b/gcloud/alpha/pam/check-onboarding-status index c68ea2ae1..bb6790f8a 100644 --- a/gcloud/alpha/pam/check-onboarding-status +++ b/gcloud/alpha/pam/check-onboarding-status @@ -12,23 +12,23 @@ DESCRIPTION project/organization/folder location. EXAMPLES - The following command checks the PAM onboarding status for a project - sample-project and location global: + The following command checks the PAM onboarding status for a project named + sample-project and in location global: $ gcloud alpha pam check-onboarding-status \ --project=sample-project --location=global - The following command checks the PAM onboarding status for a folder - sample-folder and location global: + The following command checks the PAM onboarding status for a folder with ID + FOLDER_ID and in location global: - $ gcloud alpha pam check-onboarding-status --folder=sample-folder \ + $ gcloud alpha pam check-onboarding-status --folder=FOLDER_ID \ --location=global The following command checks the PAM onboarding status for an organization - sample-organization and location global: + with ID ORGANIZATION_ID and in location global: $ gcloud alpha pam check-onboarding-status \ - --organization=sample-organization --location=global + --organization=ORGANIZATION_ID --location=global REQUIRED FLAGS Location resource - The project/organization/folder location for which the diff --git a/gcloud/alpha/pam/entitlements/create b/gcloud/alpha/pam/entitlements/create index 60e94204b..c9c8b8b94 100644 --- a/gcloud/alpha/pam/entitlements/create +++ b/gcloud/alpha/pam/entitlements/create @@ -9,33 +9,35 @@ SYNOPSIS --entitlement-file=ENTITLEMENT_FILE [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Create a new Privileged Access Manager (PAM) entitlement under a + (ALPHA) Create a new Privileged Access Manager (PAM) entitlement in a project/folder/organization location. EXAMPLES - The following command creates a new entitlement with the name - sample-entitlement, under a project sample-project, location global and the - entitlement body present in the sample-entitlement.yaml file: + The following command creates a new entitlement with a name of + sample-entitlement, in a project named sample-project, in location global, + and the entitlement configuration stored in a file named + sample-entitlement.yaml: $ gcloud alpha pam entitlements create sample-entitlement \ --project=sample-project --location=global \ --entitlement-file=sample-entitlement.yaml - The following command creates a new entitlement with the name - sample-entitlement, under a folder sample-folder, location global and the - entitlement body present in the sample-entitlement.yaml file: + The following command creates a new entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, in location global, and + the entitlement configuration stored in a file named + sample-entitlement.yaml: $ gcloud alpha pam entitlements create sample-entitlement \ - --folder=sample-folder --location=global \ + --folder=FOLDER_ID --location=global \ --entitlement-file=sample-entitlement.yaml - The following command creates a new entitlement with the name - sample-entitlement, under an organization sample-organization, location - global and the entitlement body present in the sample-entitlement.yaml - file: + The following command creates a new entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, in location + global, and the entitlement configuration stored in a file named + sample-entitlement.yaml: $ gcloud alpha pam entitlements create sample-entitlement \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --entitlement-file=sample-entitlement.yaml POSITIONAL ARGUMENTS @@ -96,7 +98,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --entitlement-file=ENTITLEMENT_FILE - YAML file containing the body of the entitlement to be created. + YAML file containing the configuration of the entitlement. OPTIONAL FLAGS --async diff --git a/gcloud/alpha/pam/entitlements/delete b/gcloud/alpha/pam/entitlements/delete index 45b8efc99..0ed3e051c 100644 --- a/gcloud/alpha/pam/entitlements/delete +++ b/gcloud/alpha/pam/entitlements/delete @@ -10,16 +10,31 @@ SYNOPSIS DESCRIPTION (ALPHA) Delete a Privileged Access Manager (PAM) entitlement along with all - grants under it. + grants associated with it. This command can fail for the following reasons: ▪ There are non-terminal grants under the entitlement. EXAMPLES - The following command deletes an entitlement with the full name - ENTITLEMENT_NAME along with all grants under it: + The following command deletes an entitlement with a name of + sample-entitlement, in a project named sample-project, and in location + global: - $ gcloud alpha pam entitlements delete ENTITLEMENT_NAME + $ gcloud alpha pam entitlements delete sample-entitlement \ + --project=sample-project --location=global + + The following command deletes an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, and in location global: + + $ gcloud alpha pam entitlements delete sample-entitlement \ + --folder=FOLDER_ID --location=global + + The following command deletes an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, and in + location global: + + $ gcloud alpha pam entitlements delete sample-entitlement \ + --organization=ORGANIZATION_ID --location=global POSITIONAL ARGUMENTS Entitlement resource - Name of the entitlement to delete. The arguments in diff --git a/gcloud/alpha/pam/entitlements/describe b/gcloud/alpha/pam/entitlements/describe index 025b1e916..bba59d234 100644 --- a/gcloud/alpha/pam/entitlements/describe +++ b/gcloud/alpha/pam/entitlements/describe @@ -12,10 +12,25 @@ DESCRIPTION (ALPHA) Show details of a Privileged Access Manager (PAM) entitlement. EXAMPLES - The following command describes an entitlement with the full name - ENTITLEMENT_NAME: + The following command describes an entitlement with a name of + sample-entitlement, in a project named sample-project, and in location + global: - $ gcloud alpha pam entitlements describe ENTITLEMENT_NAME + $ gcloud alpha pam entitlements describe sample-entitlement \ + --project=sample-project --location=global + + The following command describes an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, and in location global: + + $ gcloud alpha pam entitlements describe sample-entitlement \ + --folder=FOLDER_ID --location=global + + The following command describes an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, and in + location global: + + $ gcloud alpha pam entitlements describe sample-entitlement \ + --organization=ORGANIZATION_ID --location=global POSITIONAL ARGUMENTS Entitlement resource - Name of the entitlement to describe. The arguments diff --git a/gcloud/alpha/pam/entitlements/export b/gcloud/alpha/pam/entitlements/export index 6723dcc71..39f63ca0d 100644 --- a/gcloud/alpha/pam/entitlements/export +++ b/gcloud/alpha/pam/entitlements/export @@ -13,11 +13,29 @@ DESCRIPTION YAML file. EXAMPLES - The following command exports an entitlement with the full name - ENTITLEMENT_NAME to a local YAML file entitlement-file.yaml: + The following command exports an entitlement with a name of + sample-entitlement, in a project named sample-project, and in location + global to a local YAML file named sample-entitlement.yaml: - $ gcloud alpha pam entitlements export ENTITLEMENT_NAME \ - --destination=entitlement-file.yaml + $ gcloud alpha pam entitlements export sample-entitlement \ + --project=sample-project --location=global \ + --destination=sample-entitlement.yaml + + The following command exports an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, and in location global + to a local YAML file named sample-entitlement.yaml: + + $ gcloud alpha pam entitlements export sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --destination=sample-entitlement.yaml + + The following command exports an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, and in + location global to a local YAML file named sample-entitlement.yaml: + + $ gcloud alpha pam entitlements export sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ + --destination=sample-entitlement.yaml POSITIONAL ARGUMENTS Entitlement resource - Name of the entitlement to export. The arguments in diff --git a/gcloud/alpha/pam/entitlements/help b/gcloud/alpha/pam/entitlements/help index 33d419a8f..1fa88500d 100644 --- a/gcloud/alpha/pam/entitlements/help +++ b/gcloud/alpha/pam/entitlements/help @@ -1,115 +1,180 @@ NAME gcloud alpha pam entitlements - manage Privileged Access Manager - Entitlements + entitlements SYNOPSIS gcloud alpha pam entitlements COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) The gcloud pam entitlements command group lets you manage - Privileged Access Manager (PAM) Entitlements. + Privileged Access Manager (PAM) entitlements. EXAMPLES - To create a new entitlement with the name sample-entitlement, under a - project sample-project, location global and the entitlement body present in - the sample-entitlement.yaml file, run: + To create a new entitlement with a name of sample-entitlement, in a project + named sample-project, in location global, and the entitlement configuration + stored in a file named sample-entitlement.yaml, run: $ gcloud alpha pam entitlements create sample-entitlement \ --project=sample-project --location=global \ --entitlement-file=sample-entitlement.yaml - To create a new entitlement with the name sample-entitlement, under a - folder sample-folder, location global and the entitlement body present in - the sample-entitlement.yaml file, run: + To create a new entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, in location global, and the entitlement configuration + stored in a file named sample-entitlement.yaml, run: $ gcloud alpha pam entitlements create sample-entitlement \ - --folder=sample-folder --location=global \ + --folder=FOLDER_ID --location=global \ --entitlement-file=sample-entitlement.yaml - To create a new entitlement with the name sample-entitlement, under an - organization sample-organization, location global and the entitlement body - present in the sample-entitlement.yaml file, run: + To create a new entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, in location global, and the + entitlement configuration stored in a file named sample-entitlement.yaml, + run: $ gcloud alpha pam entitlements create sample-entitlement \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --entitlement-file=sample-entitlement.yaml - To update an entitlement with the full name ENTITLEMENT_NAME and the new - entitlement body present in the sample-entitlement.yaml file, run: + To update an entitlement with a name of sample-entitlement, in a project + named sample-project, in location global, and the new entitlement + configuration stored in a file named sample-entitlement.yaml, run: - $ gcloud alpha pam entitlements update ENTITLEMENT_NAME \ + $ gcloud alpha pam entitlements update sample-entitlement \ + --project=sample-project --location=global \ --entitlement-file=sample-entitlement.yaml - To describe an entitlement with the full name ENTITLEMENT_NAME, run: + To update an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, in location global, and the new entitlement + configuration stored in a file named sample-entitlement.yaml, run: - $ gcloud alpha pam entitlements describe ENTITLEMENT_NAME + $ gcloud alpha pam entitlements update sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --entitlement-file=sample-entitlement.yaml - To search and list all entitlements under a project sample-project and - location global for which you are a requester, run: + To update an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, in location global, and the new + entitlement configuration stored in a file named sample-entitlement.yaml, + run: + + $ gcloud alpha pam entitlements update sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ + --entitlement-file=sample-entitlement.yaml + + To describe an entitlement with a name of sample-entitlement, in a project + named sample-project, and in location global, run: + + $ gcloud alpha pam entitlements describe sample-entitlement \ + --project=sample-project --location=global + + To describe an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, and in location global, run: + + $ gcloud alpha pam entitlements describe sample-entitlement \ + --folder=FOLDER_ID --location=global + + To describe an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, and in location global, run: + + $ gcloud alpha pam entitlements describe sample-entitlement \ + --organization=ORGANIZATION_ID --location=global + + To search for and list all entitlements for which you are a requester, in a + project named sample-project, and in location global, run: $ gcloud alpha pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-requester - To search and list all entitlements under a project sample-project and - location global for which you are an approver, run: + To search for and list all entitlements for which you are an approver, in a + project named sample-project, and in location global, run: $ gcloud alpha pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-approver - To search and list all entitlements under a folder sample-folder and - location global for which you are a requester, run: + To search for and list all entitlements for which you are a requester, in a + folder with ID FOLDER_ID, and in location global, run: - $ gcloud alpha pam entitlements search --folder=sample-folder \ + $ gcloud alpha pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-requester - To search and list all entitlements under a folder sample-folder and - location global for which you are an approver, run: + To search for and list all entitlements for which you are an approver, in a + folder with ID FOLDER_ID, and in location global, run: - $ gcloud alpha pam entitlements search --folder=sample-folder \ + $ gcloud alpha pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-approver - To search and list all entitlements under an organization - sample-organization and location global for which you are a requester, run: + To search for and list all entitlements for which you are a requester, in + an organization with ID ORGANIZATION_ID, and in location global, run: $ gcloud alpha pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-requester - To search and list all entitlements under an organization - sample-organization and location global for which you are an approver, run: + To search for and list all entitlements for which you are an approver, in + an organization with ID ORGANIZATION_ID, and in location global, run: $ gcloud alpha pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-approver - To list all entitlement under a project sample-project and location global, - run: + To list all entitlements in a project named sample-project and in location + global, run: $ gcloud alpha pam entitlements list --project=sample-project \ --location=global - To list all entitlement under a folder sample-folder and location global, - run: + To list all entitlements in a folder with ID FOLDER_ID and in location + global, run: - $ gcloud alpha pam entitlements list --folder=sample-folder \ + $ gcloud alpha pam entitlements list --folder=FOLDER_ID \ --location=global - To list all entitlement under an organization sample-organization and + To list all entitlements in an organization with ID ORGANIZATION_ID and in location global, run: $ gcloud alpha pam entitlements list \ - --organization=sample-organization --location=global + --organization=ORGANIZATION_ID --location=global - To delete an entitlement with the full name ENTITLEMENT_NAME along with all - grants under it, run: + To delete an entitlement with a name of sample-entitlement, in a project + named sample-project, and in location global, run: - $ gcloud alpha pam entitlements delete ENTITLEMENT_NAME + $ gcloud alpha pam entitlements delete sample-entitlement \ + --project=sample-project --location=global - To export an entitlement with the full name ENTITLEMENT_NAME to a local - YAML file entitlement-file.yaml, run: + To delete an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, and in location global, run: - $ gcloud alpha pam entitlements export ENTITLEMENT_NAME \ - --destination=entitlement-file.yaml + $ gcloud alpha pam entitlements delete sample-entitlement \ + --folder=FOLDER_ID --location=global + + To delete an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, and in location global, run: + + $ gcloud alpha pam entitlements delete sample-entitlement \ + --organization=ORGANIZATION_ID --location=global + + To export an entitlement with a name of sample-entitlement, in a project + named sample-project, and in location global to a local YAML file named + sample-entitlement.yaml, run: + + $ gcloud alpha pam entitlements export sample-entitlement \ + --project=sample-project --location=global \ + --destination=sample-entitlement.yaml + + To export an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, and in location global to a local YAML file named + sample-entitlement.yaml, run: + + $ gcloud alpha pam entitlements export sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --destination=sample-entitlement.yaml + + To export an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, and in location global to a local + YAML file named sample-entitlement.yaml, run: + + $ gcloud alpha pam entitlements export sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ + --destination=sample-entitlement.yaml GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -138,7 +203,7 @@ COMMANDS search (ALPHA) Search and list all Privileged Access Manager (PAM) - entitlements under a parent for which you are either a requester or an + entitlements in a parent for which you are either a requester or an approver. update diff --git a/gcloud/alpha/pam/entitlements/list b/gcloud/alpha/pam/entitlements/list index 5e0bc5c8b..742e4914d 100644 --- a/gcloud/alpha/pam/entitlements/list +++ b/gcloud/alpha/pam/entitlements/list @@ -9,33 +9,33 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List all Privileged Access Manager (PAM) entitlements under a + (ALPHA) List all Privileged Access Manager (PAM) entitlements in a project/folder/organization location. EXAMPLES - The following command lists all entitlement under a project sample-project - and location global: + The following command lists all entitlements in a project named + sample-project and in location global: $ gcloud alpha pam entitlements list --project=sample-project \ --location=global - The following command lists all entitlement under a folder sample-folder - and location global: + The following command lists all entitlements in a folder with ID FOLDER_ID + and in location global: - $ gcloud alpha pam entitlements list --folder=sample-folder \ + $ gcloud alpha pam entitlements list --folder=FOLDER_ID \ --location=global - The following command lists all entitlement under an organization - sample-organization and location global: + The following command lists all entitlements in an organization with ID + ORGANIZATION_ID and in location global: $ gcloud alpha pam entitlements list \ - --organization=sample-organization --location=global + --organization=ORGANIZATION_ID --location=global REQUIRED FLAGS - Location resource - Location under which the entitlements are to be - listed. 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. + Location resource - Location of the entitlements. 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 --location on the command line with a fully diff --git a/gcloud/alpha/pam/entitlements/search b/gcloud/alpha/pam/entitlements/search index f921ac08c..cd8673eeb 100644 --- a/gcloud/alpha/pam/entitlements/search +++ b/gcloud/alpha/pam/entitlements/search @@ -1,6 +1,6 @@ NAME gcloud alpha pam entitlements search - search and list all Privileged - Access Manager entitlements under a parent for which you are either a + Access Manager entitlements in a parent for which you are either a requester or an approver SYNOPSIS @@ -11,61 +11,61 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Search and list all Privileged Access Manager (PAM) entitlements - under a project/folder/organization location for which you are either a - requester or an approver. + (ALPHA) Search and list all Privileged Access Manager (PAM) entitlements in + a project/folder/organization location for which you are either a requester + or an approver. EXAMPLES - The following command searches and lists all entitlements under a project - sample-project and location global for which you are a requester: + The following command searches for and lists all entitlements for which you + are a requester, in a project named sample-project, and in location global: $ gcloud alpha pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-requester - The following command searches and lists all entitlements under a project - sample-project and location global for which you are an approver: + The following command searches for and lists all entitlements for which you + are an approver, in a project named sample-project, and in location global: $ gcloud alpha pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-approver - The following command searches and lists all entitlements under a folder - sample-folder and location global for which you are a requester: + The following command searches for and lists all entitlements for which you + are a requester, in a folder with ID FOLDER_ID, and in location global: - $ gcloud alpha pam entitlements search --folder=sample-folder \ + $ gcloud alpha pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-requester - The following command searches and lists all entitlements under a folder - sample-folder and location global for which you are an approver: + The following command searches for and lists all entitlements for which you + are an approver, in a folder with ID FOLDER_ID, and in location global: - $ gcloud alpha pam entitlements search --folder=sample-folder \ + $ gcloud alpha pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-approver - The following command searches and lists all entitlements under an - organization sample-organization and location global for which you are a - requester: + The following command searches for and lists all entitlements for which you + are a requester, in an organization with ID ORGANIZATION_ID, and in + location global: $ gcloud alpha pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-requester - The following command searches and lists all entitlements under an - organization sample-organization and location global for which you are an - approver: + The following command searches for and lists all entitlements for which you + are an approver, in an organization with ID ORGANIZATION_ID, and in + location global: $ gcloud alpha pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-approver REQUIRED FLAGS --caller-access-type=CALLER_ACCESS_TYPE - Whether to search the entitlements for which you are a requester or + Search for entitlements based on whether you are a requester or approver. CALLER_ACCESS_TYPE must be one of: grant-approver, grant-requester. - Location resource - Location under which the entitlements are to be - listed. 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. + Location resource - Location of the entitlements. 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 --location on the command line with a fully diff --git a/gcloud/alpha/pam/entitlements/update b/gcloud/alpha/pam/entitlements/update index e0a7279d9..bc24e3967 100644 --- a/gcloud/alpha/pam/entitlements/update +++ b/gcloud/alpha/pam/entitlements/update @@ -12,11 +12,31 @@ DESCRIPTION (ALPHA) Update an existing Privileged Access Manager (PAM) entitlement. EXAMPLES - The following command updates an entitlement with the full name - ENTITLEMENT_NAME and the new entitlement body present in the - sample-entitlement.yaml file: + The following command updates an entitlement with a name of + sample-entitlement, in a project named sample-project, in location global, + and the new entitlement configuration stored in a file named + sample-entitlement.yaml: - $ gcloud alpha pam entitlements update ENTITLEMENT_NAME \ + $ gcloud alpha pam entitlements update sample-entitlement \ + --project=sample-project --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command updates an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, in location global, and + the new entitlement configuration stored in a file named + sample-entitlement.yaml: + + $ gcloud alpha pam entitlements update sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command updates an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, in location + global, and the new entitlement configuration stored in a file named + sample-entitlement.yaml: + + $ gcloud alpha pam entitlements update sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ --entitlement-file=sample-entitlement.yaml POSITIONAL ARGUMENTS @@ -77,7 +97,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --entitlement-file=ENTITLEMENT_FILE - YAML file containing the new body of the entitlement. + YAML file containing the new configuration of the entitlement. OPTIONAL FLAGS --async diff --git a/gcloud/alpha/pam/grants/approve b/gcloud/alpha/pam/grants/approve index 79c348b41..9ed7cdb31 100644 --- a/gcloud/alpha/pam/grants/approve +++ b/gcloud/alpha/pam/grants/approve @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES The following command approves a grant with the full name GRANT_NAME and a - reason approval reason: + reason of approval reason: $ gcloud alpha pam grants approve GRANT_NAME \ --reason="approval reason" diff --git a/gcloud/alpha/pam/grants/create b/gcloud/alpha/pam/grants/create index 434096506..90899b901 100644 --- a/gcloud/alpha/pam/grants/create +++ b/gcloud/alpha/pam/grants/create @@ -14,9 +14,9 @@ DESCRIPTION entitlement. EXAMPLES - The following command creates a new grant under an entitlement with the - full name ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a - justification some justification and two additional email recipients + The following command creates a new grant against the entitlement with the + full name ENTITLEMENT_NAME, a requested duration of 1 hour 30 minutes, a + justification of some justification and two additional email recipients abc@example.com and xyz@example.com: $ gcloud alpha pam grants create --entitlement=ENTITLEMENT_NAME \ @@ -28,8 +28,8 @@ REQUIRED FLAGS --requested-duration=REQUESTED_DURATION Duration of the grant being created. - Entitlement resource - Entitlement under which the grant is to be created - The arguments in this group can be used to specify the attributes of this + Entitlement resource - Entitlement the grant is to be created against. 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. @@ -85,8 +85,8 @@ REQUIRED FLAGS OPTIONAL FLAGS --additional-email-recipients=[ADDITIONAL_EMAIL_RECIPIENTS,...] - Additional email addresses who will be notified for all the actions - performed on the grant. + Additional email addresses that are notified for all actions performed + on the grant. --justification=JUSTIFICATION Justification for the grant. diff --git a/gcloud/alpha/pam/grants/deny b/gcloud/alpha/pam/grants/deny index aa0c15c9c..79ac275ba 100644 --- a/gcloud/alpha/pam/grants/deny +++ b/gcloud/alpha/pam/grants/deny @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES The following command denies a grant with the full name GRANT_NAME and a - reason denial reason: + reason of denial reason: $ gcloud alpha pam grants deny GRANT_NAME --reason="denial reason" diff --git a/gcloud/alpha/pam/grants/help b/gcloud/alpha/pam/grants/help index 475634806..2c32c9c70 100644 --- a/gcloud/alpha/pam/grants/help +++ b/gcloud/alpha/pam/grants/help @@ -1,17 +1,17 @@ NAME - gcloud alpha pam grants - manage Privileged Access Manager Grants + gcloud alpha pam grants - manage Privileged Access Manager grants SYNOPSIS gcloud alpha pam grants COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) The gcloud pam grants command group lets you manage Privileged - Access Manager (PAM) Grants. + Access Manager (PAM) grants. EXAMPLES - To create a new grant under an entitlement with the full name - ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a - justification some justification and two additional email recipients + To create a new grant against an entitlement with the full name + ENTITLEMENT_NAME, a requested duration of 1 hour 30 minutes, a + justification of some justification, and two additional email recipients abc@example.com and xyz@example.com, run: $ gcloud alpha pam grants create --entitlement=ENTITLEMENT_NAME \ @@ -23,7 +23,7 @@ EXAMPLES $ gcloud alpha pam grants describe GRANT_NAME - To list all grants under an entitlement with the full name + To list all grants associated with an entitlement with the full name ENTITLEMENT_NAME, run: $ gcloud alpha pam grants list --entitlement=ENTITLEMENT_NAME @@ -44,20 +44,21 @@ EXAMPLES $ gcloud alpha pam grants revoke GRANT_NAME --reason="revoke reason" - To search and list all grants under an entitlement with the full name - ENTITLEMENT_NAME, which you had created, run: + To search for and list all grants that you have created that are associated + with an entitlement with the full name ENTITLEMENT_NAME, run: $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-created - To search and list all grants under an entitlement with the full name - ENTITLEMENT_NAME, which you had approved or denied, run: + To search for and list all grants that you have approved or denied, that + are associated with an entitlement with the full name ENTITLEMENT_NAME, + run: $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-approved - To search and list all grants under an entitlement with the full name - ENTITLEMENT_NAME, which you can approve, run: + To search for and list all grants that you can approve that are associated + with an entitlement with the full name ENTITLEMENT_NAME, run: $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=can-approve @@ -83,16 +84,15 @@ COMMANDS (ALPHA) Show details of a Privileged Access Manager (PAM) grant. list - (ALPHA) List all Privileged Access Manager (PAM) grants under an - entitlement. + (ALPHA) List all Privileged Access Manager (PAM) grants associated with + an entitlement. revoke (ALPHA) Revoke a Privileged Access Manager (PAM) grant. search - (ALPHA) Search and list all Privileged Access Manager (PAM) grants - under an entitlement which you had created, had approved or can - approve. + (ALPHA) Search for and list all Privileged Access Manager (PAM) grants + you have created, have approved, or can approve. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/pam/grants/list b/gcloud/alpha/pam/grants/list index 9b0254d18..6c6d87475 100644 --- a/gcloud/alpha/pam/grants/list +++ b/gcloud/alpha/pam/grants/list @@ -1,6 +1,6 @@ NAME gcloud alpha pam grants list - list all Privileged Access Manager grants - under an entitlement + associated with an entitlement SYNOPSIS gcloud alpha pam grants list @@ -10,20 +10,20 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List all Privileged Access Manager (PAM) grants under an + (ALPHA) List all Privileged Access Manager (PAM) grants associated with an entitlement. EXAMPLES - The following command lists all grants under an entitlement with the full - name ENTITLEMENT_NAME: + The following command lists all grants associated with an entitlement with + the full name ENTITLEMENT_NAME: $ gcloud alpha pam grants list --entitlement=ENTITLEMENT_NAME REQUIRED FLAGS - Entitlement resource - Entitlement under which the grants are to be - listed. 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. + Entitlement resource - Entitlement the grants are associated with. 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 --entitlement on the command line with a fully diff --git a/gcloud/alpha/pam/grants/revoke b/gcloud/alpha/pam/grants/revoke index d8ad03de7..876029484 100644 --- a/gcloud/alpha/pam/grants/revoke +++ b/gcloud/alpha/pam/grants/revoke @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES The following command revokes a grant with the full name GRANT_NAME and a - reason revoke reason: + reason of revoke reason: $ gcloud alpha pam grants revoke GRANT_NAME --reason="revoke reason" diff --git a/gcloud/alpha/pam/grants/search b/gcloud/alpha/pam/grants/search index bd76d99d7..097c78ff7 100644 --- a/gcloud/alpha/pam/grants/search +++ b/gcloud/alpha/pam/grants/search @@ -1,7 +1,6 @@ NAME - gcloud alpha pam grants search - search and list all Privileged Access - Manager grants under an entitlement which you had created, had approved - or can approve + gcloud alpha pam grants search - search for and list all Privileged Access + Manager grants you have created, have approved, or can approve SYNOPSIS gcloud alpha pam grants search --caller-relationship=CALLER_RELATIONSHIP @@ -11,38 +10,41 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Search and list all Privileged Access Manager (PAM) grants under an - entitlement which you had created, had approved or can approve. + (ALPHA) Search for and list all Privileged Access Manager (PAM) grants you + have created, have approved, or can approve. EXAMPLES - The following command searches and lists all grants under an entitlement - with the full name ENTITLEMENT_NAME, which you had created: + The following command searches for and lists all grants you have created + which are associated with an entitlement with the full name + ENTITLEMENT_NAME: $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-created - The following command searches and lists all grants under an entitlement - with the full name ENTITLEMENT_NAME, which you had approved or denied: + The following command searches for and lists all grants you have approved + or denied which are associated with an entitlement with the full name + ENTITLEMENT_NAME: $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-approved - The following command searches and lists all grants under an entitlement - with the full name ENTITLEMENT_NAME, which you can approve: + The following command searches for and lists all grants you can approve + which are associated with an entitlement with the full name + ENTITLEMENT_NAME: $ gcloud alpha pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=can-approve REQUIRED FLAGS --caller-relationship=CALLER_RELATIONSHIP - Whether to search the grants which you had created, had approved or can + Whether to return grants you have created, have approved, or can approve. CALLER_RELATIONSHIP must be one of: can-approve, had-approved, had-created. - Entitlement resource - Entitlement under which the grants are to be - listed. 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. + Entitlement resource - Entitlement the grants are associated with. 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 --entitlement on the command line with a fully diff --git a/gcloud/alpha/pam/help b/gcloud/alpha/pam/help index 0066c37cb..1a3c023cc 100644 --- a/gcloud/alpha/pam/help +++ b/gcloud/alpha/pam/help @@ -1,31 +1,31 @@ NAME - gcloud alpha pam - manage Privileged Access Manager Entitlements and Grants + gcloud alpha pam - manage Privileged Access Manager entitlements and grants SYNOPSIS gcloud alpha pam GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) The gcloud pam command group lets you manage Privileged Access - Manager (PAM) Entitlements and Grants. + Manager (PAM) entitlements and grants. EXAMPLES - To check the PAM onboarding status for a project sample-project and - location global, run: + To check the PAM onboarding status for a project named sample-project and + in location global, run: $ gcloud alpha pam check-onboarding-status \ --project=sample-project --location=global - To check the PAM onboarding status for a folder sample-folder and location - global, run: + To check the PAM onboarding status for a folder with ID FOLDER_ID and in + location global, run: - $ gcloud alpha pam check-onboarding-status --folder=sample-folder \ + $ gcloud alpha pam check-onboarding-status --folder=FOLDER_ID \ --location=global - To check the PAM onboarding status for an organization sample-organization - and location global, run: + To check the PAM onboarding status for an organization with ID + ORGANIZATION_ID and in location global, run: $ gcloud alpha pam check-onboarding-status \ - --organization=sample-organization --location=global + --organization=ORGANIZATION_ID --location=global GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -36,10 +36,10 @@ GROUPS GROUP is one of the following: entitlements - (ALPHA) Manage Privileged Access Manager (PAM) Entitlements. + (ALPHA) Manage Privileged Access Manager (PAM) entitlements. grants - (ALPHA) Manage Privileged Access Manager (PAM) Grants. + (ALPHA) Manage Privileged Access Manager (PAM) grants. operations (ALPHA) Manage Privileged Access Manager (PAM) Long Running Operations. diff --git a/gcloud/alpha/pam/operations/help b/gcloud/alpha/pam/operations/help index 1c4e0abab..45b1c69cc 100644 --- a/gcloud/alpha/pam/operations/help +++ b/gcloud/alpha/pam/operations/help @@ -7,30 +7,30 @@ SYNOPSIS DESCRIPTION (ALPHA) The gcloud pam operations command group lets you manage Privileged - Access Manager (PAM) Operations. + Access Manager (PAM) operations. EXAMPLES To describe an operation with the full name OPERATION_NAME, run: $ gcloud alpha pam operations describe OPERATION_NAME - To list all operations under a project sample-project and location global, - run: + To list all operations in a project named sample-project and in location + global, run: $ gcloud alpha pam operations list --project=sample-project \ --location=global - To list all operations under a folder sample-folder and location global, - run: + To list all operations in a folder with ID FOLDER_ID and in location + global, run: - $ gcloud alpha pam operations list --folder=sample-folder \ + $ gcloud alpha pam operations list --folder=FOLDER_ID \ --location=global - To list all operations under an organization sample-organization and + To list all operations in an organization with ID ORGANIZATION_ID and in location global, run: - $ gcloud alpha pam operations list \ - --organization=sample-organization --location=global + $ gcloud alpha pam operations list --organization=ORGANIZATION_ID \ + --location=global To delete an operation with the full name OPERATION_NAME, run: diff --git a/gcloud/alpha/pam/operations/list b/gcloud/alpha/pam/operations/list index 3398c91d4..afec02cf8 100644 --- a/gcloud/alpha/pam/operations/list +++ b/gcloud/alpha/pam/operations/list @@ -13,29 +13,29 @@ DESCRIPTION under a project/folder/organization location. EXAMPLES - The following command lists all operations under a project sample-project - and location global: + The following command lists all operations in a project named + sample-project and in location global: $ gcloud alpha pam operations list --project=sample-project \ --location=global - The following command list all operations under a folder sample-folder and - location global: + The following command lists all operations in a folder with ID FOLDER_ID + and in location global: - $ gcloud alpha pam operations list --folder=sample-folder \ + $ gcloud alpha pam operations list --folder=FOLDER_ID \ --location=global - The following command list all operations under an organization - sample-organization and location global: + The following command lists all operations in an organization with ID + ORGANIZATION_ID and in location global: - $ gcloud alpha pam operations list \ - --organization=sample-organization --location=global + $ gcloud alpha pam operations list --organization=ORGANIZATION_ID \ + --location=global REQUIRED FLAGS - Location resource - Location under which the operations are to be listed. - 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. + Location resource - Location of the operations. 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 --location on the command line with a fully diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index 8ee2beebf..78f26a167 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -570,6 +570,9 @@ FLAGS this volume ◆ readonly: (optional) A boolean. If true, this volume will be read-only from all mounts. + ◆ mount-options: (optional) A list of flags to pass to GCSFuse. Flags + should be specified without leading dashes and separated by + semicolons. in-memory: An ephemeral volume that stores data in the instance's memory. With this type of volume, data is not shared between instances and all diff --git a/gcloud/alpha/run/jobs/create b/gcloud/alpha/run/jobs/create index b14ab64ac..3073ed4dd 100644 --- a/gcloud/alpha/run/jobs/create +++ b/gcloud/alpha/run/jobs/create @@ -159,6 +159,9 @@ FLAGS this volume ◆ readonly: (optional) A boolean. If true, this volume will be read-only from all mounts. + ◆ mount-options: (optional) A list of flags to pass to GCSFuse. Flags + should be specified without leading dashes and separated by + semicolons. in-memory: An ephemeral volume that stores data in the instance's memory. With this type of volume, data is not shared between instances diff --git a/gcloud/alpha/run/jobs/deploy b/gcloud/alpha/run/jobs/deploy index 4e7e95d41..fa05d07d6 100644 --- a/gcloud/alpha/run/jobs/deploy +++ b/gcloud/alpha/run/jobs/deploy @@ -164,6 +164,9 @@ FLAGS this volume ◆ readonly: (optional) A boolean. If true, this volume will be read-only from all mounts. + ◆ mount-options: (optional) A list of flags to pass to GCSFuse. Flags + should be specified without leading dashes and separated by + semicolons. in-memory: An ephemeral volume that stores data in the instance's memory. With this type of volume, data is not shared between instances diff --git a/gcloud/alpha/run/jobs/update b/gcloud/alpha/run/jobs/update index df1c14ef3..8cdeaaedd 100644 --- a/gcloud/alpha/run/jobs/update +++ b/gcloud/alpha/run/jobs/update @@ -174,6 +174,9 @@ FLAGS this volume ◆ readonly: (optional) A boolean. If true, this volume will be read-only from all mounts. + ◆ mount-options: (optional) A list of flags to pass to GCSFuse. Flags + should be specified without leading dashes and separated by + semicolons. in-memory: An ephemeral volume that stores data in the instance's memory. With this type of volume, data is not shared between instances diff --git a/gcloud/alpha/run/services/update b/gcloud/alpha/run/services/update index ea8ab159b..f2ad41fa7 100644 --- a/gcloud/alpha/run/services/update +++ b/gcloud/alpha/run/services/update @@ -456,6 +456,9 @@ FLAGS this volume ◆ readonly: (optional) A boolean. If true, this volume will be read-only from all mounts. + ◆ mount-options: (optional) A list of flags to pass to GCSFuse. Flags + should be specified without leading dashes and separated by + semicolons. in-memory: An ephemeral volume that stores data in the instance's memory. With this type of volume, data is not shared between instances and all diff --git a/gcloud/alpha/scc/findings/create b/gcloud/alpha/scc/findings/create index ae668635a..1765232ef 100644 --- a/gcloud/alpha/scc/findings/create +++ b/gcloud/alpha/scc/findings/create @@ -15,44 +15,37 @@ DESCRIPTION EXAMPLES Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached - to example-project under organization 123456 and source 5678: + to project with project number 9876 under organization 123456 and source + 5678: $ gcloud alpha scc findings create `testFinding` \ --organization=123456 --source=5678 --state=ACTIVE \ --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' + 9876' - Create an ACTIVE finding testFinding attached to example-project under - project example-project and source 5678: + Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached + to project with project number 9876 under organization 123456 and source + 5678 using the full resource name: $ gcloud alpha scc findings create \ - projects/example-project/sources/5678/findings/testFinding \ + organizations/123456/sources/5678/findings/testFinding \ --state=ACTIVE --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' - - Create an ACTIVE finding testFinding attached to example-project under - folder 456 and source 5678: - - $ gcloud alpha scc findings create \ - folders/456/sources/5678/findings/testFinding --state=ACTIVE \ - --category='XSS_SCRIPTING' \ - --event-time=2023-01-11T07:00:06.861Z \ - --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' + 9876' Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached - to example-project under organization 123456, source 5678 and location=eu: + to project with project number`9876 under organization 123456, source 5678 + and location=eu: $ gcloud alpha scc findings create `testFinding` \ --organization=123456 --source=5678 --state=ACTIVE \ --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' --location=eu + 9876' --location=eu POSITIONAL ARGUMENTS Finding resource - The finding to be used for the SCC (Security Command diff --git a/gcloud/beta/builds/submit b/gcloud/beta/builds/submit index 78a1b9571..d9074ccbc 100644 --- a/gcloud/beta/builds/submit +++ b/gcloud/beta/builds/submit @@ -58,6 +58,14 @@ EXAMPLES "projects/my-project/locations/us-west1/connections/my-conn/repo\ sitories/my-repo" --revision=main + To submit a build with source from a Developer Connect GitRepositoryLink + resource + projects/my-project/locations/us-west1/connections/my-conn/gitRepositoryLinks/my-repo-link: + + $ gcloud beta builds submit \ + "projects/my-project/locations/us-west1/connections/my-conn/gitR\ + epositoryLinks/my-repo-link" --revision=main + POSITIONAL ARGUMENTS At most one of these can be specified: @@ -96,9 +104,9 @@ FLAGS --dir=DIR Directory, relative to the source root, in which to run the build. This is used when the build source is a 2nd-gen Cloud Build repository - resource. This must be a relative path. If a step's dir is specified - and is an absolute path, this value is ignored for that step's - execution. + resource, or a Developer Connect GitRepositoryLink resource. This must + be a relative path. If a step's dir is specified and is an absolute + path, this value is ignored for that step's execution. --disk-size=DISK_SIZE Machine disk size (GB) to run the build. @@ -157,7 +165,8 @@ FLAGS --revision=REVISION Revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref to run the build. This is used when the - build source is a 2nd-gen Cloud Build repository resource. + build source is a 2nd-gen Cloud Build repository resource, or a + Developer Connect GitRepositoryLink resource. Cloud Build uses git fetch to fetch the revision from the Git repository; therefore make sure that the string you provide for diff --git a/gcloud/beta/compute/commitments/create b/gcloud/beta/compute/commitments/create index 5e2ab9b7c..d3c78c046 100644 --- a/gcloud/beta/compute/commitments/create +++ b/gcloud/beta/compute/commitments/create @@ -100,12 +100,12 @@ 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, - accelerator-optimized-a3, compute-optimized, compute-optimized-c2d, - compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, - general-purpose, general-purpose-e2, general-purpose-n2, - general-purpose-n2d, general-purpose-n4, general-purpose-t2d, - graphics-optimized, memory-optimized, memory-optimized-m3, - storage-optimized-z3. + accelerator-optimized-a3, accelerator-optimized-a3-mega, + compute-optimized, compute-optimized-c2d, compute-optimized-c3, + compute-optimized-c3d, compute-optimized-h3, general-purpose, + general-purpose-e2, general-purpose-n2, general-purpose-n2d, + general-purpose-n4, general-purpose-t2d, graphics-optimized, + memory-optimized, memory-optimized-m3, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/beta/compute/instance-templates/create-with-container b/gcloud/beta/compute/instance-templates/create-with-container index 813b75996..e59ad1485 100644 --- a/gcloud/beta/compute/instance-templates/create-with-container +++ b/gcloud/beta/compute/instance-templates/create-with-container @@ -28,7 +28,7 @@ SYNOPSIS [boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME]] [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] - [--labels=[KEY=VALUE,...]] + [--ipv6-network-tier=IPV6_NETWORK_TIER] [--labels=[KEY=VALUE,...]] [--local-ssd=[device-name=DEVICE-NAME],[interface=INTERFACE]] [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] [--metadata=KEY=VALUE,[KEY=VALUE,...]] @@ -39,8 +39,9 @@ SYNOPSIS [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--private-network-ip=PRIVATE_NETWORK_IP] [--region=REGION] [--no-restart-on-failure] [--shielded-integrity-monitoring] - [--shielded-secure-boot] [--shielded-vtpm] [--subnet=SUBNET] - [--tags=TAG,[TAG,...]] [--address=ADDRESS | --no-address] + [--shielded-secure-boot] [--shielded-vtpm] [--stack-type=STACK_TYPE] + [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--address=ADDRESS | --no-address] [--custom-cpu=CUSTOM_CPU --custom-memory=CUSTOM_MEMORY : --custom-extensions --custom-vm-type=CUSTOM_VM_TYPE] [--image-project=IMAGE_PROJECT --image=IMAGE @@ -416,6 +417,14 @@ FLAGS be used together with --external-ipv6-address. Only the /96 IP address range is supported, and the default value is 96. + --ipv6-network-tier=IPV6_NETWORK_TIER + Specifies the IPv6 network tier that will be used to configure the + instance network interface IPv6 access config. IPV6_NETWORK_TIER must + be (only one value is supported): + + PREMIUM + High quality, Google-grade network tier. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -644,6 +653,15 @@ FLAGS about how to modify Shielded VM options, see https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. + --stack-type=STACK_TYPE + Specifies whether IPv6 is enabled on the default network interface. If + not specified, IPV4_ONLY will be used. STACK_TYPE must be one of: + + IPV4_IPV6 + The network interface can have both IPv4 and IPv6 addresses + IPV4_ONLY + The network interface will be assigned IPv4 addresses + --subnet=SUBNET Specifies the subnet that the VM instances are a part of. If --network is also specified, subnet must be a subnetwork of the network specified diff --git a/gcloud/beta/compute/instances/create-with-container b/gcloud/beta/compute/instances/create-with-container index 8d493d0dd..9b00db9c9 100644 --- a/gcloud/beta/compute/instances/create-with-container +++ b/gcloud/beta/compute/instances/create-with-container @@ -31,7 +31,7 @@ SYNOPSIS [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] - [--labels=[KEY=VALUE,...]] + [--ipv6-network-tier=IPV6_NETWORK_TIER] [--labels=[KEY=VALUE,...]] [--local-ssd=[device-name=DEVICE-NAME],[interface=INTERFACE]] [--local-ssd-recovery-timeout=LOCAL_SSD_RECOVERY_TIMEOUT] [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] @@ -46,7 +46,7 @@ SYNOPSIS [--provisioning-model=PROVISIONING_MODEL] [--no-restart-on-failure] [--shielded-integrity-monitoring] [--shielded-secure-boot] [--shielded-vtpm] [--source-instance-template=SOURCE_INSTANCE_TEMPLATE] - [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] [--visible-core-count=VISIBLE_CORE_COUNT] [--zone=ZONE] [--address=ADDRESS | --no-address] @@ -456,6 +456,14 @@ FLAGS Default only for Spot VMs. Stop the VM without preserving memory. The VM can be restarted later. + --ipv6-network-tier=IPV6_NETWORK_TIER + Specifies the IPv6 network tier that will be used to configure the + instance network interface IPv6 access config. IPV6_NETWORK_TIER must + be (only one value is supported): + + PREMIUM + High quality, Google-grade network tier. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -706,6 +714,15 @@ FLAGS Users can also override machine type and labels. Values of other flags will be ignored and --source-instance-template will be used instead. + --stack-type=STACK_TYPE + Specifies whether IPv6 is enabled on the default network interface. If + not specified, IPV4_ONLY will be used. STACK_TYPE must be one of: + + IPV4_IPV6 + The network interface can have both IPv4 and IPv6 addresses + IPV4_ONLY + The network interface will be assigned IPv4 addresses + --subnet=SUBNET Specifies the subnet that the VM instances are a part of. If --network is also specified, subnet must be a subnetwork of the network specified diff --git a/gcloud/beta/compute/storage-pools/list b/gcloud/beta/compute/storage-pools/list index 2031b3cb2..f2bb90d8d 100644 --- a/gcloud/beta/compute/storage-pools/list +++ b/gcloud/beta/compute/storage-pools/list @@ -9,7 +9,7 @@ SYNOPSIS DESCRIPTION (BETA) View storage pools. - The compact default output format is explained below: + The compact, default output format is explained below: The type column contains all three types -- storage pool type, capacity and performance. For example, the value @@ -29,8 +29,9 @@ DESCRIPTION ▪ Adv: Advanced ▪ Std: Standard - The capacity, iops and throughput columns describe used, provisioned, the - utilization rate. For example, the following value for capacity: + The capacity column, and standard-performance iops and throughput columns + describe the used, provisioned, and the utilization rate. For example, the + following value for capacity: 40 / 50 (80%) @@ -38,6 +39,9 @@ DESCRIPTION 80%. The utilization rate is equivalent to used capacity divided by provisioned capacity. + For advanced-performance storage pools, the iops and throughput columns + will simply show the provisioned values. + EXAMPLES To display all storage pools in all regions and zones, run the following command: diff --git a/gcloud/beta/config/get b/gcloud/beta/config/get index 1fb27d81a..996014821 100644 --- a/gcloud/beta/config/get +++ b/gcloud/beta/config/get @@ -269,9 +269,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/beta/config/help b/gcloud/beta/config/help index 290a8eeb4..16d8da7e8 100644 --- a/gcloud/beta/config/help +++ b/gcloud/beta/config/help @@ -301,9 +301,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/beta/config/list b/gcloud/beta/config/list index ce27a137c..f0b4378ce 100644 --- a/gcloud/beta/config/list +++ b/gcloud/beta/config/list @@ -313,9 +313,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/beta/config/set b/gcloud/beta/config/set index f50e8aec8..f599e98ec 100644 --- a/gcloud/beta/config/set +++ b/gcloud/beta/config/set @@ -316,9 +316,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/beta/config/unset b/gcloud/beta/config/unset index 775d6cf4d..377673eec 100644 --- a/gcloud/beta/config/unset +++ b/gcloud/beta/config/unset @@ -277,9 +277,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/beta/container/fleet/mesh/debug/proxy-config b/gcloud/beta/container/fleet/mesh/debug/proxy-config index 3dee367a4..16ced4cce 100644 --- a/gcloud/beta/container/fleet/mesh/debug/proxy-config +++ b/gcloud/beta/container/fleet/mesh/debug/proxy-config @@ -24,21 +24,19 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --type=TYPE - Proxy configuration type, one of - all|clusters|listeners|routes|endpoints|bootstrap|log|secret + Proxy configuration type to retrieve. - all Retrieves all configuration for the Envoy in the specified pod - bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod - cluster Retrieves cluster configuration for the Envoy in the specified pod - ecds Retrieves typed extension configuration for the Envoy in the specified pod - endpoint Retrieves endpoint configuration for the Envoy in the specified pod - listener Retrieves listener configuration for the Envoy in the specified pod - log Retrieves logging levels of the Envoy in the specified pod - route Retrieves route configuration for the Envoy in the specified pod - secret Retrieves secret configuration for the Envoy in the specified pod + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + clusters/cluster Retrieves cluster configuration for the Envoy in the specified pod + endpoints/endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listeners/listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + routes/route Retrieves route configuration for the Envoy in the specified pod + secrets/secret Retrieves secret configuration for the Envoy in the specified pod - TYPE must be one of: all, bootstrap, cluster, listeners, routes, - endpoints, listener, log, secret. + TYPE must be one of: all, bootstrap, cluster, clusters, endpoint, + endpoints, listener, listeners, log, route, routes, secret, secrets. Membership resource - The group of arguments defining a membership. The arguments in this group can be used to specify the attributes of this diff --git a/gcloud/beta/container/hub/mesh/debug/proxy-config b/gcloud/beta/container/hub/mesh/debug/proxy-config index 3a72fabee..69e8dd3c6 100644 --- a/gcloud/beta/container/hub/mesh/debug/proxy-config +++ b/gcloud/beta/container/hub/mesh/debug/proxy-config @@ -24,21 +24,19 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --type=TYPE - Proxy configuration type, one of - all|clusters|listeners|routes|endpoints|bootstrap|log|secret + Proxy configuration type to retrieve. - all Retrieves all configuration for the Envoy in the specified pod - bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod - cluster Retrieves cluster configuration for the Envoy in the specified pod - ecds Retrieves typed extension configuration for the Envoy in the specified pod - endpoint Retrieves endpoint configuration for the Envoy in the specified pod - listener Retrieves listener configuration for the Envoy in the specified pod - log Retrieves logging levels of the Envoy in the specified pod - route Retrieves route configuration for the Envoy in the specified pod - secret Retrieves secret configuration for the Envoy in the specified pod + all Retrieves all configuration for the Envoy in the specified pod + bootstrap Retrieves bootstrap configuration for the Envoy in the specified pod + clusters/cluster Retrieves cluster configuration for the Envoy in the specified pod + endpoints/endpoint Retrieves endpoint configuration for the Envoy in the specified pod + listeners/listener Retrieves listener configuration for the Envoy in the specified pod + log Retrieves logging levels of the Envoy in the specified pod + routes/route Retrieves route configuration for the Envoy in the specified pod + secrets/secret Retrieves secret configuration for the Envoy in the specified pod - TYPE must be one of: all, bootstrap, cluster, listeners, routes, - endpoints, listener, log, secret. + TYPE must be one of: all, bootstrap, cluster, clusters, endpoint, + endpoints, listener, listeners, log, route, routes, secret, secrets. Membership resource - The group of arguments defining a membership. The arguments in this group can be used to specify the attributes of this diff --git a/gcloud/beta/dataflow/help b/gcloud/beta/dataflow/help index 3ece81abc..7eb69c17a 100644 --- a/gcloud/beta/dataflow/help +++ b/gcloud/beta/dataflow/help @@ -44,7 +44,7 @@ GROUPS (BETA) A group of subcommands for working with Dataflow SQL. yaml - (BETA) A group of subcommands for launching beam yaml jobs on Dataflow. + (BETA) A group of subcommands for launching Beam YAML jobs on Dataflow. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/dataflow/yaml/help b/gcloud/beta/dataflow/yaml/help index 51e087e15..685d8d73a 100644 --- a/gcloud/beta/dataflow/yaml/help +++ b/gcloud/beta/dataflow/yaml/help @@ -1,12 +1,12 @@ NAME - gcloud beta dataflow yaml - a group of subcommands for launching beam yaml + gcloud beta dataflow yaml - a group of subcommands for launching Beam YAML jobs on Dataflow SYNOPSIS gcloud beta dataflow yaml COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) A group of subcommands for launching beam yaml jobs on Dataflow. + (BETA) A group of subcommands for launching Beam YAML jobs on Dataflow. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -20,5 +20,8 @@ COMMANDS (BETA) Runs a job from the specified path. NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud dataflow yaml diff --git a/gcloud/beta/dataflow/yaml/run b/gcloud/beta/dataflow/yaml/run index c30e5e9f9..004eef86d 100644 --- a/gcloud/beta/dataflow/yaml/run +++ b/gcloud/beta/dataflow/yaml/run @@ -9,10 +9,11 @@ SYNOPSIS [--region=REGION_ID] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Runs a job from the specified yaml description or gcs path. + (BETA) Runs a job from the specified YAML description or Cloud Storage + path. EXAMPLES - To run a job from yaml, run: + To run a job from YAML, run: $ gcloud beta dataflow yaml run my-job \ --yaml-pipeline-file=gs://yaml-path --region=europe-west1 @@ -25,10 +26,10 @@ REQUIRED FLAGS Exactly one of these must be specified: --yaml-pipeline=YAML_PIPELINE - Inline definition of the yaml pipeline to run. + Inline definition of the YAML pipeline to run. --yaml-pipeline-file=YAML_PIPELINE_FILE - Path of a file defining the yaml pipeline to run. (Must be a local + Path of a file defining the YAML pipeline to run. (Must be a local file or a URL beginning with 'gs://'.) OPTIONAL FLAGS @@ -47,5 +48,8 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud dataflow yaml run diff --git a/gcloud/beta/emulators/firestore/start b/gcloud/beta/emulators/firestore/start index edd710fd5..f8d2f214c 100644 --- a/gcloud/beta/emulators/firestore/start +++ b/gcloud/beta/emulators/firestore/start @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud beta emulators firestore start [--database-mode=DATABASE_MODE] - [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] + [--export-on-exit=EXPORT_ON_EXIT] [--host-port=HOST_PORT] + [--import-data=IMPORT_DATA] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command starts a local Firestore emulator. @@ -26,6 +27,15 @@ EXAMPLES $ gcloud beta emulators firestore start \ --database-mode=datastore-mode + To import data at the start of the Firestore emulator, run: + + $ gcloud beta emulators firestore start --import-data= + + To export emulator data upon emulator shutdown, run: + + $ gcloud beta emulators firestore start \ + --export-on-exit= + FLAGS --database-mode=DATABASE_MODE The database mode to start the Firestore Emulator in. The valid options @@ -34,6 +44,10 @@ FLAGS `firestore-native` (default): start the emulator in Firestore Native `datastore-mode`: start the emulator in Datastore Mode + --export-on-exit=EXPORT_ON_EXIT + Directory path in which emulator data will be saved upon shutdown. + Example:/home/user/myexports/2024-03-26/ + --host-port=HOST_PORT The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port: @@ -46,6 +60,10 @@ FLAGS The default value is localhost:8080. + --import-data=IMPORT_DATA + File path to the data to be loaded into the emulator upon start up. + Example:/home/user/myexports/sampleExport/sampleExport.overall_export_metadata. + --rules=RULES If set, all projects will use the security rules in this file. More information on Firebase Rules and the syntax for this file is available diff --git a/gcloud/beta/functions/deploy b/gcloud/beta/functions/deploy index 7b6f368ce..3ebe6e6a9 100644 --- a/gcloud/beta/functions/deploy +++ b/gcloud/beta/functions/deploy @@ -146,7 +146,12 @@ FLAGS function and using its generation. --ignore-file=IGNORE_FILE - Override the .gcloudignore file and use the specified file instead. + Override the .gcloudignore file in the source directory and use the + specified file instead. By default, the source directory is your + current directory. Note that it could be changed by the --source flag, + in which case your .gcloudignore file will be searched in the + overridden directory. For example, --ignore-file=.mygcloudignore + combined with --source=./mydir would point to ./mydir/.mygcloudignore --ingress-settings=INGRESS_SETTINGS Ingress settings controls what traffic can reach the function. By diff --git a/gcloud/beta/network-connectivity/regional-endpoints/create b/gcloud/beta/network-connectivity/regional-endpoints/create index f9d372f19..b5688e2ff 100644 --- a/gcloud/beta/network-connectivity/regional-endpoints/create +++ b/gcloud/beta/network-connectivity/regional-endpoints/create @@ -101,5 +101,8 @@ API REFERENCE https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud network-connectivity regional-endpoints create diff --git a/gcloud/beta/network-connectivity/regional-endpoints/delete b/gcloud/beta/network-connectivity/regional-endpoints/delete index 01058bb04..0b22da500 100644 --- a/gcloud/beta/network-connectivity/regional-endpoints/delete +++ b/gcloud/beta/network-connectivity/regional-endpoints/delete @@ -66,5 +66,8 @@ API REFERENCE https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud network-connectivity regional-endpoints delete diff --git a/gcloud/beta/network-connectivity/regional-endpoints/describe b/gcloud/beta/network-connectivity/regional-endpoints/describe index edee7e23c..1da91e9b5 100644 --- a/gcloud/beta/network-connectivity/regional-endpoints/describe +++ b/gcloud/beta/network-connectivity/regional-endpoints/describe @@ -62,5 +62,8 @@ API REFERENCE https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud network-connectivity regional-endpoints describe diff --git a/gcloud/beta/network-connectivity/regional-endpoints/help b/gcloud/beta/network-connectivity/regional-endpoints/help index 47b6ca7cb..edc117ef4 100644 --- a/gcloud/beta/network-connectivity/regional-endpoints/help +++ b/gcloud/beta/network-connectivity/regional-endpoints/help @@ -30,5 +30,8 @@ COMMANDS (BETA) List regional endpoints. NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud network-connectivity regional-endpoints diff --git a/gcloud/beta/network-connectivity/regional-endpoints/list b/gcloud/beta/network-connectivity/regional-endpoints/list index c7e061342..7dbabde69 100644 --- a/gcloud/beta/network-connectivity/regional-endpoints/list +++ b/gcloud/beta/network-connectivity/regional-endpoints/list @@ -76,5 +76,8 @@ API REFERENCE https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud network-connectivity regional-endpoints list diff --git a/gcloud/beta/pam/check-onboarding-status b/gcloud/beta/pam/check-onboarding-status index 134190639..555f21e32 100644 --- a/gcloud/beta/pam/check-onboarding-status +++ b/gcloud/beta/pam/check-onboarding-status @@ -12,23 +12,23 @@ DESCRIPTION project/organization/folder location. EXAMPLES - The following command checks the PAM onboarding status for a project - sample-project and location global: + The following command checks the PAM onboarding status for a project named + sample-project and in location global: $ gcloud beta pam check-onboarding-status --project=sample-project \ --location=global - The following command checks the PAM onboarding status for a folder - sample-folder and location global: + The following command checks the PAM onboarding status for a folder with ID + FOLDER_ID and in location global: - $ gcloud beta pam check-onboarding-status --folder=sample-folder \ + $ gcloud beta pam check-onboarding-status --folder=FOLDER_ID \ --location=global The following command checks the PAM onboarding status for an organization - sample-organization and location global: + with ID ORGANIZATION_ID and in location global: $ gcloud beta pam check-onboarding-status \ - --organization=sample-organization --location=global + --organization=ORGANIZATION_ID --location=global REQUIRED FLAGS Location resource - The project/organization/folder location for which the diff --git a/gcloud/beta/pam/entitlements/create b/gcloud/beta/pam/entitlements/create index 4a24953b5..9ebc05f73 100644 --- a/gcloud/beta/pam/entitlements/create +++ b/gcloud/beta/pam/entitlements/create @@ -9,33 +9,35 @@ SYNOPSIS --entitlement-file=ENTITLEMENT_FILE [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Create a new Privileged Access Manager (PAM) entitlement under a + (BETA) Create a new Privileged Access Manager (PAM) entitlement in a project/folder/organization location. EXAMPLES - The following command creates a new entitlement with the name - sample-entitlement, under a project sample-project, location global and the - entitlement body present in the sample-entitlement.yaml file: + The following command creates a new entitlement with a name of + sample-entitlement, in a project named sample-project, in location global, + and the entitlement configuration stored in a file named + sample-entitlement.yaml: $ gcloud beta pam entitlements create sample-entitlement \ --project=sample-project --location=global \ --entitlement-file=sample-entitlement.yaml - The following command creates a new entitlement with the name - sample-entitlement, under a folder sample-folder, location global and the - entitlement body present in the sample-entitlement.yaml file: + The following command creates a new entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, in location global, and + the entitlement configuration stored in a file named + sample-entitlement.yaml: $ gcloud beta pam entitlements create sample-entitlement \ - --folder=sample-folder --location=global \ + --folder=FOLDER_ID --location=global \ --entitlement-file=sample-entitlement.yaml - The following command creates a new entitlement with the name - sample-entitlement, under an organization sample-organization, location - global and the entitlement body present in the sample-entitlement.yaml - file: + The following command creates a new entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, in location + global, and the entitlement configuration stored in a file named + sample-entitlement.yaml: $ gcloud beta pam entitlements create sample-entitlement \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --entitlement-file=sample-entitlement.yaml POSITIONAL ARGUMENTS @@ -96,7 +98,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --entitlement-file=ENTITLEMENT_FILE - YAML file containing the body of the entitlement to be created. + YAML file containing the configuration of the entitlement. OPTIONAL FLAGS --async diff --git a/gcloud/beta/pam/entitlements/delete b/gcloud/beta/pam/entitlements/delete index fbdb6474e..0a0088d9d 100644 --- a/gcloud/beta/pam/entitlements/delete +++ b/gcloud/beta/pam/entitlements/delete @@ -10,16 +10,31 @@ SYNOPSIS DESCRIPTION (BETA) Delete a Privileged Access Manager (PAM) entitlement along with all - grants under it. + grants associated with it. This command can fail for the following reasons: ▪ There are non-terminal grants under the entitlement. EXAMPLES - The following command deletes an entitlement with the full name - ENTITLEMENT_NAME along with all grants under it: + The following command deletes an entitlement with a name of + sample-entitlement, in a project named sample-project, and in location + global: - $ gcloud beta pam entitlements delete ENTITLEMENT_NAME + $ gcloud beta pam entitlements delete sample-entitlement \ + --project=sample-project --location=global + + The following command deletes an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, and in location global: + + $ gcloud beta pam entitlements delete sample-entitlement \ + --folder=FOLDER_ID --location=global + + The following command deletes an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, and in + location global: + + $ gcloud beta pam entitlements delete sample-entitlement \ + --organization=ORGANIZATION_ID --location=global POSITIONAL ARGUMENTS Entitlement resource - Name of the entitlement to delete. The arguments in diff --git a/gcloud/beta/pam/entitlements/describe b/gcloud/beta/pam/entitlements/describe index b04c5a3d9..8efa15332 100644 --- a/gcloud/beta/pam/entitlements/describe +++ b/gcloud/beta/pam/entitlements/describe @@ -12,10 +12,25 @@ DESCRIPTION (BETA) Show details of a Privileged Access Manager (PAM) entitlement. EXAMPLES - The following command describes an entitlement with the full name - ENTITLEMENT_NAME: + The following command describes an entitlement with a name of + sample-entitlement, in a project named sample-project, and in location + global: - $ gcloud beta pam entitlements describe ENTITLEMENT_NAME + $ gcloud beta pam entitlements describe sample-entitlement \ + --project=sample-project --location=global + + The following command describes an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, and in location global: + + $ gcloud beta pam entitlements describe sample-entitlement \ + --folder=FOLDER_ID --location=global + + The following command describes an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, and in + location global: + + $ gcloud beta pam entitlements describe sample-entitlement \ + --organization=ORGANIZATION_ID --location=global POSITIONAL ARGUMENTS Entitlement resource - Name of the entitlement to describe. The arguments diff --git a/gcloud/beta/pam/entitlements/export b/gcloud/beta/pam/entitlements/export index 4b701a20d..e3f59504c 100644 --- a/gcloud/beta/pam/entitlements/export +++ b/gcloud/beta/pam/entitlements/export @@ -13,11 +13,29 @@ DESCRIPTION YAML file. EXAMPLES - The following command exports an entitlement with the full name - ENTITLEMENT_NAME to a local YAML file entitlement-file.yaml: + The following command exports an entitlement with a name of + sample-entitlement, in a project named sample-project, and in location + global to a local YAML file named sample-entitlement.yaml: - $ gcloud beta pam entitlements export ENTITLEMENT_NAME \ - --destination=entitlement-file.yaml + $ gcloud beta pam entitlements export sample-entitlement \ + --project=sample-project --location=global \ + --destination=sample-entitlement.yaml + + The following command exports an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, and in location global + to a local YAML file named sample-entitlement.yaml: + + $ gcloud beta pam entitlements export sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --destination=sample-entitlement.yaml + + The following command exports an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, and in + location global to a local YAML file named sample-entitlement.yaml: + + $ gcloud beta pam entitlements export sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ + --destination=sample-entitlement.yaml POSITIONAL ARGUMENTS Entitlement resource - Name of the entitlement to export. The arguments in diff --git a/gcloud/beta/pam/entitlements/help b/gcloud/beta/pam/entitlements/help index 466cea9e2..91636145b 100644 --- a/gcloud/beta/pam/entitlements/help +++ b/gcloud/beta/pam/entitlements/help @@ -1,115 +1,180 @@ NAME gcloud beta pam entitlements - manage Privileged Access Manager - Entitlements + entitlements SYNOPSIS gcloud beta pam entitlements COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) The gcloud pam entitlements command group lets you manage Privileged - Access Manager (PAM) Entitlements. + Access Manager (PAM) entitlements. EXAMPLES - To create a new entitlement with the name sample-entitlement, under a - project sample-project, location global and the entitlement body present in - the sample-entitlement.yaml file, run: + To create a new entitlement with a name of sample-entitlement, in a project + named sample-project, in location global, and the entitlement configuration + stored in a file named sample-entitlement.yaml, run: $ gcloud beta pam entitlements create sample-entitlement \ --project=sample-project --location=global \ --entitlement-file=sample-entitlement.yaml - To create a new entitlement with the name sample-entitlement, under a - folder sample-folder, location global and the entitlement body present in - the sample-entitlement.yaml file, run: + To create a new entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, in location global, and the entitlement configuration + stored in a file named sample-entitlement.yaml, run: $ gcloud beta pam entitlements create sample-entitlement \ - --folder=sample-folder --location=global \ + --folder=FOLDER_ID --location=global \ --entitlement-file=sample-entitlement.yaml - To create a new entitlement with the name sample-entitlement, under an - organization sample-organization, location global and the entitlement body - present in the sample-entitlement.yaml file, run: + To create a new entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, in location global, and the + entitlement configuration stored in a file named sample-entitlement.yaml, + run: $ gcloud beta pam entitlements create sample-entitlement \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --entitlement-file=sample-entitlement.yaml - To update an entitlement with the full name ENTITLEMENT_NAME and the new - entitlement body present in the sample-entitlement.yaml file, run: + To update an entitlement with a name of sample-entitlement, in a project + named sample-project, in location global, and the new entitlement + configuration stored in a file named sample-entitlement.yaml, run: - $ gcloud beta pam entitlements update ENTITLEMENT_NAME \ + $ gcloud beta pam entitlements update sample-entitlement \ + --project=sample-project --location=global \ --entitlement-file=sample-entitlement.yaml - To describe an entitlement with the full name ENTITLEMENT_NAME, run: + To update an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, in location global, and the new entitlement + configuration stored in a file named sample-entitlement.yaml, run: - $ gcloud beta pam entitlements describe ENTITLEMENT_NAME + $ gcloud beta pam entitlements update sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --entitlement-file=sample-entitlement.yaml - To search and list all entitlements under a project sample-project and - location global for which you are a requester, run: + To update an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, in location global, and the new + entitlement configuration stored in a file named sample-entitlement.yaml, + run: + + $ gcloud beta pam entitlements update sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ + --entitlement-file=sample-entitlement.yaml + + To describe an entitlement with a name of sample-entitlement, in a project + named sample-project, and in location global, run: + + $ gcloud beta pam entitlements describe sample-entitlement \ + --project=sample-project --location=global + + To describe an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, and in location global, run: + + $ gcloud beta pam entitlements describe sample-entitlement \ + --folder=FOLDER_ID --location=global + + To describe an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, and in location global, run: + + $ gcloud beta pam entitlements describe sample-entitlement \ + --organization=ORGANIZATION_ID --location=global + + To search for and list all entitlements for which you are a requester, in a + project named sample-project, and in location global, run: $ gcloud beta pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-requester - To search and list all entitlements under a project sample-project and - location global for which you are an approver, run: + To search for and list all entitlements for which you are an approver, in a + project named sample-project, and in location global, run: $ gcloud beta pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-approver - To search and list all entitlements under a folder sample-folder and - location global for which you are a requester, run: + To search for and list all entitlements for which you are a requester, in a + folder with ID FOLDER_ID, and in location global, run: - $ gcloud beta pam entitlements search --folder=sample-folder \ + $ gcloud beta pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-requester - To search and list all entitlements under a folder sample-folder and - location global for which you are an approver, run: + To search for and list all entitlements for which you are an approver, in a + folder with ID FOLDER_ID, and in location global, run: - $ gcloud beta pam entitlements search --folder=sample-folder \ + $ gcloud beta pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-approver - To search and list all entitlements under an organization - sample-organization and location global for which you are a requester, run: + To search for and list all entitlements for which you are a requester, in + an organization with ID ORGANIZATION_ID, and in location global, run: $ gcloud beta pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-requester - To search and list all entitlements under an organization - sample-organization and location global for which you are an approver, run: + To search for and list all entitlements for which you are an approver, in + an organization with ID ORGANIZATION_ID, and in location global, run: $ gcloud beta pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-approver - To list all entitlement under a project sample-project and location global, - run: + To list all entitlements in a project named sample-project and in location + global, run: $ gcloud beta pam entitlements list --project=sample-project \ --location=global - To list all entitlement under a folder sample-folder and location global, - run: + To list all entitlements in a folder with ID FOLDER_ID and in location + global, run: - $ gcloud beta pam entitlements list --folder=sample-folder \ + $ gcloud beta pam entitlements list --folder=FOLDER_ID \ --location=global - To list all entitlement under an organization sample-organization and + To list all entitlements in an organization with ID ORGANIZATION_ID and in location global, run: - $ gcloud beta pam entitlements list \ - --organization=sample-organization --location=global + $ gcloud beta pam entitlements list --organization=ORGANIZATION_ID \ + --location=global - To delete an entitlement with the full name ENTITLEMENT_NAME along with all - grants under it, run: + To delete an entitlement with a name of sample-entitlement, in a project + named sample-project, and in location global, run: - $ gcloud beta pam entitlements delete ENTITLEMENT_NAME + $ gcloud beta pam entitlements delete sample-entitlement \ + --project=sample-project --location=global - To export an entitlement with the full name ENTITLEMENT_NAME to a local - YAML file entitlement-file.yaml, run: + To delete an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, and in location global, run: - $ gcloud beta pam entitlements export ENTITLEMENT_NAME \ - --destination=entitlement-file.yaml + $ gcloud beta pam entitlements delete sample-entitlement \ + --folder=FOLDER_ID --location=global + + To delete an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, and in location global, run: + + $ gcloud beta pam entitlements delete sample-entitlement \ + --organization=ORGANIZATION_ID --location=global + + To export an entitlement with a name of sample-entitlement, in a project + named sample-project, and in location global to a local YAML file named + sample-entitlement.yaml, run: + + $ gcloud beta pam entitlements export sample-entitlement \ + --project=sample-project --location=global \ + --destination=sample-entitlement.yaml + + To export an entitlement with a name of sample-entitlement, in a folder + with ID FOLDER_ID, and in location global to a local YAML file named + sample-entitlement.yaml, run: + + $ gcloud beta pam entitlements export sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --destination=sample-entitlement.yaml + + To export an entitlement with a name of sample-entitlement, in an + organization with ID ORGANIZATION_ID, and in location global to a local + YAML file named sample-entitlement.yaml, run: + + $ gcloud beta pam entitlements export sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ + --destination=sample-entitlement.yaml GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -138,7 +203,7 @@ COMMANDS search (BETA) Search and list all Privileged Access Manager (PAM) entitlements - under a parent for which you are either a requester or an approver. + in a parent for which you are either a requester or an approver. update (BETA) Update an existing Privileged Access Manager (PAM) entitlement. diff --git a/gcloud/beta/pam/entitlements/list b/gcloud/beta/pam/entitlements/list index bccafbf5f..ef0a2cfc3 100644 --- a/gcloud/beta/pam/entitlements/list +++ b/gcloud/beta/pam/entitlements/list @@ -9,33 +9,33 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List all Privileged Access Manager (PAM) entitlements under a + (BETA) List all Privileged Access Manager (PAM) entitlements in a project/folder/organization location. EXAMPLES - The following command lists all entitlement under a project sample-project - and location global: + The following command lists all entitlements in a project named + sample-project and in location global: $ gcloud beta pam entitlements list --project=sample-project \ --location=global - The following command lists all entitlement under a folder sample-folder - and location global: + The following command lists all entitlements in a folder with ID FOLDER_ID + and in location global: - $ gcloud beta pam entitlements list --folder=sample-folder \ + $ gcloud beta pam entitlements list --folder=FOLDER_ID \ --location=global - The following command lists all entitlement under an organization - sample-organization and location global: + The following command lists all entitlements in an organization with ID + ORGANIZATION_ID and in location global: - $ gcloud beta pam entitlements list \ - --organization=sample-organization --location=global + $ gcloud beta pam entitlements list --organization=ORGANIZATION_ID \ + --location=global REQUIRED FLAGS - Location resource - Location under which the entitlements are to be - listed. 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. + Location resource - Location of the entitlements. 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 --location on the command line with a fully diff --git a/gcloud/beta/pam/entitlements/search b/gcloud/beta/pam/entitlements/search index 6a81bd7d5..f208fa8db 100644 --- a/gcloud/beta/pam/entitlements/search +++ b/gcloud/beta/pam/entitlements/search @@ -1,7 +1,7 @@ NAME gcloud beta pam entitlements search - search and list all Privileged Access - Manager entitlements under a parent for which you are either a - requester or an approver + Manager entitlements in a parent for which you are either a requester + or an approver SYNOPSIS gcloud beta pam entitlements search --caller-access-type=CALLER_ACCESS_TYPE @@ -10,61 +10,61 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Search and list all Privileged Access Manager (PAM) entitlements - under a project/folder/organization location for which you are either a - requester or an approver. + (BETA) Search and list all Privileged Access Manager (PAM) entitlements in + a project/folder/organization location for which you are either a requester + or an approver. EXAMPLES - The following command searches and lists all entitlements under a project - sample-project and location global for which you are a requester: + The following command searches for and lists all entitlements for which you + are a requester, in a project named sample-project, and in location global: $ gcloud beta pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-requester - The following command searches and lists all entitlements under a project - sample-project and location global for which you are an approver: + The following command searches for and lists all entitlements for which you + are an approver, in a project named sample-project, and in location global: $ gcloud beta pam entitlements search --project=sample-project \ --location=global --caller-access-type=grant-approver - The following command searches and lists all entitlements under a folder - sample-folder and location global for which you are a requester: + The following command searches for and lists all entitlements for which you + are a requester, in a folder with ID FOLDER_ID, and in location global: - $ gcloud beta pam entitlements search --folder=sample-folder \ + $ gcloud beta pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-requester - The following command searches and lists all entitlements under a folder - sample-folder and location global for which you are an approver: + The following command searches for and lists all entitlements for which you + are an approver, in a folder with ID FOLDER_ID, and in location global: - $ gcloud beta pam entitlements search --folder=sample-folder \ + $ gcloud beta pam entitlements search --folder=FOLDER_ID \ --location=global --caller-access-type=grant-approver - The following command searches and lists all entitlements under an - organization sample-organization and location global for which you are a - requester: + The following command searches for and lists all entitlements for which you + are a requester, in an organization with ID ORGANIZATION_ID, and in + location global: $ gcloud beta pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-requester - The following command searches and lists all entitlements under an - organization sample-organization and location global for which you are an - approver: + The following command searches for and lists all entitlements for which you + are an approver, in an organization with ID ORGANIZATION_ID, and in + location global: $ gcloud beta pam entitlements search \ - --organization=sample-organization --location=global \ + --organization=ORGANIZATION_ID --location=global \ --caller-access-type=grant-approver REQUIRED FLAGS --caller-access-type=CALLER_ACCESS_TYPE - Whether to search the entitlements for which you are a requester or + Search for entitlements based on whether you are a requester or approver. CALLER_ACCESS_TYPE must be one of: grant-approver, grant-requester. - Location resource - Location under which the entitlements are to be - listed. 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. + Location resource - Location of the entitlements. 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 --location on the command line with a fully diff --git a/gcloud/beta/pam/entitlements/update b/gcloud/beta/pam/entitlements/update index d441dedfe..e41bf0026 100644 --- a/gcloud/beta/pam/entitlements/update +++ b/gcloud/beta/pam/entitlements/update @@ -12,11 +12,31 @@ DESCRIPTION (BETA) Update an existing Privileged Access Manager (PAM) entitlement. EXAMPLES - The following command updates an entitlement with the full name - ENTITLEMENT_NAME and the new entitlement body present in the - sample-entitlement.yaml file: + The following command updates an entitlement with a name of + sample-entitlement, in a project named sample-project, in location global, + and the new entitlement configuration stored in a file named + sample-entitlement.yaml: - $ gcloud beta pam entitlements update ENTITLEMENT_NAME \ + $ gcloud beta pam entitlements update sample-entitlement \ + --project=sample-project --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command updates an entitlement with a name of + sample-entitlement, in a folder with ID FOLDER_ID, in location global, and + the new entitlement configuration stored in a file named + sample-entitlement.yaml: + + $ gcloud beta pam entitlements update sample-entitlement \ + --folder=FOLDER_ID --location=global \ + --entitlement-file=sample-entitlement.yaml + + The following command updates an entitlement with a name of + sample-entitlement, in an organization with ID ORGANIZATION_ID, in location + global, and the new entitlement configuration stored in a file named + sample-entitlement.yaml: + + $ gcloud beta pam entitlements update sample-entitlement \ + --organization=ORGANIZATION_ID --location=global \ --entitlement-file=sample-entitlement.yaml POSITIONAL ARGUMENTS @@ -77,7 +97,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --entitlement-file=ENTITLEMENT_FILE - YAML file containing the new body of the entitlement. + YAML file containing the new configuration of the entitlement. OPTIONAL FLAGS --async diff --git a/gcloud/beta/pam/grants/approve b/gcloud/beta/pam/grants/approve index e6bc50eaf..5ea1b0422 100644 --- a/gcloud/beta/pam/grants/approve +++ b/gcloud/beta/pam/grants/approve @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES The following command approves a grant with the full name GRANT_NAME and a - reason approval reason: + reason of approval reason: $ gcloud beta pam grants approve GRANT_NAME \ --reason="approval reason" diff --git a/gcloud/beta/pam/grants/create b/gcloud/beta/pam/grants/create index 48aaa09d2..f52a3aef6 100644 --- a/gcloud/beta/pam/grants/create +++ b/gcloud/beta/pam/grants/create @@ -14,9 +14,9 @@ DESCRIPTION entitlement. EXAMPLES - The following command creates a new grant under an entitlement with the - full name ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a - justification some justification and two additional email recipients + The following command creates a new grant against the entitlement with the + full name ENTITLEMENT_NAME, a requested duration of 1 hour 30 minutes, a + justification of some justification and two additional email recipients abc@example.com and xyz@example.com: $ gcloud beta pam grants create --entitlement=ENTITLEMENT_NAME \ @@ -28,8 +28,8 @@ REQUIRED FLAGS --requested-duration=REQUESTED_DURATION Duration of the grant being created. - Entitlement resource - Entitlement under which the grant is to be created - The arguments in this group can be used to specify the attributes of this + Entitlement resource - Entitlement the grant is to be created against. 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. @@ -85,8 +85,8 @@ REQUIRED FLAGS OPTIONAL FLAGS --additional-email-recipients=[ADDITIONAL_EMAIL_RECIPIENTS,...] - Additional email addresses who will be notified for all the actions - performed on the grant. + Additional email addresses that are notified for all actions performed + on the grant. --justification=JUSTIFICATION Justification for the grant. diff --git a/gcloud/beta/pam/grants/deny b/gcloud/beta/pam/grants/deny index bd08fd97d..5eae112fd 100644 --- a/gcloud/beta/pam/grants/deny +++ b/gcloud/beta/pam/grants/deny @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES The following command denies a grant with the full name GRANT_NAME and a - reason denial reason: + reason of denial reason: $ gcloud beta pam grants deny GRANT_NAME --reason="denial reason" diff --git a/gcloud/beta/pam/grants/help b/gcloud/beta/pam/grants/help index 449cdbfb7..e36d5911e 100644 --- a/gcloud/beta/pam/grants/help +++ b/gcloud/beta/pam/grants/help @@ -1,17 +1,17 @@ NAME - gcloud beta pam grants - manage Privileged Access Manager Grants + gcloud beta pam grants - manage Privileged Access Manager grants SYNOPSIS gcloud beta pam grants COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) The gcloud pam grants command group lets you manage Privileged - Access Manager (PAM) Grants. + Access Manager (PAM) grants. EXAMPLES - To create a new grant under an entitlement with the full name - ENTITLEMENT_NAME, with requested duration 1 hour 30 minutes, a - justification some justification and two additional email recipients + To create a new grant against an entitlement with the full name + ENTITLEMENT_NAME, a requested duration of 1 hour 30 minutes, a + justification of some justification, and two additional email recipients abc@example.com and xyz@example.com, run: $ gcloud beta pam grants create --entitlement=ENTITLEMENT_NAME \ @@ -23,7 +23,7 @@ EXAMPLES $ gcloud beta pam grants describe GRANT_NAME - To list all grants under an entitlement with the full name + To list all grants associated with an entitlement with the full name ENTITLEMENT_NAME, run: $ gcloud beta pam grants list --entitlement=ENTITLEMENT_NAME @@ -44,20 +44,21 @@ EXAMPLES $ gcloud beta pam grants revoke GRANT_NAME --reason="revoke reason" - To search and list all grants under an entitlement with the full name - ENTITLEMENT_NAME, which you had created, run: + To search for and list all grants that you have created that are associated + with an entitlement with the full name ENTITLEMENT_NAME, run: $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-created - To search and list all grants under an entitlement with the full name - ENTITLEMENT_NAME, which you had approved or denied, run: + To search for and list all grants that you have approved or denied, that + are associated with an entitlement with the full name ENTITLEMENT_NAME, + run: $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-approved - To search and list all grants under an entitlement with the full name - ENTITLEMENT_NAME, which you can approve, run: + To search for and list all grants that you can approve that are associated + with an entitlement with the full name ENTITLEMENT_NAME, run: $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=can-approve @@ -83,15 +84,15 @@ COMMANDS (BETA) Show details of a Privileged Access Manager (PAM) grant. list - (BETA) List all Privileged Access Manager (PAM) grants under an - entitlement. + (BETA) List all Privileged Access Manager (PAM) grants associated with + an entitlement. revoke (BETA) Revoke a Privileged Access Manager (PAM) grant. search - (BETA) Search and list all Privileged Access Manager (PAM) grants under - an entitlement which you had created, had approved or can approve. + (BETA) Search for and list all Privileged Access Manager (PAM) grants + you have created, have approved, or can approve. NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/pam/grants/list b/gcloud/beta/pam/grants/list index 408b7a3bb..613513ab1 100644 --- a/gcloud/beta/pam/grants/list +++ b/gcloud/beta/pam/grants/list @@ -1,6 +1,6 @@ NAME gcloud beta pam grants list - list all Privileged Access Manager grants - under an entitlement + associated with an entitlement SYNOPSIS gcloud beta pam grants list @@ -10,20 +10,20 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List all Privileged Access Manager (PAM) grants under an + (BETA) List all Privileged Access Manager (PAM) grants associated with an entitlement. EXAMPLES - The following command lists all grants under an entitlement with the full - name ENTITLEMENT_NAME: + The following command lists all grants associated with an entitlement with + the full name ENTITLEMENT_NAME: $ gcloud beta pam grants list --entitlement=ENTITLEMENT_NAME REQUIRED FLAGS - Entitlement resource - Entitlement under which the grants are to be - listed. 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. + Entitlement resource - Entitlement the grants are associated with. 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 --entitlement on the command line with a fully diff --git a/gcloud/beta/pam/grants/revoke b/gcloud/beta/pam/grants/revoke index 2cc3224f1..90ca71a98 100644 --- a/gcloud/beta/pam/grants/revoke +++ b/gcloud/beta/pam/grants/revoke @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES The following command revokes a grant with the full name GRANT_NAME and a - reason revoke reason: + reason of revoke reason: $ gcloud beta pam grants revoke GRANT_NAME --reason="revoke reason" diff --git a/gcloud/beta/pam/grants/search b/gcloud/beta/pam/grants/search index 4bbe3bdff..c39858e97 100644 --- a/gcloud/beta/pam/grants/search +++ b/gcloud/beta/pam/grants/search @@ -1,7 +1,6 @@ NAME - gcloud beta pam grants search - search and list all Privileged Access - Manager grants under an entitlement which you had created, had approved - or can approve + gcloud beta pam grants search - search for and list all Privileged Access + Manager grants you have created, have approved, or can approve SYNOPSIS gcloud beta pam grants search --caller-relationship=CALLER_RELATIONSHIP @@ -11,38 +10,41 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Search and list all Privileged Access Manager (PAM) grants under an - entitlement which you had created, had approved or can approve. + (BETA) Search for and list all Privileged Access Manager (PAM) grants you + have created, have approved, or can approve. EXAMPLES - The following command searches and lists all grants under an entitlement - with the full name ENTITLEMENT_NAME, which you had created: + The following command searches for and lists all grants you have created + which are associated with an entitlement with the full name + ENTITLEMENT_NAME: $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-created - The following command searches and lists all grants under an entitlement - with the full name ENTITLEMENT_NAME, which you had approved or denied: + The following command searches for and lists all grants you have approved + or denied which are associated with an entitlement with the full name + ENTITLEMENT_NAME: $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=had-approved - The following command searches and lists all grants under an entitlement - with the full name ENTITLEMENT_NAME, which you can approve: + The following command searches for and lists all grants you can approve + which are associated with an entitlement with the full name + ENTITLEMENT_NAME: $ gcloud beta pam grants search --entitlement=ENTITLEMENT_NAME \ --caller-relationship=can-approve REQUIRED FLAGS --caller-relationship=CALLER_RELATIONSHIP - Whether to search the grants which you had created, had approved or can + Whether to return grants you have created, have approved, or can approve. CALLER_RELATIONSHIP must be one of: can-approve, had-approved, had-created. - Entitlement resource - Entitlement under which the grants are to be - listed. 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. + Entitlement resource - Entitlement the grants are associated with. 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 --entitlement on the command line with a fully diff --git a/gcloud/beta/pam/help b/gcloud/beta/pam/help index 77b9d5146..602e3dad7 100644 --- a/gcloud/beta/pam/help +++ b/gcloud/beta/pam/help @@ -1,31 +1,31 @@ NAME - gcloud beta pam - manage Privileged Access Manager Entitlements and Grants + gcloud beta pam - manage Privileged Access Manager entitlements and grants SYNOPSIS gcloud beta pam GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) The gcloud pam command group lets you manage Privileged Access - Manager (PAM) Entitlements and Grants. + Manager (PAM) entitlements and grants. EXAMPLES - To check the PAM onboarding status for a project sample-project and - location global, run: + To check the PAM onboarding status for a project named sample-project and + in location global, run: $ gcloud beta pam check-onboarding-status --project=sample-project \ --location=global - To check the PAM onboarding status for a folder sample-folder and location - global, run: + To check the PAM onboarding status for a folder with ID FOLDER_ID and in + location global, run: - $ gcloud beta pam check-onboarding-status --folder=sample-folder \ + $ gcloud beta pam check-onboarding-status --folder=FOLDER_ID \ --location=global - To check the PAM onboarding status for an organization sample-organization - and location global, run: + To check the PAM onboarding status for an organization with ID + ORGANIZATION_ID and in location global, run: $ gcloud beta pam check-onboarding-status \ - --organization=sample-organization --location=global + --organization=ORGANIZATION_ID --location=global GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -36,10 +36,10 @@ GROUPS GROUP is one of the following: entitlements - (BETA) Manage Privileged Access Manager (PAM) Entitlements. + (BETA) Manage Privileged Access Manager (PAM) entitlements. grants - (BETA) Manage Privileged Access Manager (PAM) Grants. + (BETA) Manage Privileged Access Manager (PAM) grants. operations (BETA) Manage Privileged Access Manager (PAM) Long Running Operations. diff --git a/gcloud/beta/pam/operations/help b/gcloud/beta/pam/operations/help index 8cbb4b161..09228ec28 100644 --- a/gcloud/beta/pam/operations/help +++ b/gcloud/beta/pam/operations/help @@ -7,30 +7,30 @@ SYNOPSIS DESCRIPTION (BETA) The gcloud pam operations command group lets you manage Privileged - Access Manager (PAM) Operations. + Access Manager (PAM) operations. EXAMPLES To describe an operation with the full name OPERATION_NAME, run: $ gcloud beta pam operations describe OPERATION_NAME - To list all operations under a project sample-project and location global, - run: + To list all operations in a project named sample-project and in location + global, run: $ gcloud beta pam operations list --project=sample-project \ --location=global - To list all operations under a folder sample-folder and location global, - run: + To list all operations in a folder with ID FOLDER_ID and in location + global, run: - $ gcloud beta pam operations list --folder=sample-folder \ + $ gcloud beta pam operations list --folder=FOLDER_ID \ --location=global - To list all operations under an organization sample-organization and + To list all operations in an organization with ID ORGANIZATION_ID and in location global, run: - $ gcloud beta pam operations list \ - --organization=sample-organization --location=global + $ gcloud beta pam operations list --organization=ORGANIZATION_ID \ + --location=global To delete an operation with the full name OPERATION_NAME, run: diff --git a/gcloud/beta/pam/operations/list b/gcloud/beta/pam/operations/list index 8a5501a59..0e18feb4d 100644 --- a/gcloud/beta/pam/operations/list +++ b/gcloud/beta/pam/operations/list @@ -13,29 +13,29 @@ DESCRIPTION under a project/folder/organization location. EXAMPLES - The following command lists all operations under a project sample-project - and location global: + The following command lists all operations in a project named + sample-project and in location global: $ gcloud beta pam operations list --project=sample-project \ --location=global - The following command list all operations under a folder sample-folder and - location global: + The following command lists all operations in a folder with ID FOLDER_ID + and in location global: - $ gcloud beta pam operations list --folder=sample-folder \ + $ gcloud beta pam operations list --folder=FOLDER_ID \ --location=global - The following command list all operations under an organization - sample-organization and location global: + The following command lists all operations in an organization with ID + ORGANIZATION_ID and in location global: - $ gcloud beta pam operations list \ - --organization=sample-organization --location=global + $ gcloud beta pam operations list --organization=ORGANIZATION_ID \ + --location=global REQUIRED FLAGS - Location resource - Location under which the operations are to be listed. - 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. + Location resource - Location of the operations. 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 --location on the command line with a fully diff --git a/gcloud/beta/scc/findings/create b/gcloud/beta/scc/findings/create index 91f92e0a0..e97753e88 100644 --- a/gcloud/beta/scc/findings/create +++ b/gcloud/beta/scc/findings/create @@ -15,44 +15,37 @@ DESCRIPTION EXAMPLES Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached - to example-project under organization 123456 and source 5678: + to project with project number 9876 under organization 123456 and source + 5678: $ gcloud beta scc findings create `testFinding` \ --organization=123456 --source=5678 --state=ACTIVE \ --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' + 9876' - Create an ACTIVE finding testFinding attached to example-project under - project example-project and source 5678: + Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached + to project with project number 9876 under organization 123456 and source + 5678 using the full resource name: $ gcloud beta scc findings create \ - projects/example-project/sources/5678/findings/testFinding \ + organizations/123456/sources/5678/findings/testFinding \ --state=ACTIVE --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' - - Create an ACTIVE finding testFinding attached to example-project under - folder 456 and source 5678: - - $ gcloud beta scc findings create \ - folders/456/sources/5678/findings/testFinding --state=ACTIVE \ - --category='XSS_SCRIPTING' \ - --event-time=2023-01-11T07:00:06.861Z \ - --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' + 9876' Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached - to example-project under organization 123456, source 5678 and location=eu: + to project with project number`9876 under organization 123456, source 5678 + and location=eu: $ gcloud beta scc findings create `testFinding` \ --organization=123456 --source=5678 --state=ACTIVE \ --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' --location=eu + 9876' --location=eu POSITIONAL ARGUMENTS Finding resource - The finding to be used for the SCC (Security Command diff --git a/gcloud/builds/submit b/gcloud/builds/submit index d198881a7..e59d1bdb1 100644 --- a/gcloud/builds/submit +++ b/gcloud/builds/submit @@ -58,6 +58,14 @@ EXAMPLES "projects/my-project/locations/us-west1/connections/my-conn/repo\ sitories/my-repo" --revision=main + To submit a build with source from a Developer Connect GitRepositoryLink + resource + projects/my-project/locations/us-west1/connections/my-conn/gitRepositoryLinks/my-repo-link: + + $ gcloud builds submit \ + "projects/my-project/locations/us-west1/connections/my-conn/gitR\ + epositoryLinks/my-repo-link" --revision=main + POSITIONAL ARGUMENTS At most one of these can be specified: @@ -96,9 +104,9 @@ FLAGS --dir=DIR Directory, relative to the source root, in which to run the build. This is used when the build source is a 2nd-gen Cloud Build repository - resource. This must be a relative path. If a step's dir is specified - and is an absolute path, this value is ignored for that step's - execution. + resource, or a Developer Connect GitRepositoryLink resource. This must + be a relative path. If a step's dir is specified and is an absolute + path, this value is ignored for that step's execution. --disk-size=DISK_SIZE Machine disk size (GB) to run the build. @@ -157,7 +165,8 @@ FLAGS --revision=REVISION Revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref to run the build. This is used when the - build source is a 2nd-gen Cloud Build repository resource. + build source is a 2nd-gen Cloud Build repository resource, or a + Developer Connect GitRepositoryLink resource. Cloud Build uses git fetch to fetch the revision from the Git repository; therefore make sure that the string you provide for diff --git a/gcloud/compute/commitments/create b/gcloud/compute/commitments/create index 115fa90f6..88a2fe71e 100644 --- a/gcloud/compute/commitments/create +++ b/gcloud/compute/commitments/create @@ -97,12 +97,12 @@ 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, - accelerator-optimized-a3, compute-optimized, compute-optimized-c2d, - compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, - general-purpose, general-purpose-e2, general-purpose-n2, - general-purpose-n2d, general-purpose-n4, general-purpose-t2d, - graphics-optimized, memory-optimized, memory-optimized-m3, - storage-optimized-z3. + accelerator-optimized-a3, accelerator-optimized-a3-mega, + compute-optimized, compute-optimized-c2d, compute-optimized-c3, + compute-optimized-c3d, compute-optimized-h3, general-purpose, + general-purpose-e2, general-purpose-n2, general-purpose-n2d, + general-purpose-n4, general-purpose-t2d, graphics-optimized, + memory-optimized, memory-optimized-m3, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/compute/instance-templates/create-with-container b/gcloud/compute/instance-templates/create-with-container index 6cd6620bc..9925237d6 100644 --- a/gcloud/compute/instance-templates/create-with-container +++ b/gcloud/compute/instance-templates/create-with-container @@ -27,8 +27,8 @@ SYNOPSIS [boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME]] [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] - [--labels=[KEY=VALUE,...]] [--machine-type=MACHINE_TYPE] - [--maintenance-policy=MAINTENANCE_POLICY] + [--ipv6-network-tier=IPV6_NETWORK_TIER] [--labels=[KEY=VALUE,...]] + [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--metadata-from-file=KEY=LOCAL_FILE_PATH,[...]] [--min-cpu-platform=PLATFORM] [--network=NETWORK] @@ -37,8 +37,9 @@ SYNOPSIS [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--private-network-ip=PRIVATE_NETWORK_IP] [--region=REGION] [--no-restart-on-failure] [--shielded-integrity-monitoring] - [--shielded-secure-boot] [--shielded-vtpm] [--subnet=SUBNET] - [--tags=TAG,[TAG,...]] [--address=ADDRESS | --no-address] + [--shielded-secure-boot] [--shielded-vtpm] [--stack-type=STACK_TYPE] + [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--address=ADDRESS | --no-address] [--custom-cpu=CUSTOM_CPU --custom-memory=CUSTOM_MEMORY : --custom-extensions --custom-vm-type=CUSTOM_VM_TYPE] [--image-project=IMAGE_PROJECT --image=IMAGE @@ -394,6 +395,14 @@ FLAGS be used together with --external-ipv6-address. Only the /96 IP address range is supported, and the default value is 96. + --ipv6-network-tier=IPV6_NETWORK_TIER + Specifies the IPv6 network tier that will be used to configure the + instance network interface IPv6 access config. IPV6_NETWORK_TIER must + be (only one value is supported): + + PREMIUM + High quality, Google-grade network tier. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -608,6 +617,15 @@ FLAGS about how to modify Shielded VM options, see https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. + --stack-type=STACK_TYPE + Specifies whether IPv6 is enabled on the default network interface. If + not specified, IPV4_ONLY will be used. STACK_TYPE must be one of: + + IPV4_IPV6 + The network interface can have both IPv4 and IPv6 addresses + IPV4_ONLY + The network interface will be assigned IPv4 addresses + --subnet=SUBNET Specifies the subnet that the VM instances are a part of. If --network is also specified, subnet must be a subnetwork of the network specified diff --git a/gcloud/compute/instances/create-with-container b/gcloud/compute/instances/create-with-container index 8e07f79cf..5d81df2d3 100644 --- a/gcloud/compute/instances/create-with-container +++ b/gcloud/compute/instances/create-with-container @@ -30,7 +30,7 @@ SYNOPSIS [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] - [--labels=[KEY=VALUE,...]] + [--ipv6-network-tier=IPV6_NETWORK_TIER] [--labels=[KEY=VALUE,...]] [--local-ssd-recovery-timeout=LOCAL_SSD_RECOVERY_TIMEOUT] [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] [--metadata=KEY=VALUE,[KEY=VALUE,...]] @@ -44,7 +44,7 @@ SYNOPSIS [--provisioning-model=PROVISIONING_MODEL] [--no-restart-on-failure] [--shielded-integrity-monitoring] [--shielded-secure-boot] [--shielded-vtpm] [--source-instance-template=SOURCE_INSTANCE_TEMPLATE] - [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] [--visible-core-count=VISIBLE_CORE_COUNT] [--zone=ZONE] [--address=ADDRESS | --no-address] @@ -445,6 +445,14 @@ FLAGS Default only for Spot VMs. Stop the VM without preserving memory. The VM can be restarted later. + --ipv6-network-tier=IPV6_NETWORK_TIER + Specifies the IPv6 network tier that will be used to configure the + instance network interface IPv6 access config. IPV6_NETWORK_TIER must + be (only one value is supported): + + PREMIUM + High quality, Google-grade network tier. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -681,6 +689,15 @@ FLAGS Users can also override machine type and labels. Values of other flags will be ignored and --source-instance-template will be used instead. + --stack-type=STACK_TYPE + Specifies whether IPv6 is enabled on the default network interface. If + not specified, IPV4_ONLY will be used. STACK_TYPE must be one of: + + IPV4_IPV6 + The network interface can have both IPv4 and IPv6 addresses + IPV4_ONLY + The network interface will be assigned IPv4 addresses + --subnet=SUBNET Specifies the subnet that the VM instances are a part of. If --network is also specified, subnet must be a subnetwork of the network specified diff --git a/gcloud/compute/storage-pools/list b/gcloud/compute/storage-pools/list index 0cb36d09a..85bb121ec 100644 --- a/gcloud/compute/storage-pools/list +++ b/gcloud/compute/storage-pools/list @@ -8,7 +8,7 @@ SYNOPSIS DESCRIPTION View storage pools. - The compact default output format is explained below: + The compact, default output format is explained below: The type column contains all three types -- storage pool type, capacity and performance. For example, the value @@ -28,8 +28,9 @@ DESCRIPTION ▪ Adv: Advanced ▪ Std: Standard - The capacity, iops and throughput columns describe used, provisioned, the - utilization rate. For example, the following value for capacity: + The capacity column, and standard-performance iops and throughput columns + describe the used, provisioned, and the utilization rate. For example, the + following value for capacity: 40 / 50 (80%) @@ -37,6 +38,9 @@ DESCRIPTION 80%. The utilization rate is equivalent to used capacity divided by provisioned capacity. + For advanced-performance storage pools, the iops and throughput columns + will simply show the provisioned values. + EXAMPLES To display all storage pools in all regions and zones, run the following command: diff --git a/gcloud/config/get b/gcloud/config/get index 33f4bc09e..d04f3b410 100644 --- a/gcloud/config/get +++ b/gcloud/config/get @@ -269,9 +269,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/config/help b/gcloud/config/help index bc95fe9d9..3fd0eb24f 100644 --- a/gcloud/config/help +++ b/gcloud/config/help @@ -301,9 +301,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/config/list b/gcloud/config/list index 4d7089038..c767ac63b 100644 --- a/gcloud/config/list +++ b/gcloud/config/list @@ -313,9 +313,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/config/set b/gcloud/config/set index 2e8215e55..4c9bd3aa6 100644 --- a/gcloud/config/set +++ b/gcloud/config/set @@ -316,9 +316,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/config/unset b/gcloud/config/unset index 844276d21..e14f7d04a 100644 --- a/gcloud/config/unset +++ b/gcloud/config/unset @@ -277,9 +277,6 @@ AVAILABLE PROPERTIES Overrides API endpoint for gcloud identity command group. Defaults to https://cloudidentity.googleapis.com/ - cloudiot - Overrides API endpoint for gcloud iot command group. - cloudkms Overrides API endpoint for gcloud kms command group. Defaults to https://cloudkms.googleapis.com/ diff --git a/gcloud/dataflow/help b/gcloud/dataflow/help index 786b022b4..22e50c2ee 100644 --- a/gcloud/dataflow/help +++ b/gcloud/dataflow/help @@ -36,6 +36,9 @@ GROUPS sql A group of subcommands for working with Dataflow SQL. + yaml + A group of subcommands for launching Beam YAML jobs on Dataflow. + NOTES These variants are also available: diff --git a/gcloud/dataflow/yaml/help b/gcloud/dataflow/yaml/help new file mode 100644 index 000000000..61b0d852d --- /dev/null +++ b/gcloud/dataflow/yaml/help @@ -0,0 +1,26 @@ +NAME + gcloud dataflow yaml - a group of subcommands for launching Beam YAML jobs + on Dataflow + +SYNOPSIS + gcloud dataflow yaml COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + A group of subcommands for launching Beam YAML jobs on Dataflow. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + run + Runs a job from the specified path. + +NOTES + This variant is also available: + + $ gcloud beta dataflow yaml + diff --git a/gcloud/dataflow/yaml/run b/gcloud/dataflow/yaml/run new file mode 100644 index 000000000..cbae12158 --- /dev/null +++ b/gcloud/dataflow/yaml/run @@ -0,0 +1,53 @@ +NAME + gcloud dataflow yaml run - runs a job from the specified path + +SYNOPSIS + gcloud dataflow yaml run JOB_NAME + (--yaml-pipeline=YAML_PIPELINE + | --yaml-pipeline-file=YAML_PIPELINE_FILE) + [--pipeline-options=[OPTIONS=VALUE;OPTION=VALUE,...]] + [--region=REGION_ID] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Runs a job from the specified YAML description or Cloud Storage path. + +EXAMPLES + To run a job from YAML, run: + + $ gcloud dataflow yaml run my-job \ + --yaml-pipeline-file=gs://yaml-path --region=europe-west1 + +POSITIONAL ARGUMENTS + JOB_NAME + Unique name to assign to the job. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --yaml-pipeline=YAML_PIPELINE + Inline definition of the YAML pipeline to run. + + --yaml-pipeline-file=YAML_PIPELINE_FILE + Path of a file defining the YAML pipeline to run. (Must be a local + file or a URL beginning with 'gs://'.) + +OPTIONAL FLAGS + --pipeline-options=[OPTIONS=VALUE;OPTION=VALUE,...] + Pipeline options to pass to the job. + + --region=REGION_ID + Region ID of the job's regional endpoint. Defaults to 'us-central1'. + +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 variant is also available: + + $ gcloud beta dataflow yaml run + diff --git a/gcloud/emulators/firestore/start b/gcloud/emulators/firestore/start index 90fa859a1..5c0e53dd5 100644 --- a/gcloud/emulators/firestore/start +++ b/gcloud/emulators/firestore/start @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud emulators firestore start [--database-mode=DATABASE_MODE] - [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] + [--export-on-exit=EXPORT_ON_EXIT] [--host-port=HOST_PORT] + [--import-data=IMPORT_DATA] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command starts a local Firestore emulator. @@ -25,6 +26,15 @@ EXAMPLES $ gcloud emulators firestore start --database-mode=datastore-mode + To import data at the start of the Firestore emulator, run: + + $ gcloud emulators firestore start --import-data= + + To export emulator data upon emulator shutdown, run: + + $ gcloud emulators firestore start \ + --export-on-exit= + FLAGS --database-mode=DATABASE_MODE The database mode to start the Firestore Emulator in. The valid options @@ -33,6 +43,10 @@ FLAGS `firestore-native` (default): start the emulator in Firestore Native `datastore-mode`: start the emulator in Datastore Mode + --export-on-exit=EXPORT_ON_EXIT + Directory path in which emulator data will be saved upon shutdown. + Example:/home/user/myexports/2024-03-26/ + --host-port=HOST_PORT The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port: @@ -45,6 +59,10 @@ FLAGS The default value is localhost:8080. + --import-data=IMPORT_DATA + File path to the data to be loaded into the emulator upon start up. + Example:/home/user/myexports/sampleExport/sampleExport.overall_export_metadata. + --rules=RULES If set, all projects will use the security rules in this file. More information on Firebase Rules and the syntax for this file is available diff --git a/gcloud/functions/deploy b/gcloud/functions/deploy index 326cfedb3..9fda92089 100644 --- a/gcloud/functions/deploy +++ b/gcloud/functions/deploy @@ -136,7 +136,12 @@ FLAGS function and using its generation. --ignore-file=IGNORE_FILE - Override the .gcloudignore file and use the specified file instead. + Override the .gcloudignore file in the source directory and use the + specified file instead. By default, the source directory is your + current directory. Note that it could be changed by the --source flag, + in which case your .gcloudignore file will be searched in the + overridden directory. For example, --ignore-file=.mygcloudignore + combined with --source=./mydir would point to ./mydir/.mygcloudignore --ingress-settings=INGRESS_SETTINGS Ingress settings controls what traffic can reach the function. By diff --git a/gcloud/looker/instances/update b/gcloud/looker/instances/update index 9b15ea1d6..647f0c835 100644 --- a/gcloud/looker/instances/update +++ b/gcloud/looker/instances/update @@ -4,7 +4,9 @@ NAME SYNOPSIS gcloud looker instances update (INSTANCE : --region=REGION) [--allowed-email-domains=[ALLOWED_EMAIL_DOMAINS,...]] [--async] - [--custom-domain=CUSTOM_DOMAIN] [--public-ip-enabled] + [--custom-domain=CUSTOM_DOMAIN] + [--linked-lsp-project-number=LINKED_LSP_PROJECT_NUMBER] + [--public-ip-enabled] [--add-developer-users=ADD_DEVELOPER_USERS --add-standard-users=ADD_STANDARD_USERS --add-viewer-users=ADD_VIEWER_USERS] @@ -87,6 +89,9 @@ FLAGS --custom-domain=CUSTOM_DOMAIN Domain name wanted to serve the Looker instance. + --linked-lsp-project-number=LINKED_LSP_PROJECT_NUMBER + The Looker Studio Pro project number to be linked. + --public-ip-enabled This specifies whether public IP is enabled on the Looker instance. diff --git a/gcloud/netapp/storage-pools/create b/gcloud/netapp/storage-pools/create index 7547a08f6..eb3add878 100644 --- a/gcloud/netapp/storage-pools/create +++ b/gcloud/netapp/storage-pools/create @@ -98,6 +98,10 @@ REQUIRED FLAGS Extreme Service Level for Cloud NetApp Storage Pool. The Extreme Service Level has a throughput per GiB of allocated volume size of 128 KiB/s. + flex + Flex Service Level for Cloud NetApp Storage Pool. The Flex Service + Level has a throughput per GiB of allocated volume size of 16 + KiB/s. premium Premium Service Level for Cloud NetApp Storage Pool. The Premium Service Level has a throughput per GiB of allocated volume size of diff --git a/gcloud/network-connectivity/help b/gcloud/network-connectivity/help index 4d5d1228f..658f3898e 100644 --- a/gcloud/network-connectivity/help +++ b/gcloud/network-connectivity/help @@ -30,6 +30,9 @@ GROUPS policy-based-routes Manage Policy Based Routes. + regional-endpoints + Manage Network Connectivity RegionalEndpoints. + service-connection-policies Manage Service Connection Policies. diff --git a/gcloud/network-connectivity/hubs/create b/gcloud/network-connectivity/hubs/create index d11a6ddbb..917f2e40c 100644 --- a/gcloud/network-connectivity/hubs/create +++ b/gcloud/network-connectivity/hubs/create @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud network-connectivity hubs create HUB [--async] - [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--description=DESCRIPTION] [--export-psc] [--labels=[KEY=VALUE,...]] + [--policy-mode=POLICY_MODE] [--preset-topology=PRESET_TOPOLOGY] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -43,6 +44,10 @@ FLAGS --description=DESCRIPTION Description of the hub. + --export-psc + This boolean controls whether Private Service Connect transitivity is + enabled for the hub. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -51,6 +56,15 @@ FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. + --policy-mode=POLICY_MODE + Policy mode of the hub. POLICY_MODE must be one of: + policy-mode-unspecified, preset. + + --preset-topology=PRESET_TOPOLOGY + Topology of the hub. Only applicable when --policy-mode=PRESET. + PRESET_TOPOLOGY must be one of: mesh, preset-topology-unspecified, + star. + 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/network-connectivity/hubs/groups/help b/gcloud/network-connectivity/hubs/groups/help index cced4dbb2..9cc302fb5 100644 --- a/gcloud/network-connectivity/hubs/groups/help +++ b/gcloud/network-connectivity/hubs/groups/help @@ -33,3 +33,6 @@ COMMANDS set-iam-policy Set the IAM policy of a group resource. + + update + Update a group. diff --git a/gcloud/network-connectivity/hubs/groups/update b/gcloud/network-connectivity/hubs/groups/update new file mode 100644 index 000000000..b94797b36 --- /dev/null +++ b/gcloud/network-connectivity/hubs/groups/update @@ -0,0 +1,122 @@ +NAME + gcloud network-connectivity hubs groups update - update a group + +SYNOPSIS + gcloud network-connectivity hubs groups update (GROUP : --hub=HUB) + [--async] [--description=DESCRIPTION] [--update-labels=[KEY=VALUE,...]] + [--add-auto-accept-projects=[AUTO-ACCEPT-PROJECTS,...] + | --clear-auto-accept-projects + | --remove-auto-accept-projects=[AUTO-ACCEPT-PROJECTS,...]] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update the details of a group. + +EXAMPLES + To update the description of a group named my-group, in the hub my-hub, + run: + + $ gcloud network-connectivity hubs groups update my-group \ + --hub=my-hub --description="new group description" + + To add the project my-project to the auto-accept list of a group named + my-group in the hub my-hub, run: + + $ gcloud network-connectivity hubs groups update my-group \ + --hub=my-hub --add-auto-accept-projects=my-project + +POSITIONAL ARGUMENTS + Group resource - Name of the group to update. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument group on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + GROUP + ID of the group or fully qualified identifier for the group. + + To set the group attribute: + ▸ provide the argument group on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --hub=HUB + The hub Id. + + To set the hub attribute: + ▸ provide the argument group on the command line with a fully + specified name; + ▸ provide the argument --hub on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + New description of the group. + + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + These flags modify the member auto-accept projects of this group. This + controls the list of project ids or project numbers for which auto-accept + is enabled for the group. + + At most one of these can be specified: + + --add-auto-accept-projects=[AUTO-ACCEPT-PROJECTS,...] + Append the given values to the current auto-accept projects. + + --clear-auto-accept-projects + Empty the current auto-accept projects. + + --remove-auto-accept-projects=[AUTO-ACCEPT-PROJECTS,...] + Remove the given values from the current auto-accept projects. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud network-connectivity hubs groups update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud network-connectivity hubs groups update --clear-labels \ + --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + +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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest diff --git a/gcloud/network-connectivity/hubs/update b/gcloud/network-connectivity/hubs/update index 9274aa2af..4ae3cfa08 100644 --- a/gcloud/network-connectivity/hubs/update +++ b/gcloud/network-connectivity/hubs/update @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud network-connectivity hubs update HUB [--async] - [--description=DESCRIPTION] [--update-labels=[KEY=VALUE,...]] + [--description=DESCRIPTION] [--export-psc] + [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -42,6 +43,9 @@ FLAGS --description=DESCRIPTION New description of the hub. + --export-psc + Whether Private Service Connect transitivity is enabled for the hub. + --update-labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to update. If a label exists, its value is modified. Otherwise, a new label is created. diff --git a/gcloud/network-connectivity/regional-endpoints/create b/gcloud/network-connectivity/regional-endpoints/create new file mode 100644 index 000000000..a78b5208c --- /dev/null +++ b/gcloud/network-connectivity/regional-endpoints/create @@ -0,0 +1,107 @@ +NAME + gcloud network-connectivity regional-endpoints create - create a new + regional endpoint + +SYNOPSIS + gcloud network-connectivity regional-endpoints create + (REGIONAL_ENDPOINT : --region=REGION) + --target-google-api=TARGET_GOOGLE_API [--address=ADDRESS] [--async] + [--description=DESCRIPTION] [--enable-global-access] + [--labels=[KEY=VALUE,...]] [--network=NETWORK] + [--subnetwork=SUBNETWORK] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new regional endpoint with the given name. + +EXAMPLES + To create a regional endpoint with the name 'my-regional-endpoint' in + us-central1 targeting my-target-endpoint, run: + + $ gcloud network-connectivity regional-endpoints create \ + my-regional-endpoint --region=us-centeral1 \ + [--network=my-network] [--subnetwork=my-subnet] \ + --target-google-api=my-target-endpoint [--enable-global-access] + +POSITIONAL ARGUMENTS + RegionalEndpoint resource - Name of the regional endpoint to be created. + 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 regional_endpoint 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. + + REGIONAL_ENDPOINT + ID of the regionalEndpoint or fully qualified identifier for the + regionalEndpoint. + + To set the regional_endpoint attribute: + ▸ provide the argument regional_endpoint on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location Id. + + To set the region attribute: + ▸ provide the argument regional_endpoint on the command line with a + fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + --target-google-api=TARGET_GOOGLE_API + The service endpoint the regional endpoint will connect to. + +OPTIONAL FLAGS + --address=ADDRESS + The IP address or address resource URI of the Regional Endpoint. When + no address value is provided, an IP from the subnetwork is allocated. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Description of the regional endpoint. + + --enable-global-access + Whether the REGIONAL or GLOBAL access is enabled. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --network=NETWORK + Consumer's VPC network that this regional endpoint belongs to. + + --subnetwork=SUBNETWORK + The name of the subnetwork from which the IP address will be allocated. + +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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud beta network-connectivity regional-endpoints create + diff --git a/gcloud/network-connectivity/regional-endpoints/delete b/gcloud/network-connectivity/regional-endpoints/delete new file mode 100644 index 000000000..af9ee370e --- /dev/null +++ b/gcloud/network-connectivity/regional-endpoints/delete @@ -0,0 +1,72 @@ +NAME + gcloud network-connectivity regional-endpoints delete - delete a regional + endpoint + +SYNOPSIS + gcloud network-connectivity regional-endpoints delete + (REGIONAL_ENDPOINT : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified regional endpoint. + +EXAMPLES + To delete a regional endpoint named 'my-regional-endpoint' in us-central1: + + $ gcloud network-connectivity regional-endpoints delete \ + my-regional-endpoint --region=us-central1 + +POSITIONAL ARGUMENTS + RegionalEndpoint resource - Name of the regional endpoint to be deleted. + 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 regional_endpoint 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. + + REGIONAL_ENDPOINT + ID of the regionalEndpoint or fully qualified identifier for the + regionalEndpoint. + + To set the regional_endpoint attribute: + ▸ provide the argument regional_endpoint on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location Id. + + To set the region attribute: + ▸ provide the argument regional_endpoint on the command line with a + fully specified name; + ▸ provide the argument --region 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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud beta network-connectivity regional-endpoints delete + diff --git a/gcloud/network-connectivity/regional-endpoints/describe b/gcloud/network-connectivity/regional-endpoints/describe new file mode 100644 index 000000000..57f1a33b9 --- /dev/null +++ b/gcloud/network-connectivity/regional-endpoints/describe @@ -0,0 +1,68 @@ +NAME + gcloud network-connectivity regional-endpoints describe - describe a + regional endpoint + +SYNOPSIS + gcloud network-connectivity regional-endpoints describe + (REGIONAL_ENDPOINT : --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve and display details about a regional endpoint. + +EXAMPLES + Display details about a regional endpoint named 'my-regional-endpoint' in + us-central1: + + $ gcloud network-connectivity regional-endpoints describe \ + my-regional-endpoint --region=us-central1 [--project=my-project] + +POSITIONAL ARGUMENTS + RegionalEndpoint resource - Name of the regional endpoint to be described. + 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 regional_endpoint 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. + + REGIONAL_ENDPOINT + ID of the regionalEndpoint or fully qualified identifier for the + regionalEndpoint. + + To set the regional_endpoint attribute: + ▸ provide the argument regional_endpoint on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location Id. + + To set the region attribute: + ▸ provide the argument regional_endpoint on the command line with a + fully specified name; + ▸ provide the argument --region 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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud beta network-connectivity regional-endpoints describe + diff --git a/gcloud/network-connectivity/regional-endpoints/help b/gcloud/network-connectivity/regional-endpoints/help new file mode 100644 index 000000000..264162912 --- /dev/null +++ b/gcloud/network-connectivity/regional-endpoints/help @@ -0,0 +1,36 @@ +NAME + gcloud network-connectivity regional-endpoints - manage Network + Connectivity RegionalEndpoints + +SYNOPSIS + gcloud network-connectivity regional-endpoints COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Network Connectivity RegionalEndpoints. + +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 new regional endpoint. + + delete + Delete a regional endpoint. + + describe + Describe a regional endpoint. + + list + List regional endpoints. + +NOTES + This variant is also available: + + $ gcloud beta network-connectivity regional-endpoints + diff --git a/gcloud/network-connectivity/regional-endpoints/list b/gcloud/network-connectivity/regional-endpoints/list new file mode 100644 index 000000000..7be5f62a9 --- /dev/null +++ b/gcloud/network-connectivity/regional-endpoints/list @@ -0,0 +1,82 @@ +NAME + gcloud network-connectivity regional-endpoints list - list regional + endpoints + +SYNOPSIS + gcloud network-connectivity regional-endpoints list --region=REGION + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve and display a list of all regional endpoints in the specified + project. + +EXAMPLES + To list all regional endpoints in us-centeral1, run: + + $ gcloud network-connectivity regional-endpoints list \ + --region=us-central1 [--project=my-project] + +REQUIRED FLAGS + Region resource - Region of the regional endpoints to display. 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 --region 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. + + --region=REGION + ID of the region or fully qualified identifier for the region. + + To set the region attribute: + ▸ provide the argument --region 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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud beta network-connectivity regional-endpoints list + diff --git a/gcloud/scc/findings/create b/gcloud/scc/findings/create index 203ad417c..0bc8c0fef 100644 --- a/gcloud/scc/findings/create +++ b/gcloud/scc/findings/create @@ -15,42 +15,35 @@ DESCRIPTION EXAMPLES Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached - to example-project under organization 123456 and source 5678: + to project with project number 9876 under organization 123456 and source + 5678: $ gcloud scc findings create `testFinding` --organization=123456 \ --source=5678 --state=ACTIVE --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' + 9876' - Create an ACTIVE finding testFinding attached to example-project under - project example-project and source 5678: + Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached + to project with project number 9876 under organization 123456 and source + 5678 using the full resource name: $ gcloud scc findings create \ - projects/example-project/sources/5678/findings/testFinding \ + organizations/123456/sources/5678/findings/testFinding \ --state=ACTIVE --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' - - Create an ACTIVE finding testFinding attached to example-project under - folder 456 and source 5678: - - $ gcloud scc findings create \ - folders/456/sources/5678/findings/testFinding --state=ACTIVE \ - --category='XSS_SCRIPTING' \ - --event-time=2023-01-11T07:00:06.861Z \ - --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' + 9876' Create an ACTIVE finding testFinding with category: XSS_SCRIPTING attached - to example-project under organization 123456, source 5678 and location=eu: + to project with project number`9876 under organization 123456, source 5678 + and location=eu: $ gcloud scc findings create `testFinding` --organization=123456 \ --source=5678 --state=ACTIVE --category='XSS_SCRIPTING' \ --event-time=2023-01-11T07:00:06.861Z \ --resource-name='//cloudresourcemanager.googleapis.com/projects/\ - example-project' --location=eu + 9876' --location=eu POSITIONAL ARGUMENTS Finding resource - The finding to be used for the SCC (Security Command