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

gcloud: Wed Jan 15 09:50:59 UTC 2025

This commit is contained in:
Automated 2025-01-15 09:50:59 +00:00
parent 5a9f5ff67e
commit 4a036681b1
126 changed files with 4290 additions and 679 deletions

View file

@ -0,0 +1,23 @@
NAME
gcloud beta quotas adjuster - the command group for Cloud Quotas Adjuster
SYNOPSIS
gcloud beta quotas adjuster GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) The command group for Cloud Quotas Adjuster.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
settings
(BETA) The command group for Cloud Quotas AdjusterSettings.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,31 @@
NAME
gcloud beta quotas adjuster settings describe - gets details of the
QuotaAdjusterSettings for a project
SYNOPSIS
gcloud beta quotas adjuster settings describe
--project=PROJECT_ID_OR_NUMBER [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command gets the QuotaAdjusterSettings for a project.
EXAMPLES
To get the QuotaAdjusterSettings for container 'projects/12321', run:
$ gcloud beta quotas adjuster settings describe --project=12321
REQUIRED FLAGS
--project=PROJECT_ID_OR_NUMBER
Project of the container id.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,28 @@
NAME
gcloud beta quotas adjuster settings - the command group for Cloud Quotas
AdjusterSettings
SYNOPSIS
gcloud beta quotas adjuster settings COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) A QuotaAdjusterSettings resource represents your adjuster setting
for a particular project. Enable this to automatically adjust quotas.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Gets details of the QuotaAdjusterSettings for a project.
update
(BETA) Update the QuotaAdjusterSettings of a project.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,42 @@
NAME
gcloud beta quotas adjuster settings update - update the
QuotaAdjusterSettings of a project
SYNOPSIS
gcloud beta quotas adjuster settings update --enablement=ENABLEMENT
--project=PROJECT_ID_OR_NUMBER [--validate-only] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command updates the enablement state of a project.
EXAMPLES
To update QuotaAdjusterSettings for projects/12321, run:
$ gcloud beta quotas adjuster settings update --enablement=enabled \
--project=12321
REQUIRED FLAGS
--enablement=ENABLEMENT
Enablement state of the QuotaAdjusterSettings. ENABLEMENT must be one
of: enabled, disabled.
--project=PROJECT_ID_OR_NUMBER
Project of the container id.
OPTIONAL FLAGS
--validate-only
If specified, only validates the request, but does not actually update.
Note that a request being valid does not mean that the request is
guaranteed to be fulfilled. Default is false.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice.

34
gcloud/beta/quotas/help Normal file
View file

@ -0,0 +1,34 @@
NAME
gcloud beta quotas - manage Cloud Quotas quota info, quota preferences and
quota adjuster settings
SYNOPSIS
gcloud beta quotas GROUP [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Cloud Quotas quota info, quota preferences and quota adjuster
settings.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
adjuster
(BETA) The command group for Cloud Quotas Adjuster.
info
(BETA) Manage Cloud Quotas QuotaInfo.
preferences
(BETA) Manage Cloud Quotas QuotaPreferences.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas

View file

@ -0,0 +1,55 @@
NAME
gcloud beta quotas info describe - retrieve the QuotaInfo of a quota for a
project, folder or organization
SYNOPSIS
gcloud beta quotas info describe QUOTA_ID --service=SERVICE
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID_OR_NUMBER) [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To get the details about quota CpusPerProject for service
example.$$UNIVERSE_DOMAIN$$ and projects/my-project, run:
$ gcloud beta quotas info describe CpusPerProject \
--service=example.$$UNIVERSE_DOMAIN$$ --project=my-project
To get the details about quota CpusPerProject for service
example.$$UNIVERSE_DOMAIN$$ and folders/123, run:
$ gcloud beta quotas info describe CpusPerProject \
--service=example.$$UNIVERSE_DOMAIN$$ --folder=123
POSITIONAL ARGUMENTS
QUOTA_ID
ID of the quota, which is unique within the service.
REQUIRED FLAGS
--service=SERVICE
Name of the service in which the quota is defined.
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the quota info to describe.
--organization=ORGANIZATION_ID
Organization of the quota info to describe.
--project=PROJECT_ID_OR_NUMBER
Project of the quota info to describe.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas info describe

View file

@ -0,0 +1,46 @@
NAME
gcloud beta quotas info - manage Cloud Quotas QuotaInfo
SYNOPSIS
gcloud beta quotas info COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) QuotaInfo is a read-only resource that provides metadata and quota
value information about a particular quota for a given project, folder or
organization. The QuotaInfo resource contains:
▪ Metadata such as name and dimension.
▪ Quota values for different quota dimensions.
Cloud Quotas obtains information from the quotas defined by Google Cloud
services and any fulfilled quota adjustments that you initiate.
Note: Because QuotaInfo is constructed by incorporating information from
different sources, a default quota configuration exists even if you have
not created a QuotaPreference resource. Until you express a preferred state
through quotaPreference.create or quotaPreference.update, QuotaInfo relies
on the default quota information available to determine what quota value to
enforce.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Retrieve the QuotaInfo of a quota for a project, folder or
organization.
list
(BETA) List QuotaInfos of all quotas for a given project, folder or
organization.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas info

