gcloud alpha number-registry custom-ranges update

NAME
gcloud alpha number-registry custom-ranges update - update the parameters of a single custom range resource
SYNOPSIS
gcloud alpha number-registry custom-ranges update CUSTOM_RANGE [--async] [--description=DESCRIPTION] [--location=LOCATION] [--request-id=REQUEST_ID] [--attributes=[key=KEY],[value=VALUE]     | --add-attributes=[key=KEY],[value=VALUE] --clear-attributes     | --remove-attributes=[key=KEY],[value=VALUE]] [--clear-parent-range     | --parent-range=PARENT_RANGE] [--clear-realm     | --realm=REALM] [--ipv4-cidr-range=IPV4_CIDR_RANGE     | --ipv6-cidr-range=IPV6_CIDR_RANGE] [--labels=[LABELS,…]     | --update-labels=[UPDATE_LABELS,…] --clear-labels     | --remove-labels=REMOVE_LABELS] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update a custom range resource.
EXAMPLES
To update the labels of a custom range my-custom-range run:
gcloud alpha number-registry custom-ranges update my-custom-range --location=global --update-labels=key=value
POSITIONAL ARGUMENTS
CustomRange resource - Identifier. name of resource 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 custom_range on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

To set the location attribute:

  • provide the argument custom_range on the command line with a fully specified name;
  • provide the argument --location on the command line.

This must be specified.

CUSTOM_RANGE
ID of the customRange or fully qualified identifier for the customRange.

To set the custom_range attribute:

  • provide the argument custom_range on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--description=DESCRIPTION
Description of the CustomRange.
--location=LOCATION
For resources [custom_range, parent-range, realm], provides fallback value for resource location attribute. When the resource's full URI path is not provided, location will fallback to this flag value.
--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).

Update attributes.

At most one of these can be specified:

--attributes=[key=KEY],[value=VALUE]
Set attributes to new value. The attributes of the CustomRange.
key
Key of attribute.
value
Value of attribute.
Shorthand Example:
--attributes=key=string,value=string --attributes=key=string,value=string

JSON Example:

--attributes='[{"key": "string", "value": "string"}]'

File Example:

--attributes=path_to_file.(yaml|json)
Or at least one of these can be specified:
--add-attributes=[key=KEY],[value=VALUE]
Add new value to attributes list. The attributes of the CustomRange.
key
Key of attribute.
value
Value of attribute.
Shorthand Example:
--add-attributes=key=string,value=string --add-attributes=key=string,value=string

JSON Example:

--add-attributes='[{"key": "string", "value": "string"}]'

File Example:

--add-attributes=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-attributes
Clear attributes value and set to empty list.
--remove-attributes=[key=KEY],[value=VALUE]
Remove existing value from attributes list. The attributes of the CustomRange.
key
Key of attribute.
value
Value of attribute.
Shorthand Example:
--remove-attributes=key=string,value=string --remove-attributes=key=string,value=string

JSON Example:

--remove-attributes='[{"key": "string", "value": "string"}]'

File Example:

--remove-attributes=path_to_file.(yaml|json)
Update parent_range.

At most one of these can be specified:

--clear-parent-range
Clear parent_range value and set to null.
CustomRange resource - Set parent_range to new value.

The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project}/locations/{location}/customRanges/{custom_range} 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 --parent-range on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

To set the location attribute:

  • provide the argument --parent-range on the command line with a fully specified name;
  • provide the argument --location on the command line.
--parent-range=PARENT_RANGE
ID of the customRange or fully qualified identifier for the customRange.

To set the custom-range attribute:

  • provide the argument --parent-range on the command line.
Update realm.

At most one of these can be specified:

--clear-realm
Clear realm value and set to null.
Realm resource - Set realm to new value.

The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project}/locations/{location}/realms/{realm} 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 --realm on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

To set the location attribute:

  • provide the argument --realm on the command line with a fully specified name;
  • provide the argument --location on the command line.
--realm=REALM
ID of the realm or fully qualified identifier for the realm.

To set the realm attribute:

  • provide the argument --realm on the command line.
Arguments for the ip cidr range.

At most one of these can be specified:

--ipv4-cidr-range=IPV4_CIDR_RANGE
The IPv4 CIDR range of the CustomRange.
--ipv6-cidr-range=IPV6_CIDR_RANGE
The IPv6 CIDR range of the CustomRange.
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_labels value. Shorthand Example:
--remove-labels=string,string

JSON 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 help for details.

API REFERENCE
This command uses the cloudnumberregistry/v1alpha API. 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.