1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00

gcloud: Thu Jun 23 08:40:08 UTC 2022

This commit is contained in:
Automated 2022-06-23 08:40:08 +00:00
parent 5378794555
commit 8b80260bd9
Failed to extract signature
144 changed files with 4593 additions and 192 deletions

View file

@ -0,0 +1,79 @@
NAME
gcloud alpha active-directory domains extend-schema - initiate schema
extension for a Managed Microsoft AD domain
SYNOPSIS
gcloud alpha active-directory domains extend-schema DOMAIN
--description=DESCRIPTION --ldif-file=LDIF_FILE [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Initiate schema extension for a Managed Microsoft AD domain.
This command can fail for the following reasons:
▪ The specified domain doesn't exist.
▪ The specified domain is either being created or updated.
▪ The specified domain is under maintenance.
▪ The active account doesn't have permission to initiate schema
extension on the specified domain.
EXAMPLES
The following command initiates a schema extension for the domain
my-domain.com in project my-project, with description "Test Description",
using the LDIF file "demo.ldif"
$ gcloud alpha active-directory domains extend-schema \
my-domain.com --description="Test Description" \
--ldif-file=demo.ldf --project=my-project --async
POSITIONAL ARGUMENTS
Domain resource - Name of the Managed Microsoft AD domain for which you
want to extend schema. 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 domain 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.
DOMAIN
ID of the domain or fully qualified identifier for the domain. To set
the domain attribute:
▸ provide the argument domain on the command line.
REQUIRED FLAGS
--description=DESCRIPTION
Description of schema change.
--ldif-file=LDIF_FILE
Local LDIF file path that contains commands for schema extension. The
file size can't be larger than 1 MB.
OPTIONAL 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 managedidentities/v1alpha1 API. The full
documentation for this API can be found at:
https://cloud.google.com/managed-microsoft-ad/
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta active-directory domains extend-schema

View file

@ -41,6 +41,9 @@ COMMANDS
describe-ldaps-settings
(ALPHA) Describe the LDAPS settings of a Managed Microsoft AD domain.
extend-schema
(ALPHA) Initiate schema extension for a Managed Microsoft AD domain.
get-iam-policy
(ALPHA) Describe the IAM policy for a Managed Microsoft AD domain.

View file

@ -5,7 +5,8 @@ NAME
SYNOPSIS
gcloud alpha anthos config controller create (NAME : --location=LOCATION)
[--async] [--cluster-ipv4-cidr-block=CLUSTER_IPV4_CIDR_BLOCK]
[--cluster-named-range=CLUSTER_NAMED_RANGE] [--man-block=MAN_BLOCK]
[--cluster-named-range=CLUSTER_NAMED_RANGE]
[--experimental-features=[FEATURE,...]] [--man-block=MAN_BLOCK]
[--master-ipv4-cidr-block=MASTER_IPV4_CIDR_BLOCK] [--network=NETWORK]
[--services-ipv4-cidr-block=SERVICES_IPV4_CIDR_BLOCK]
[--services-named-range=SERVICES_NAMED_RANGE] [--subnet=SUBNET]
@ -66,6 +67,9 @@ FLAGS
use for pod IP addresses. Alternatively, --cluster_cidr_block can be
used to automatically create a GKE-managed one.
--experimental-features=[FEATURE,...]
Enable experimental features. It can only be enabled in ALPHA version.
--man-block=MAN_BLOCK
Master Authorized Network. Allows access to the Kubernetes control
plane from this block. Defaults to '0.0.0.0/0' if flag is not provided.

View file

@ -67,20 +67,22 @@ REQUIRED FLAGS
--repository-format=REPOSITORY_FORMAT
Format of the repository. REPOSITORY_FORMAT must be one of:
apt
APT package format.
docker
Docker image format.
googet
GooGet package format.
maven
Maven package format.
npm
NPM package format.
python
Python package format.
yum
YUM package format.
apt
APT package format.
docker
Docker image format.
googet
GooGet package format.
kfp
KFP package format.
maven
Maven package format.
npm
NPM package format.
python
Python package format.
yum
YUM package format.
OPTIONAL FLAGS
--allow-snapshot-overwrites

View file

@ -51,7 +51,7 @@ REQUIRED FLAGS
The compliance regime of the new Assured Workloads environment.
COMPLIANCE_REGIME must be one of: CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE,
IL4, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT,
CA_REGIONS_AND_SUPPORT.
CA_REGIONS_AND_SUPPORT, ITAR.
--display-name=DISPLAY_NAME
The display name of the new Assured Workloads environment

View file

@ -0,0 +1,69 @@
NAME
gcloud alpha auth application-default - manage your active Application
Default Credentials
SYNOPSIS
gcloud alpha auth application-default COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Application Default Credentials (ADC) provide a method to get
credentials used in calling Google APIs. The gcloud alpha auth
application-default command group allows you to manage active credentials
on your machine that are used for local application development.
These credentials are only used by Google client libraries in your own
application.
For more information about ADC and how it works, see Authenticating as a
service account (https://cloud.google.com/docs/authentication/production).
EXAMPLES
To use your own user credentials for your application to access an API,
run:
$ gcloud alpha auth application-default login
This will take you through a web flow to acquire new user credentials.
To create a service account and have your application use it for API
access, run:
$ gcloud iam service-accounts create my-account
$ gcloud iam service-accounts keys create key.json \
--iam-account=my-account@my-project.iam.gserviceaccount.com
$ export GOOGLE_APPLICATION_CREDENTIALS=key.json
$ ./my_application.sh
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
login
(ALPHA) Acquire new user credentials to use for Application Default
Credentials.
print-access-token
(ALPHA) Print an access token for your current Application Default
Credentials.
revoke
(ALPHA) Revoke previously generated Application Default Credentials.
set-quota-project
(ALPHA) Update or add a quota project in application default
credentials (ADC).
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud auth application-default
$ gcloud beta auth application-default

View file

@ -0,0 +1,124 @@
NAME
gcloud alpha auth application-default login - acquire new user credentials
to use for Application Default Credentials
SYNOPSIS
gcloud alpha auth application-default login [--no-browser]
[--client-id-file=CLIENT_ID_FILE] [--disable-quota-project]
[--no-launch-browser] [--scopes=SCOPE,[SCOPE,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Obtains user access credentials via a web flow and puts them in the
well-known location for Application Default Credentials (ADC).
This command is useful when you are developing code that would normally use
a service account but need to run the code in a local development
environment where it's easier to provide user credentials. The credentials
will apply to all API calls that make use of the Application Default
Credentials client library. Do not set the GOOGLE_APPLICATION_CREDENTIALS
environment variable if you want to use the credentials generated by this
command in your local development. This command tries to find a quota
project from gcloud's context and write it to ADC so that Google client
libraries can use it for billing and quota. Alternatively, you can use the
--client-id-file flag. In this case, the project owning the client ID will
be used for billing and quota. You can create the client ID file at
https://console.cloud.google.com/apis/credentials.
This command has no effect on the user account(s) set up by the gcloud auth
login command.
Any credentials previously generated by gcloud auth application-default
login will be overwritten.
EXAMPLES
If you want your local application to temporarily use your own user
credentials for API access, run:
$ gcloud alpha auth application-default login
If you'd like to login by passing in a file containing your own client id,
run:
$ gcloud alpha auth application-default login \
--client-id-file=clientid.json
FLAGS
--no-browser
Use this flag to authenticate the client libraries on a machine without
a web browser.
Run gcloud auth login --no-browser and follow these steps:
1. Copy the long command that begins with "gcloud auth login
--remote-bootstrap=".
2. Paste and run this command on the command line of a different,
trusted machine that has local installations of both a web browser and
the gcloud CLI tool version 372.0 or later.
3. Copy the long URL output from the machine with the web browser.
4. Paste the long URL back to the first machine under the prompt,
"Enter the output of the above command", and press Enter to complete
the authorization.
--client-id-file=CLIENT_ID_FILE
A file containing your own client id to use to login. If
--client-id-file is specified, the quota project will not be written to
ADC.
--disable-quota-project
By default, the project in billing/quota_project or core/project will
be written to application default credentials (ADC) as the quota
project. When both are set, billing/quota_project takes precedence. You
can use --billing-project to overwrite the value in
billing/quota_project. Similarly, you can use --project to overwrite
the value in core/project. Client libraries will send it to services
and use it for quota and billing. To be able to use a project as the
quota project, the account in ADC must have the
serviceusage.services.use permission on the project. This permission is
granted to the project editor and project owner. You can create custom
roles to include this permission.
Note that some cloud services may ignore this quota project and still
bill the project owning the resources.
In the following situations, you may use this flag to skip setting the
quota project:
◆ The account in ADC cannot be granted the project editor or owner
role or any role with the serviceusage.services.use permission.
◆ You always want to bill the project owning the resources.
--launch-browser
Launch a browser for authorization. If not enabled or if it is not
possible to launch a browser, prints a URL to standard output to be
copied. Enabled by default, use --no-launch-browser to disable.
--scopes=SCOPE,[SCOPE,...]
The names of the scopes to authorize for. By default openid,
https://www.googleapis.com/auth/userinfo.email,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/sqlservice.login scopes are used. The
list of possible scopes can be found at:
https://developers.google.com/identity/protocols/googlescopes.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud auth application-default login
$ gcloud beta auth application-default login

View file

@ -0,0 +1,74 @@
NAME
gcloud alpha auth application-default print-access-token - print an access
token for your current Application Default Credentials
SYNOPSIS
gcloud alpha auth application-default print-access-token
[--scopes=SCOPE,[SCOPE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha auth application-default print-access-token generates
and prints an access token for the current Application Default Credential
(ADC). The ADC (https://google.aip.dev/auth/4110) can be specified either
by using gcloud auth application-default login, gcloud auth login
--cred-file=/path/to/cred/file --update-adc, or by setting the
GOOGLE_APPLICATION_CREDENTIALS environment variable.
The access token generated by gcloud alpha auth application-default
print-access-token is useful for manually testing APIs via curl or similar
tools.
In order to print details of the access token, such as the associated
account and the token's expiration time in seconds, run:
$ curl -H "Content-Type: application/x-www-form-urlencoded" \
-d "access_token=$(gcloud auth application-default print-access-token)" \
https://www.googleapis.com/oauth2/v1/tokeninfo
Note that token itself may not be enough to access some services. If you
use the token with curl or similar tools, you may see permission errors
similar to "Your application has authenticated using end user credentials
from the Google Cloud SDK or Google Cloud Shell". If it happens, you may
need to provide a quota project in the "X-Goog-User-Project" header. For
example,
$ curl -H "X-Goog-User-Project: your-project" \
-H \
"Authorization: Bearer $(gcloud auth application-default \
print-access-token)" foo.googleapis.com
The identity that granted the token must have the serviceusage.services.use
permission on the provided project. See
https://cloud.google.com/apis/docs/system-parameters for more information.
FLAGS
--scopes=SCOPE,[SCOPE,...]
The scopes to authorize for. This flag is supported for user accounts
and service accounts only. The list of possible scopes can be found at:
https://developers.google.com/identity/protocols/googlescopes.
For end-user accounts, the provided scopes must be from [openid,
https://www.googleapis.com/auth/userinfo.email,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/sqlservice.login], or the scopes
previously specified through gcloud auth application-default login
--scopes.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud auth application-default print-access-token
$ gcloud beta auth application-default print-access-token

View file

@ -0,0 +1,35 @@
NAME
gcloud alpha auth application-default revoke - revoke previously generated
Application Default Credentials
SYNOPSIS
gcloud alpha auth application-default revoke [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Revokes Application Default Credentials that have been previously
generated by gcloud alpha auth application-default login and deletes the
local credential file.
This does not affect any credentials set up through other means, such as
credentials referenced by the Application Default Credentials environment
variable or service account credentials that are active on a Google Compute
Engine virtual machine.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud auth application-default revoke
$ gcloud beta auth application-default revoke

View file

@ -0,0 +1,45 @@
NAME
gcloud alpha auth application-default set-quota-project - update or add a
quota project in application default credentials (ADC)
SYNOPSIS
gcloud alpha auth application-default set-quota-project QUOTA_PROJECT_ID
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Before running this command, an ADC must already be generated using
$ gcloud auth application-default login. The quota project can be used by
client libraries for the billing purpose. The existing application default
credentials must have the serviceusage.services.use permission on the given
project.
EXAMPLES
To update the quota project in application default credentials to
my-quota-project, run:
$ gcloud alpha auth application-default set-quota-project \
my-quota-project
POSITIONAL ARGUMENTS
QUOTA_PROJECT_ID
Quota project ID to add to application default credentials. If a quota
project already exists, it will be updated.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud auth application-default set-quota-project
$ gcloud beta auth application-default set-quota-project

View file

@ -2,7 +2,7 @@ NAME
gcloud alpha auth - manage oauth2 credentials for the Google Cloud CLI
SYNOPSIS
gcloud alpha auth COMMAND [GCLOUD_WIDE_FLAG ...]
gcloud alpha auth GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) The gcloud auth command group lets you grant and revoke
@ -41,6 +41,12 @@ GCLOUD WIDE FLAGS
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
application-default
(ALPHA) Manage your active Application Default Credentials.
COMMANDS
COMMAND is one of the following:

View file

@ -48,6 +48,10 @@ COMMANDS
os-upgrade
(ALPHA) Upgrade the instances OS version.
troubleshoot
(ALPHA) Troubleshoot issues with the setup of VM Manager on a specified
VM instance.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct

View file

@ -0,0 +1,64 @@
NAME
gcloud alpha compute os-config troubleshoot - troubleshoot issues with the
setup of VM Manager on a specified VM instance
SYNOPSIS
gcloud alpha compute os-config troubleshoot INSTANCE_NAME [--zone=ZONE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha compute os-config troubleshoot troubleshoots issues
with the setup of VM Manager on a specified VM instance
Troubleshoot checks if the OS Config API is enabled for the instance.
EXAMPLES
To troubleshoot an instance named my-instance in zone us-west1-a, run
$ gcloud alpha compute os-config troubleshoot my-instance \ --zone=us-west1-a
POSITIONAL ARGUMENTS
INSTANCE_NAME
Name of the instance to operate on. For details on valid instance
names, refer to the criteria documented under the field 'name' at:
https://cloud.google.com/compute/docs/reference/rest/v1/instances
FLAGS
--zone=ZONE
Zone of the instance to operate on. If not specified, you might be
prompted to select a zone (interactive mode only). gcloud attempts to
identify the appropriate zone by searching for resources in your
currently active project. If the zone cannot be determined, gcloud
prompts you for a selection with all available Google Cloud Platform
zones.
To avoid prompting when this flag is omitted, the user can set the
compute/zone property:
$ gcloud config set compute/zone ZONE
A list of zones can be fetched by running:
$ gcloud compute zones list
To unset the property, run:
$ gcloud config unset compute/zone
Alternatively, the zone can be stored in the environment variable
CLOUDSDK_COMPUTE_ZONE.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.

View file

@ -5,6 +5,7 @@ NAME
SYNOPSIS
gcloud alpha compute target-grpc-proxies create NAME --url-map=URL_MAP
[--description=DESCRIPTION] [--validate-for-proxyless]
[--global-url-map | --url-map-region=URL_MAP_REGION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
@ -50,6 +51,15 @@ OPTIONAL FLAGS
cause unexpected behavior in gRPC applications if unsupported features
are configured.
At most one of these can be specified:
--global-url-map
If set, the URL map is global.
--url-map-region=URL_MAP_REGION
Region of the URL map to operate on. Overrides the default
compute/region property value for this command invocation.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -644,6 +644,10 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
context_aware
use_client_certificate
If True, use client certificate to authorize user device using
@ -1034,6 +1038,11 @@ AVAILABLE PROPERTIES
instead (inexpensively) compare the cloud source and destination
hashes.
convert_incompatible_windows_path_characters
Allows automatic conversion of invalid path characters on Windows.
If not enabled, Windows will raise an OSError if an invalid
character is encountered.
copy_chunk_size
Chunk size used for copying to in clouds or on disk.

View file

@ -649,6 +649,10 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
context_aware
use_client_certificate
If True, use client certificate to authorize user device using
@ -1039,6 +1043,11 @@ AVAILABLE PROPERTIES
instead (inexpensively) compare the cloud source and destination
hashes.
convert_incompatible_windows_path_characters
Allows automatic conversion of invalid path characters on Windows.
If not enabled, Windows will raise an OSError if an invalid
character is encountered.
copy_chunk_size
Chunk size used for copying to in clouds or on disk.

View file

@ -662,6 +662,10 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
context_aware
use_client_certificate
If True, use client certificate to authorize user device using
@ -1052,6 +1056,11 @@ AVAILABLE PROPERTIES
instead (inexpensively) compare the cloud source and destination
hashes.
convert_incompatible_windows_path_characters
Allows automatic conversion of invalid path characters on Windows.
If not enabled, Windows will raise an OSError if an invalid
character is encountered.
copy_chunk_size
Chunk size used for copying to in clouds or on disk.

View file

@ -623,6 +623,10 @@ AVAILABLE PROPERTIES
location
Default Google Cloud location to use for Anthos clusters on Azure.
container_vmware
location
Default Google Cloud location to use for Anthos clusters on VMware.
context_aware
use_client_certificate
If True, use client certificate to authorize user device using
@ -1013,6 +1017,11 @@ AVAILABLE PROPERTIES
instead (inexpensively) compare the cloud source and destination
hashes.
convert_incompatible_windows_path_characters
Allows automatic conversion of invalid path characters on Windows.
If not enabled, Windows will raise an OSError if an invalid
character is encountered.
copy_chunk_size
Chunk size used for copying to in clouds or on disk.

View file

@ -6,8 +6,7 @@ SYNOPSIS
gcloud alpha container aws node-pools update
(NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async]
[--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN]
[--instance-type=INSTANCE_TYPE] [--node-version=NODE_VERSION]
[--root-volume-iops=ROOT_VOLUME_IOPS]
[--node-version=NODE_VERSION] [--root-volume-iops=ROOT_VOLUME_IOPS]
[--root-volume-kms-key-arn=ROOT_VOLUME_KMS_KEY_ARN]
[--root-volume-size=ROOT_VOLUME_SIZE]
[--root-volume-type=ROOT_VOLUME_TYPE] [--validate-only]
@ -72,9 +71,6 @@ FLAGS
--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN
Amazon Resource Name (ARN) of the AWS KMS key to encrypt the user data.
--instance-type=INSTANCE_TYPE
AWS EC2 instance type for the node pool's nodes.
--node-version=NODE_VERSION
Kubernetes version to use for the node pool.

View file

@ -289,7 +289,7 @@ FLAGS
Total egress bandwidth is the available outbound bandwidth from a
VM, regardless of whether the traffic is going to internal IP or
external IP destinations. The following tier values are allowed:
[DEFAULT,TIER_1]
[TIER_UNSPECIFIED,TIER_1]
--node-group=NODE_GROUP
Assign instances of this pool to run on the specified Google Compute

View file

@ -57,7 +57,7 @@ REQUIRED FLAGS
Total egress bandwidth is the available outbound bandwidth from a
VM, regardless of whether the traffic is going to internal IP or
external IP destinations. The following tier values are allowed:
[DEFAULT,TIER_1]
[TIER_UNSPECIFIED,TIER_1]
--node-labels=[NODE_LABEL,...]
Replaces all the user specified Kubernetes labels on all nodes in an

View file

@ -5,9 +5,8 @@ NAME
SYNOPSIS
gcloud alpha edge-cloud networking routers create
(ROUTER : --location=LOCATION --zone=ZONE) --asn=ASN --network=NETWORK
[--async] [--description=DESCRIPTION]
[--keepalive-interval-in-seconds=KEEPALIVE_INTERVAL_IN_SECONDS]
[--labels=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
[--async] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new Distributed Cloud Edge Network router.
@ -69,10 +68,6 @@ OPTIONAL FLAGS
--description=DESCRIPTION
An optional, textual description for the subnet.
--keepalive-interval-in-seconds=KEEPALIVE_INTERVAL_IN_SECONDS
The interval in seconds between BGP keepalive messages that are sent to
the peer.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.

View file

@ -218,8 +218,8 @@ OPTIONAL FLAGS
ENTERPRISE instances offer the features and availability needed for
mission-critical workloads.
high-scale-ssd
NFS storage system with expanded capacity and performance scaling
capabilities.
High Scale instances offer NFS storage system with expanded
capacity and performance scaling capabilities.
premium
Premium Filestore instance, An alias for BASIC_SSD. Use BASIC_SSD
instead whenever possible.

View file

@ -184,7 +184,7 @@ FLAGS
◆ go113: Go 1.13
◆ go116: Go 1.16
◆ java11: Java 11
◆ java17: Java 17 (preview)
◆ java17: Java 17
◆ dotnet3: .NET Framework 3
◆ ruby26: Ruby 2.6
◆ ruby27: Ruby 2.7

View file

@ -6,13 +6,16 @@ SYNOPSIS
gcloud alpha iam workload-identity-pools create-cred-config AUDIENCE
--output-file=OUTPUT_FILE
(--aws | --azure | --credential-source-file=CREDENTIAL_SOURCE_FILE
| --credential-source-url=CREDENTIAL_SOURCE_URL)
[--app-id-uri=APP_ID_URI]
| --credential-source-url=CREDENTIAL_SOURCE_URL
| --executable-command=EXECUTABLE_COMMAND) [--app-id-uri=APP_ID_URI]
[--credential-source-field-name=CREDENTIAL_SOURCE_FIELD_NAME]
[--credential-source-headers=[key=value,...]]
[--credential-source-type=CREDENTIAL_SOURCE_TYPE] [--enable-imdsv2]
[--service-account=SERVICE_ACCOUNT]
[--subject-token-type=SUBJECT_TOKEN_TYPE] [GCLOUD_WIDE_FLAG ...]
[--subject-token-type=SUBJECT_TOKEN_TYPE]
[--executable-output-file=EXECUTABLE_OUTPUT_FILE
--executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) This command creates a configuration file to allow access to
@ -38,6 +41,16 @@ EXAMPLES
--credential-source-headers=Key=Value \
--output-file=credentials.json
To create an executable-source credential configuration for your project,
run the following command:
$ gcloud alpha iam workload-identity-pools create-cred-config \
locations/$REGION/workforcePools/$WORKFORCE_POOL_ID/providers/\
$PROVIDER_ID --executable-command=$EXECUTABLE_COMMAND \
--executable-timeout-millis=30000 \
--executable-output-file=$CACHE_FILE \
--output-file=credentials.json
To create an AWS-based credential configuration for your project, run:
$ gcloud alpha iam workload-identity-pools create-cred-config \
@ -83,6 +96,10 @@ REQUIRED FLAGS
--credential-source-url=CREDENTIAL_SOURCE_URL
URL to obtain the credential from.
--executable-command=EXECUTABLE_COMMAND
The full command to run to retrieve the credential. Must be an
absolute path for the program including arguments.
OPTIONAL FLAGS
--app-id-uri=APP_ID_URI
The custom Application ID URI for the Azure access token.
@ -106,6 +123,15 @@ OPTIONAL FLAGS
--subject-token-type=SUBJECT_TOKEN_TYPE
The type of token being used for authorization.
Arguments for an executable type credential source.
--executable-output-file=EXECUTABLE_OUTPUT_FILE
The absolute path to the file storing the executable response.
--executable-timeout-millis=EXECUTABLE_TIMEOUT_MILLIS
The timeout duration in milliseconds for waiting for the executable
to finish.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -54,7 +54,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-brands create
$ gcloud beta iap oauth-brands create

View file

@ -50,7 +50,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-brands describe
$ gcloud beta iap oauth-brands describe

View file

@ -28,7 +28,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-brands
$ gcloud beta iap oauth-brands

View file

@ -60,7 +60,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-brands list
$ gcloud beta iap oauth-brands list

View file

@ -60,7 +60,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-clients create
$ gcloud beta iap oauth-clients create

View file

@ -13,12 +13,12 @@ EXAMPLES
To delete a Cloud OAuth client named CLIENT for the current project and
brand BRAND, run:
$ gcloud beta iap oauth-clients delete CLIENT --brand=BRAND
$ gcloud alpha iap oauth-clients delete CLIENT --brand=BRAND
To delete a Cloud OAuth client named CLIENT for a specific project
PROJECT_ID and brand BRAND, run:
$ gcloud beta iap oauth-clients delete CLIENT --brand=BRAND \
$ gcloud alpha iap oauth-clients delete CLIENT --brand=BRAND \
--project=PROJECT_ID
POSITIONAL ARGUMENTS
@ -63,7 +63,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-clients delete
$ gcloud beta iap oauth-clients delete

View file

@ -60,7 +60,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-clients describe
$ gcloud beta iap oauth-clients describe

View file

@ -34,7 +34,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-clients
$ gcloud beta iap oauth-clients

View file

@ -75,7 +75,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-clients list
$ gcloud beta iap oauth-clients list

View file

@ -61,7 +61,9 @@ NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
access allowlist. These variants are also available:
$ gcloud iap oauth-clients reset-secret
$ gcloud beta iap oauth-clients reset-secret

View file

@ -0,0 +1,97 @@
NAME
gcloud alpha metastore federations add-iam-policy-binding - add an IAM
policy binding to a federation
SYNOPSIS
gcloud alpha metastore federations add-iam-policy-binding
(FEDERATION : --location=LOCATION) --member=PRINCIPAL --role=ROLE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Add an IAM policy binding to a federation.
EXAMPLES
To add an IAM policy binding for the role of roles/metastore.admin for the
user test-user@gmail.com, run:
$ gcloud alpha metastore federations add-iam-policy-binding \
my-federation --member='user:test-user@gmail.com' \
--role='roles/metastore.admin'
See https://cloud.google.com/dataproc-metastore/docs/iam-and-access-control
for details of policy role and member types.
POSITIONAL ARGUMENTS
Federation resource - Federation for which to add the IAM policy to. 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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to add the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete
path of a predefined role, such as roles/logging.viewer, or the role ID
for a custom role, such as
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
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 metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations add-iam-policy-binding
$ gcloud beta metastore federations add-iam-policy-binding

View file

@ -0,0 +1,114 @@
NAME
gcloud alpha metastore federations create - create a Dataproc Metastore
federation
SYNOPSIS
gcloud alpha metastore federations create
(FEDERATION : --location=LOCATION) --backends=RANK=BACKEND [--async]
[--hive-metastore-version=HIVE_METASTORE_VERSION]
[--labels=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new Dataproc Metastore federation with the given name and
configurations.
If run asynchronously with --async, exits after printing one operation name
that can be used to poll the status of the creation via:
gcloud metastore operations describe
EXAMPLES
To create a Dataproc Metastore federation with the name
my-metastore-federation in location us-central with two backends dpms1 and
dpms2, run:
$ gcloud alpha metastore federations create \
my-metastore-federation --location=us-central1 \
--backends=1=dpms:dpms1,2=dpms:projects/my-project/locations/\
us-central1/services/dpms2
POSITIONAL ARGUMENTS
Federation resource - Arguments and flags that specify the Dataproc
Metastore federation you want to create. 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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
REQUIRED FLAGS
--backends=RANK=BACKEND
Backends from which the federation service serves metadata at query
time. The backends are specified as a comma-separated list of
RANK=BACKEND pairs. For example:
1=dpms:dpms1,2=dpms:projects/my-project/locations/us-central1/services/dpms2.
RANK represents the rank of the backend metastore and is used to
resolve database name collisions. BACKEND is specified as
METASTORE_TYPE:METASTORE_NAME where METASTORE_TYPE is the type of
backend metastore and METASTORE_NAME is the relative resource name of
the metastore. If only the name of the metastore is specified (e.g.
dpms1), project and location will be inferred from the project and
location used to create the federation.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--hive-metastore-version=HIVE_METASTORE_VERSION
Hive metastore schema version of the Metastore federation.
HIVE_METASTORE_VERSION must be one of: 2.3.6, 3.1.2.
--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.
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 metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations create
$ gcloud beta metastore federations create

View file

@ -0,0 +1,80 @@
NAME
gcloud alpha metastore federations delete - delete one or more Dataproc
Metastore federations
SYNOPSIS
gcloud alpha metastore federations delete
(FEDERATIONS [FEDERATIONS ...] : --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) If run asynchronously with --async, exits after printing one or
more operation names that can be used to poll the status of the deletion(s)
via:
gcloud metastore operations describe
EXAMPLES
To delete a Dataproc Metastore federation with the name
my-metastore-federation in location us-central1, run:
$ gcloud alpha metastore federations delete \
my-metastore-federation --location=us-central1
To delete multiple Dataproc Metastore federations with the name
federation-1 and federation-2 in the same location us-central1, run:
$ gcloud alpha metastore federations delete federation-1 \
federation-2 --location=us-central1
POSITIONAL ARGUMENTS
Federation resource - The federations to delete. 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 federations 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.
FEDERATIONS [FEDERATIONS ...]
IDs of the federations or fully qualified identifiers for the
federations. To set the federation attribute:
▸ provide the argument federations on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
Location to which the federations belongs. To set the location
attribute:
▸ provide the argument federations on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
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.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations delete
$ gcloud beta metastore federations delete

View file

@ -0,0 +1,75 @@
NAME
gcloud alpha metastore federations describe - describe a Dataproc Metastore
federation
SYNOPSIS
gcloud alpha metastore federations describe
(FEDERATION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a Dataproc Metastore federation.
Displays all details of a Dataproc Metastore federation given a valid
federation ID.
EXAMPLES
To describe a Dataproc Metastore federation with the ID
my-metastore-federation in us-central1, run:
$ gcloud alpha metastore federations describe \
my-metastore-federation --location=us-central1
POSITIONAL ARGUMENTS
Federation resource - Arguments and flags that specify the Metastore
federation you want to describe. 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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations describe
$ gcloud beta metastore federations describe

View file

@ -0,0 +1,103 @@
NAME
gcloud alpha metastore federations get-iam-policy - get the IAM policy for
the federation
SYNOPSIS
gcloud alpha metastore federations get-iam-policy
(FEDERATION : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha metastore federations get-iam-policy displays the IAM
policy associated with the federation. If formatted as JSON, the output can
be edited and used as a policy file for set-iam-policy. The output includes
an "etag" field identifying the version emitted and allowing detection of
concurrent policy updates. The "etag" field should be removed to be used as
set-iam-policy input; see gcloud alpha metastore federations set-iam-policy
for additional details.
EXAMPLES
To print the IAM policy for a given federation, run:
$ gcloud alpha metastore federations get-iam-policy my-federation
POSITIONAL ARGUMENTS
Federation resource - Federation for which to display the IAM policy. 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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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 metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations get-iam-policy
$ gcloud beta metastore federations get-iam-policy

View file

@ -0,0 +1,54 @@
NAME
gcloud alpha metastore federations - manage Dataproc Metastore federations
SYNOPSIS
gcloud alpha metastore federations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Dataproc Metastore federations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
(ALPHA) Add an IAM policy binding to a federation.
create
(ALPHA) Create a Dataproc Metastore federation.
delete
(ALPHA) Delete one or more Dataproc Metastore federations.
describe
(ALPHA) Describe a Dataproc Metastore federation.
get-iam-policy
(ALPHA) Get the IAM policy for the federation.
list
(ALPHA) List Dataproc Metastore federations.
remove-iam-policy-binding
(ALPHA) Remove an IAM policy binding from a federation.
set-iam-policy
(ALPHA) Set the IAM policy for the federation.
update
(ALPHA) Update a Dataproc Metastore federation.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations
$ gcloud beta metastore federations

View file

@ -0,0 +1,92 @@
NAME
gcloud alpha metastore federations list - list Dataproc Metastore
federations
SYNOPSIS
gcloud alpha metastore federations list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Lists all federations under the specified project and location.
EXAMPLES
To list all Dataproc Metastore federations in location us-central1, run:
$ gcloud alpha metastore federations list --location=us-central1
To list all Dataproc Metastore federations in all locations, run:
$ gcloud alpha metastore federations list --location=-
FLAGS
Location resource - The location of the federations to list. This
represents a Cloud resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways. To set the project
attribute:
◆ provide the argument --location on the command line with a fully
specified name;
◆ set the property metastore/location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--location=LOCATION
ID of the location or fully qualified identifier for the location. To
set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations list
$ gcloud beta metastore federations list

View file

@ -0,0 +1,98 @@
NAME
gcloud alpha metastore federations remove-iam-policy-binding - remove an
IAM policy binding from a federation
SYNOPSIS
gcloud alpha metastore federations remove-iam-policy-binding
(FEDERATION : --location=LOCATION) --member=PRINCIPAL --role=ROLE
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Remove an IAM policy binding from a federation.
EXAMPLES
To remove an IAM policy binding for the role of roles/metastore.admin for
the user test-user@gmail.com, run:
$ gcloud alpha metastore federations remove-iam-policy-binding \
my-federation --member='user:test-user@gmail.com' \
--role='roles/metastore.admin'
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Federation resource - Federation for which to remove the IAM policy from.
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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to remove the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Deleted principals have an additional deleted: prefix and a ?uid=UID
suffix, where UID is a unique identifier for the principal. Example:
deleted:user:test-user@gmail.com?uid=123456789012345678901.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
The role to remove the principal from.
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 metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations remove-iam-policy-binding
$ gcloud beta metastore federations remove-iam-policy-binding

View file

@ -0,0 +1,82 @@
NAME
gcloud alpha metastore federations set-iam-policy - set the IAM policy for
the federation
SYNOPSIS
gcloud alpha metastore federations set-iam-policy
(FEDERATION : --location=LOCATION) POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Sets the IAM policy for the given federation as defined in a JSON
or YAML file.
See https://cloud.google.com/iam/docs/managing-policies for details of the
policy file format and contents.
EXAMPLES
The following command will read an IAM policy defined in a JSON file
policy.json and set it for the federation my-federation:
$ gcloud alpha metastore federations set-iam-policy my-federation \
policy.json
POSITIONAL ARGUMENTS
Federation resource - Federation for which to display the IAM policy. 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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any
JSON or YAML file conforming to the structure of a Policy
(https://cloud.google.com/iam/reference/rest/v1/Policy).
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations set-iam-policy
$ gcloud beta metastore federations set-iam-policy

View file

@ -0,0 +1,150 @@
NAME
gcloud alpha metastore federations update - update a Dataproc Metastore
federation
SYNOPSIS
gcloud alpha metastore federations update
(FEDERATION : --location=LOCATION)
(--update-backends=RANK=BACKEND --clear-backends
| --remove-backends=RANK) [--async] [--update-labels=[KEY=VALUE,...]]
[--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update the metadata and/or configuration parameters of a Dataproc
Metastore federation.
If run asynchronously with --async, exits after printing one operation name
that can be used to poll the status of the update via:
gcloud metastore operations describe
EXAMPLES
To update a Dataproc Metastore federation with the name
my-metastore-federation in location us-central with two backends dpms1 and
dpms2, run:
$ gcloud alpha metastore federations update \
my-metastore-federation --location=us-central1 \
--update-backends=1=dpms:dpms1,2=dpms:projects/my-project/\
locations/us-central1/services/dpms2
POSITIONAL ARGUMENTS
Federation resource - Arguments and flags that specify the Dataproc
Metastore federation you want 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 federation 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.
FEDERATION
ID of the federation or fully qualified identifier for the
federation. To set the federation attribute:
▸ provide the argument federation on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
▸ provide the argument federation on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property metastore/location.
REQUIRED FLAGS
Update the backend metastores by passing key-value pairs in through the
flags.
At least one of these must be specified:
--update-backends=RANK=BACKEND
Comma-separated list of metastore backends specified as a list of
RANK=BACKEND pairs. For example:
1=dpms:dpms1,2=dpms:projects/my-project/locations/us-central1/services/dpms2.
RANK represents the rank of the backend metastore and is used to
resolve database name collisions. BACKEND is specified as
METASTORE_TYPE:METASTORE_NAME where METASTORE_TYPE is the type of
backend metastore and METASTORE_NAME is the relative resource name of
the metastore. If only the name of the metastore is specified (e.g.
dpms1), project and location will be inferred from the project and
location used to create the federation.
At most one of these can be specified:
--clear-backends
Clear existing metastore backends. --clear-backends must be used
with --update-backends.
--remove-backends=RANK
Comma-separated list of metastore backend keys to remove with the
form RANK1,RANK2. The Key represents the rank of the backend
metastore and is used to resolve database name collisions. If a
RANK does not exist then it is sliently ignored. If
--update-backends is also specified, then --remove-backends is
applied first.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--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.
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 alpha metastore federations update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud alpha metastore federations 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 metastore/v1alpha API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc-metastore/docs
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud metastore federations update
$ gcloud beta metastore federations update

View file

@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS
GROUPS
GROUP is one of the following:
federations
(ALPHA) Manage Dataproc Metastore federations.
locations
(ALPHA) Get information about Dataproc Metastore locations.

View file

@ -22,7 +22,8 @@ SYNOPSIS
--update-config-maps=[KEY=VALUE,...]]
[--image=IMAGE | --source=SOURCE]
[--[no-]allow-unauthenticated --breakglass=JUSTIFICATION
--clear-vpc-connector --[no-]cpu-throttling --description=DESCRIPTION
--clear-vpc-connector --[no-]cpu-boost --[no-]cpu-throttling
--description=DESCRIPTION
--execution-environment=EXECUTION_ENVIRONMENT
--revision-suffix=REVISION_SUFFIX --[no-]session-affinity
--vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS
@ -373,6 +374,11 @@ FLAGS
--clear-vpc-connector
Remove the VPC connector for this resource.
--[no-]cpu-boost
Whether to allocate extra CPU to containers on startup. This can
reduce the percieved latency of a cold start request. Use --cpu-boost
to enable and --no-cpu-boost to disable.
--[no-]cpu-throttling
Whether to throttle the CPU when the container is not actively
serving requests. Use --cpu-throttling to enable and

View file

@ -11,8 +11,8 @@ SYNOPSIS
[--platform=PLATFORM; default="managed"] [--port=PORT]
[--service-account=SERVICE_ACCOUNT] [--tag=TAG] [--timeout=TIMEOUT]
[--no-traffic] [--[no-]use-http2]
[--breakglass=JUSTIFICATION --clear-vpc-connector --[no-]cpu-throttling
--execution-environment=EXECUTION_ENVIRONMENT
[--breakglass=JUSTIFICATION --clear-vpc-connector --[no-]cpu-boost
--[no-]cpu-throttling --execution-environment=EXECUTION_ENVIRONMENT
--revision-suffix=REVISION_SUFFIX --[no-]session-affinity
--vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS
--add-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
@ -209,6 +209,11 @@ FLAGS
--clear-vpc-connector
Remove the VPC connector for this resource.
--[no-]cpu-boost
Whether to allocate extra CPU to containers on startup. This can
reduce the percieved latency of a cold start request. Use --cpu-boost
to enable and --no-cpu-boost to disable.
--[no-]cpu-throttling
Whether to throttle the CPU when the container is not actively
serving requests. Use --cpu-throttling to enable and

View file

@ -3,7 +3,8 @@ NAME
instances
SYNOPSIS
gcloud alpha sql flags list [--database-version=DATABASE_VERSION]
gcloud alpha sql flags list
[--database-version=DATABASE_VERSION; default="MYSQL_8_0"]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
@ -11,9 +12,9 @@ DESCRIPTION
(ALPHA) List customizable flags for Google Cloud SQL instances.
FLAGS
--database-version=DATABASE_VERSION
The database engine type and versions. If left unspecified, the API
defaults are used. See the list of database versions at
--database-version=DATABASE_VERSION; default="MYSQL_8_0"
The database engine type and versions. If left unspecified, MYSQL_8_0
is used. See the list of database versions at
https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/SqlDatabaseVersion.
LIST COMMAND FLAGS

View file

@ -6,12 +6,15 @@ SYNOPSIS
[--activation-policy=ACTIVATION_POLICY]
[--active-directory-domain=ACTIVE_DIRECTORY_DOMAIN]
[--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--[no-]assign-ip]
[--async] [--authorized-networks=NETWORK,[NETWORK,...]]
[--async] [--audit-bucket-path=AUDIT_BUCKET_PATH]
[--audit-retention-interval=AUDIT_RETENTION_INTERVAL]
[--audit-upload-interval=AUDIT_UPLOAD_INTERVAL]
[--authorized-networks=NETWORK,[NETWORK,...]]
[--availability-type=AVAILABILITY_TYPE] [--no-backup]
[--backup-location=BACKUP_LOCATION]
[--backup-start-time=BACKUP_START_TIME] [--collation=COLLATION]
[--cpu=CPU] [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]]
[--database-version=DATABASE_VERSION]
[--database-version=DATABASE_VERSION; default="MYSQL_8_0"]
[--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE]
[--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE]
[--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME]
@ -119,6 +122,19 @@ FLAGS
Return immediately, without waiting for the operation in progress to
complete.
--audit-bucket-path=AUDIT_BUCKET_PATH
The location, as a Cloud Storage bucket, to which audit files are
uploaded. The URI is in the form gs://bucketName/folderName. Only
available for SQL Server instances.
--audit-retention-interval=AUDIT_RETENTION_INTERVAL
The number of days for audit log retention on disk, for example, 3dfor
3 days. Only available for SQL Server instances.
--audit-upload-interval=AUDIT_UPLOAD_INTERVAL
How often to upload audit logs (audit files), for example, 30mfor 30
minutes. Only available for SQL Server instances.
--authorized-networks=NETWORK,[NETWORK,...]
The list of external networks that are allowed to connect to the
instance. Specified in CIDR notation, also known as 'slash' notation
@ -162,9 +178,9 @@ FLAGS
API for allowed flags. (e.g., --database-flags
max_allowed_packet=55555,skip_grant_tables=,log_output=1)
--database-version=DATABASE_VERSION
The database engine type and versions. If left unspecified, the API
defaults are used. See the list of database versions at
--database-version=DATABASE_VERSION; default="MYSQL_8_0"
The database engine type and versions. If left unspecified, MYSQL_8_0
is used. See the list of database versions at
https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/SqlDatabaseVersion.
--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE

View file

@ -7,9 +7,11 @@ SYNOPSIS
[--activation-policy=ACTIVATION_POLICY]
[--active-directory-domain=ACTIVE_DIRECTORY_DOMAIN]
[--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--[no-]assign-ip]
[--async] [--availability-type=AVAILABILITY_TYPE]
[--clear-password-policy] [--cpu=CPU]
[--database-version=DATABASE_VERSION]
[--async] [--audit-bucket-path=AUDIT_BUCKET_PATH]
[--audit-retention-interval=AUDIT_RETENTION_INTERVAL]
[--audit-upload-interval=AUDIT_UPLOAD_INTERVAL]
[--availability-type=AVAILABILITY_TYPE] [--clear-password-policy]
[--cpu=CPU] [--database-version=DATABASE_VERSION]
[--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE]
[--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE]
[--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] [--diff]
@ -86,6 +88,19 @@ FLAGS
Return immediately, without waiting for the operation in progress to
complete.
--audit-bucket-path=AUDIT_BUCKET_PATH
The location, as a Cloud Storage bucket, to which audit files are
uploaded. The URI is in the form gs://bucketName/folderName. Only
available for SQL Server instances.
--audit-retention-interval=AUDIT_RETENTION_INTERVAL
The number of days for audit log retention on disk, for example, 3dfor
3 days. Only available for SQL Server instances.
--audit-upload-interval=AUDIT_UPLOAD_INTERVAL
How often to upload audit logs (audit files), for example, 30mfor 30
minutes. Only available for SQL Server instances.
--availability-type=AVAILABILITY_TYPE
Specifies level of availability. AVAILABILITY_TYPE must be one of: