gcloud alpha compute health-aggregation-policies update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha compute health-aggregation-policies update - update a health aggregation policy
- SYNOPSIS
gcloud alpha compute health-aggregation-policies update(HEALTH_AGGREGATION_POLICY:--region=REGION)(--description=DESCRIPTION--healthy-percent-threshold=HEALTHY_PERCENT_THRESHOLD--min-healthy-threshold=MIN_HEALTHY_THRESHOLD)[--async][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Update a health aggregation policy.- EXAMPLES
- The following command updates a health aggregation policy:
- POSITIONAL ARGUMENTS
- Health aggregation policy resource - The health aggregation policy you want toupdate. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
To set the
projectattribute:- provide the argument
health_aggregation_policyon the command linewith a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
HEALTH_AGGREGATION_POLICY- ID of the health aggregation policy or fully qualified identifier for the healthaggregation policy.
To set the
health_aggregation_policyattribute:- provide the argument
health_aggregation_policyon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--region=REGION- The name of the Google Compute Engine region.
To set the
regionattribute:- provide the argument
health_aggregation_policyon the command linewith a fully specified name; - provide the argument
--regionon the command line; - set the property
compute/region.
- provide the argument
- provide the argument
- Health aggregation policy resource - The health aggregation policy you want toupdate. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
- REQUIRED FLAGS
- At least one of these must be specified:
--description=DESCRIPTION- A textual description of the health aggregation policy.
--healthy-percent-threshold=HEALTHY_PERCENT_THRESHOLD- Can only be set if the policyType field is BACKEND_SERVICE_POLICY. Specifies thethreshold (as a percentage) of healthy endpoints required in order to considerthe aggregated health result HEALTHY. Defaults to 60. Must be in range [0, 100].Not applicable if the policyType field is DNS_PUBLIC_IP_POLICY. Can be mutated.This field is optional, and will be set to the default if unspecified. Note thatboth this threshold and minHealthyThreshold must be satisfied in order forHEALTHY to be the aggregated result. "Endpoints" refers to network endpointswithin a Network Endpoint Group or instances within an Instance Group.
--min-healthy-threshold=MIN_HEALTHY_THRESHOLD- Can only be set if the policyType field is BACKEND_SERVICE_POLICY. Specifies theminimum number of healthy endpoints required in order to consider the aggregatedhealth result HEALTHY. Defaults to 1. Must be positive. Not applicable if thepolicyType field is DNS_PUBLIC_IP_POLICY. Can be mutated. This field isoptional, and will be set to the default if unspecified. Note that both thisthreshold and healthyPercentThreshold must be satisfied in order for HEALTHY tobe the aggregated result. "Endpoints" refers to network endpoints within aNetwork Endpoint Group or instances within an Instance Group.
- At least one of these must be specified:
- 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 helpfor details. - API REFERENCE
- This command uses the
compute/alphaAPI. The full documentation forthis API can be found at:https://cloud.google.com/compute/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudalphacomputehealth-aggregation-policiesupdate<HEALTH_AGGREGATION_POLICY_NAME>--region=<REGION>--healthy-percent-threshold60--min-healthy-threshold2gcloudbetacomputehealth-aggregation-policiesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-14 UTC.