imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 02:25:19 +00:00
Code Activity
gcloud-help/gcloud/billing/budgets/update
Automated 1456dab6c7 gcloud: Tue Mar 1 04:29:52 UTC 2022
2022-03-01 04:29:52 +00:00

198 lines
8.4 KiB
Text
Raw Blame History

NAME
gcloud billing budgets update - update a budget
SYNOPSIS
gcloud billing budgets update (BUDGET : --billing-account=BILLING_ACCOUNT)
[--credit-types-treatment=CREDIT_TYPES_TREATMENT]
[--disable-default-iam-recipients] [--display-name=DISPLAY_NAME]
[--filter-credit-types=[FILTER_CREDIT_TYPES,...]]
[--filter-labels=FILTER_LABELS]
[--filter-projects=[FILTER_PROJECTS,...]]
[--filter-services=[FILTER_SERVICES,...]]
[--filter-subaccounts=[FILTER_SUBACCOUNTS,...]]
[--notifications-rule-monitoring-notification-channels=[NOTIFICATIONS_RULE_MONITORING_NOTIFICATION_CHANNELS,
...]]
[--notifications-rule-pubsub-topic=NOTIFICATIONS_RULE_PUBSUB_TOPIC]
[--budget-amount=BUDGET_AMOUNT | --last-period-amount]
[--calendar-period=CALENDAR_PERIOD
| [--start-date=START_DATE : --end-date=END_DATE]]
[--threshold-rules-from-file=THRESHOLD_RULES_FROM_FILE
| --add-threshold-rule=ADD_THRESHOLD_RULE --clear-threshold-rules]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a budget.
EXAMPLES
To update the amount in the budget called 'abc' in account '123' to
'987.65', run:
$ gcloud billing budgets update billingAccounts/123/budgets/abc \
--budget-amount=987.65
Alternatively, you can run:
$ gcloud billing budgets update abc --billing-account=123 \
--budget-amount=987.65
POSITIONAL ARGUMENTS
Budget resource - Billing budget to update. The arguments in this group
can be used to specify the attributes of this resource.
This must be specified.
BUDGET
ID of the budget or fully qualified identifier for the budget. To set
the budget attribute:
▸ provide the argument budget on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--billing-account=BILLING_ACCOUNT
The billing account.
To set the billing-account attribute:
▸ provide the argument budget on the command line with a fully
specified name;
▸ provide the argument --billing-account on the command line.
FLAGS
--credit-types-treatment=CREDIT_TYPES_TREATMENT
Whether to include all credit types when calculating the actual spend
against the budget. If this is not specified, then all credit types are
used in the calculation. If this is set to include-specified-credits,
then --filter-credit-types must be specified with a nonempty list of
credits. CREDIT_TYPES_TREATMENT must be one of:
credit-types-treatment-unspecified, exclude-all-credits,
include-all-credits, include-specified-credits.
--disable-default-iam-recipients
When set to true, disables default notifications sent when a threshold
is exceeded. Default notifications are sent to those with Billing
Account Administrator and Billing Account User IAM roles for the target
account.
--display-name=DISPLAY_NAME
User data for display name in UI. Must be less than or equal to 60
characters.
--filter-credit-types=[FILTER_CREDIT_TYPES,...]
Set of credit types, specifying that usage from only this set of
credits should be included in the budget. If a nonempty list is
specified, then --credit-types-treatment must be
include-specified-credits.
--filter-labels=FILTER_LABELS
Single label and value pair specifying that usage from only this set of
labeled resources should be included in the budget. Currently, multiple
entries or multiple values per entry are not allowed. If omitted, the
report will include all labeled and unlabeled usage.
--filter-projects=[FILTER_PROJECTS,...]
Set of projects in the form projects/{project_id}, specifying that
usage from only this set of projects should be included in the budget.
If omitted, all projects will be included.
--filter-services=[FILTER_SERVICES,...]
Set of services of the form services/{service_id}, specifying that
usage from only this set of services should be included in the budget.
If omitted, the report will include usage for all services. The service
names are available through the Catalog API:
https://cloud.google.com/billing/v1/how-tos/catalog-api.
--filter-subaccounts=[FILTER_SUBACCOUNTS,...]
Set of subaccounts of the form billingAccounts/{account_id}, specifying
that usage from only this set of subaccounts should be included in the
budget. If a subaccount is set to the name of the parent account, usage
from the parent account will be included. If omitted, the report will
include usage from the parent account and all subaccounts, if they
exist.
--notifications-rule-monitoring-notification-channels=[NOTIFICATIONS_RULE_MONITORING_NOTIFICATION_CHANNELS,...]
Targets to send notifications to when a threshold is exceeded. This is
in addition to default recipients who have billing account roles. The
value is the full REST resource name of a monitoring notification
channel in the form
projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5
channels is allowed. See
https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients
for more details.
--notifications-rule-pubsub-topic=NOTIFICATIONS_RULE_PUBSUB_TOPIC
Name of the Cloud Pub/Sub topic where budget related messages will be
published, in the form projects/{project_id}/topics/{topic_id}.
At most one of these can be specified:
--budget-amount=BUDGET_AMOUNT
Specify the amount of the budget. If a currency type is included, it
must be the existing currency associated with the budget.
--last-period-amount
Use the amount of last period's budget.
At most one of these can be specified:
--calendar-period=CALENDAR_PERIOD
Specifies to track usage over recurring calendar period. If you're
creating a budget with a custom time period, omit this flag.
CALENDAR_PERIOD must be one of: calendar-period-unspecified, month,
quarter, year.
--start-date=START_DATE
Specifies to track usage after any start date. This time period is
static, it does not recur.
This flag must be specified if any of the other arguments in this
group are specified.
--end-date=END_DATE
Specifies to track usage before any end date. This time period is
static, it does not recur. If specified, --start-date must also be
specified.
At most one of these can be specified:
--threshold-rules-from-file=THRESHOLD_RULES_FROM_FILE
Import a file with the updated threshold rules. The threshold rules
in the file will replace the rules in the budget. This can be used to
add or remove specific threshold rules.
--add-threshold-rule=ADD_THRESHOLD_RULE
Rule that triggers alerts (notifications of thresholds being crossed)
when spend exceeds the specified percentages of the budget. This flag
can be repeated to provide multiple thresholds above which an alert
is sent.
percent
Integer between 0 and 100 above which an alert is sent.
basis
Type of basis used to determine if spend has passed the
threshold. Must be one of: 'current-spend' or 'forecasted-spend'.
Behavior defaults to 'current-spend' if not set.
--clear-threshold-rules
Removes all threshold rules from the budget.
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 billingbudgets/v1 API. The full documentation for
this API can be found at:
https://cloud.google.com/billing/docs/how-to/budget-api-overview
NOTES
These variants are also available:
$ gcloud alpha billing budgets update
$ gcloud beta billing budgets update
View git blame Copy permalink