- NAME
-
- gcloud alpha number-registry ipam-admin-scopes update - update the parameters of a single IPAM admin scope resource
- SYNOPSIS
-
-
gcloud alpha number-registry ipam-admin-scopes update(IPAM_ADMIN_SCOPE:--location=LOCATION) [--async] [--enabled-addon-platforms=[ENABLED_ADDON_PLATFORMS,…]] [--request-id=REQUEST_ID] [--scopes=[SCOPES,…]] [--labels=[LABELS,…] |--update-labels=[UPDATE_LABELS,…]--clear-labels|--remove-labels=REMOVE_LABELS] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Update an IPAM admin scope resource. - EXAMPLES
-
To update the labels of an IPAM admin scope
my-ipam-admin-scoperun:gcloud alpha number-registry ipam-admin-scopes update my-ipam-admin-scope --location=global --update-labels=key=value - POSITIONAL ARGUMENTS
-
-
IpamAdminScope resource - Identifier. name of resource 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
projectattribute:-
provide the argument
ipam_admin_scopeon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
IPAM_ADMIN_SCOPE-
ID of the ipamAdminScope or fully qualified identifier for the ipamAdminScope.
To set the
ipam_admin_scopeattribute:-
provide the argument
ipam_admin_scopeon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location id of the ipamAdminScope resource.
To set the
locationattribute:-
provide the argument
ipam_admin_scopeon the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
IpamAdminScope resource - Identifier. name of resource 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.
- FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--enabled-addon-platforms=[ENABLED_ADDON_PLATFORMS,…]-
Addon platforms that are enabled for this IPAM admin scope. Cloud Number
Registry only discovers the IP addresses from the enabled platforms.
ENABLED_ADDON_PLATFORMSmust be one of:compute-engine- Google Compute Engine.
gce- Deprecated: Use COMPUTE_ENGINE instead.
--request-id=REQUEST_ID-
An optional request ID to identify requests. Specify a unique request ID so that
if you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
--scopes=[SCOPES,…]- Administrative scopes enabled for IP address discovery and management. For example, "organizations/1234567890". Minimum of 1 scope is required. In preview, only one organization scope is allowed.
-
Update labels.
At most one of these can be specified:
--labels=[LABELS,…]-
Set labels to new value. Labels as key value pairs.
KEY-
Keys must start with a lowercase character and contain only hyphens
(
-), underscores (_), lowercase characters, and numbers. VALUE-
Values must contain only hyphens (
-), underscores (_), lowercase characters, and numbers.
Shorthand Example:--labels=string=string
JSON Example:--labels='{"string": "string"}'
File Example:--labels=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--update-labels=[UPDATE_LABELS,…]-
Update labels value or add key value pair. Labels as key value pairs.
KEY-
Keys must start with a lowercase character and contain only hyphens
(
-), underscores (_), lowercase characters, and numbers. VALUE-
Values must contain only hyphens (
-), underscores (_), lowercase characters, and numbers.
Shorthand Example:--update-labels=string=string
JSON Example:--update-labels='{"string": "string"}'
File Example:--update-labels=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-labels- Clear labels value and set to empty map.
--remove-labels=REMOVE_LABELS-
Remove existing value from map labels. Sets
remove_labelsvalue.Shorthand Example:--remove-labels=string,stringJSON Example:--remove-labels=["string"]
File Example:--remove-labels=path_to_file.(yaml|json)
- 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
cloudnumberregistry/v1alphaAPI. The full documentation for this API can be found at: https://docs.cloud.google.com/number-registry/reference/rest - 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.
gcloud alpha number-registry ipam-admin-scopes update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-28 UTC.