View file

@ -0,0 +1,89 @@
NAME
gcloud beta quotas info list - list QuotaInfos of all quotas for a given
project, folder or organization
SYNOPSIS
gcloud beta quotas info list --service=SERVICE
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
EXAMPLES
To list all quota info for service example.$$UNIVERSE_DOMAIN$$ and
projects/12321, run:
$ gcloud beta quotas info list \
--service=example.$$UNIVERSE_DOMAIN$$ --project=12321
$ gcloud beta quotas info list \
--service=example.$$UNIVERSE_DOMAIN$$m --project=my-project-id
To list first 100 quota info ordered alphabetically for service
`example.$$UNIVERSE_DOMAIN$$` and `folders/123`,
run:
$ gcloud beta quotas info list \
--service=example.$$UNIVERSE_DOMAIN$$ --folder=123 \
--page-size=100
REQUIRED FLAGS
--service=SERVICE
Name of the service in which the quota is defined.
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the quota info to list.
--organization=ORGANIZATION_ID
Organization of the quota info to list.
--project=PROJECT_ID_OR_NUMBER
Project of the quota info to list.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas info list

View file

@ -0,0 +1,97 @@
NAME
gcloud beta quotas preferences create - create a new QuotaPreference that
declares the desired value for a quota
SYNOPSIS
gcloud beta quotas preferences create --preferred-value=PREFERRED_VALUE
--quota-id=QUOTA_ID --service=SERVICE
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID_OR_NUMBER)
[--allow-high-percentage-quota-decrease]
[--allow-quota-decrease-below-usage] [--dimensions=[KEY=VALUE,...]]
[--email=EMAIL] [--justification=JUSTIFICATION]
[--preference-id=PREFERENCE_ID] [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To create a quota preference in region us-central1 that applies to the
default_limit quota under service example.$$UNIVERSE_DOMAIN$$ for
projects/12321, run:
$ gcloud beta quotas preferences create \
--service=example.$$UNIVERSE_DOMAIN$$ --project=12321 \
--quota-id=default_limit --preferred-value=100 \
--dimensions=region=us-central1 \
--preference-id=example_default-limit_us-central1
To create a quota preference under service example.$$UNIVERSE_DOMAIN$$``
for organizations/789 with random preference ID, run:
$ gcloud beta quotas preferences create \
--service=example.$$UNIVERSE_DOMAIN$$ --organization=789 \
--quota-id=default_limit --preferred-value=200
REQUIRED FLAGS
--preferred-value=PREFERRED_VALUE
Preferred value. Must be greater than or equal to -1. If set to -1, it
means the value is "unlimited".
--quota-id=QUOTA_ID
ID of the quota, which is unique within the service.
--service=SERVICE
Name of the service in which the quota is defined.
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the quota preference to create.
--organization=ORGANIZATION_ID
Organization of the quota preference to create.
--project=PROJECT_ID_OR_NUMBER
Project of the quota preference to create.
OPTIONAL FLAGS
--allow-high-percentage-quota-decrease
If specified, allows you to reduce your effective limit by more than 10
percent. Default is false.
--allow-quota-decrease-below-usage
If specified, allows you to reduce your effective limit below your
quota usage. Default is false.
--dimensions=[KEY=VALUE,...]
Dimensions of the quota.
--email=EMAIL
An optional email address that can be used for quota related
communication between the Google Cloud and the user in case the Google
Cloud needs further information to make a decision on whether the user
preferred quota can be granted. The Google account for the email
address must have quota update permission for the project, folder or
organization this quota preference is for. If no contact email address
is provided, or the provided email address does not have the required
quota update permission, the quota preference request will be denied in
case further information is required to make a decision.
--justification=JUSTIFICATION
A short statement to justify quota increase requests.
--preference-id=PREFERENCE_ID
ID of the Quota Preference object, must be unique under its parent.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas preferences create

View file

@ -0,0 +1,53 @@
NAME
gcloud beta quotas preferences describe - get details about a single
QuotaPreference
SYNOPSIS
gcloud beta quotas preferences describe PREFERENCE_ID
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID_OR_NUMBER) [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To get the details about quota preference my-preference for projects/12321,
run:
$ gcloud beta quotas preferences describe my-preference \
--project=12321
$ gcloud beta quotas preferences describe my-preference \
--project=my-project-id
To get the details about quota preference my-preference for folders/123,
run:
$ gcloud beta quotas preferences describe my-preference --folder=123
POSITIONAL ARGUMENTS
PREFERENCE_ID
ID of the Quota Preference object, must be unique under its parent.
REQUIRED FLAGS
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the quota preference to describe.
--organization=ORGANIZATION_ID
Organization of the quota preference to describe.
--project=PROJECT_ID_OR_NUMBER
Project of the quota preference to describe.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas preferences describe

View file

@ -0,0 +1,43 @@
NAME
gcloud beta quotas preferences - manage Cloud Quotas QuotaPreferences
SYNOPSIS
gcloud beta quotas preferences COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) A QuotaPreference resource represents your preference for a
particular dimension combination. Use this resource to make quota increase
adjustments to quotas in your projects and to make quota decrease
adjustments to quotas in your projects, folders or organizations. Quota
increase adjustments are subject to approval and fulfillment. Quota
decreases are fulfilled immediately. Use the Cloud Quotas console UI or API
to set a quota preference.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create a new QuotaPreference that declares the desired value for
a quota.
describe
(BETA) Get details about a single QuotaPreference.
list
(BETA) List QuotaPreferences in a given project, folder or
organization.
update
(BETA) Update the parameters of a single QuotaPreference.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas preferences

View file

@ -0,0 +1,92 @@
NAME
gcloud beta quotas preferences list - list QuotaPreferences in a given
project, folder or organization
SYNOPSIS
gcloud beta quotas preferences list
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID_OR_NUMBER) [--reconciling-only]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To list the quota preferences for projects/12321, run:
$ gcloud beta quotas preferences list --project=12321
$ gcloud beta quotas preferences list --project=my-project-id
To list first 10 quota preferences ordered by create time for folder/123,
run:
$ gcloud beta quotas preferences list --folder=123 --page-size=10 \
--sort-by=create_time
To list all quota preferences in unresolved state in region us-central1 for
organization/789, run:
$ gcloud beta quotas preferences list --organization=789 \
--filter=dimensions.region:us-central1 --reconciling-only
REQUIRED FLAGS
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the quota preferences to list.
--organization=ORGANIZATION_ID
Organization of the quota preferences to list.
--project=PROJECT_ID_OR_NUMBER
Project of the quota preferences to list.
FLAGS
--reconciling-only
If specified, only displays quota preferences in unresolved states.
Default is false.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas preferences list

View file

@ -0,0 +1,109 @@
NAME
gcloud beta quotas preferences update - update the parameters of a single
QuotaPreference
SYNOPSIS
gcloud beta quotas preferences update PREFERENCE_ID
--preferred-value=PREFERRED_VALUE --quota-id=QUOTA_ID --service=SERVICE
(--folder=FOLDER_ID | --organization=ORGANIZATION_ID
| --project=PROJECT_ID_OR_NUMBER)
[--allow-high-percentage-quota-decrease] [--allow-missing]
[--allow-quota-decrease-below-usage] [--dimensions=[KEY=VALUE,...]]
[--email=EMAIL] [--justification=JUSTIFICATION] [--validate-only]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) This command updates an existing or creates a new QuotaPreference.
It can updates the config in any states, not just the ones pending
approval.
EXAMPLES
To update a quota preference with id my-preference in region us-central1
that applies to the default_limit quota for projects/12321, run:
$ gcloud beta quotas preferences update my-preference \
--service=example.$$UNIVERSE_DOMAIN$$ --project=12321 \
--quota-id=default_limit --preferred-value=100 \
--dimensions=region=us-central1
To create a new quota preference for organizations/789, run:
$ gcloud beta quotas preferences update my-preference \
--service=example.$$UNIVERSE_DOMAIN$$ --organization=789 \
--quota-id=default_limit --preferred-value=200 --allow-missing
POSITIONAL ARGUMENTS
PREFERENCE_ID
ID of the Quota Preference object, must be unique under its parent.
REQUIRED FLAGS
--preferred-value=PREFERRED_VALUE
Preferred value. Must be greater than or equal to -1. If set to -1, it
means the value is "unlimited".
--quota-id=QUOTA_ID
ID of the quota, which is unique within the service.
--service=SERVICE
Name of the service in which the quota is defined.
Exactly one of these must be specified:
--folder=FOLDER_ID
Folder of the quota preference to update.
--organization=ORGANIZATION_ID
Organization of the quota preference to update.
--project=PROJECT_ID_OR_NUMBER
Project of the quota preference to update.
OPTIONAL FLAGS
--allow-high-percentage-quota-decrease
If specified, allows you to reduce your effective limit by more than 10
percent. Default is false.
--allow-missing
If specified and the quota preference is not found, a new one will be
created. Default is false.
--allow-quota-decrease-below-usage
If specified, allows you to reduce your effective limit below your
quota usage. Default is false.
--dimensions=[KEY=VALUE,...]
Dimensions of the quota.
--email=EMAIL
An optional email address that can be used for quota related
communication between the Google Cloud and the user in case the Google
Cloud needs further information to make a decision on whether the user
preferred quota can be granted. The Google account for the email
address must have quota update permission for the project, folder or
organization this quota preference is for. If no contact email address
is provided, or the provided email address does not have the required
quota update permission, the quota preference request will be denied in
case further information is required to make a decision.
--justification=JUSTIFICATION
A short statement to justify quota increase requests.
--validate-only
If specified, only validates the request, but does not actually update.
Note that a request being valid does not mean that the request is
guaranteed to be fulfilled. Default is false.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha quotas preferences update