gcloud alpha number-registry realms update

NAME
gcloud alpha number-registry realms update - update the parameters of a single realm resource
SYNOPSIS
gcloud alpha number-registry realms update REALM [--async] [--ip-version=IP_VERSION] [--location=LOCATION] [--management-type=MANAGEMENT_TYPE] [--registry-book=REGISTRY_BOOK] [--request-id=REQUEST_ID] [--traffic-type=TRAFFIC_TYPE] [--labels=[LABELS,…]     | --update-labels=[UPDATE_LABELS,…] --clear-labels     | --remove-labels=REMOVE_LABELS] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Update a realm resource.
EXAMPLES
To update the labels of a realm my-realm run: 
gcloud alpha number-registry realms update my-realm --location=global --update-labels=key=value
POSITIONAL ARGUMENTS
Realm resource - Identifier. Unique name/ID of the 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.

This must be specified.

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.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--ip-version=IP_VERSION
IP version of the realm. IP_VERSION must be one of:
ipv4
IPv4 IP version.
ipv6
IPv6 IP version.
--location=LOCATION
For resources [realm, registry-book], provides fallback value for resource location attribute. When the resource's full URI path is not provided, location will fallback to this flag value.
--management-type=MANAGEMENT_TYPE
Management type of realm. MANAGEMENT_TYPE must be one of:
cnr
Managed by Cloud Number Registry.
user
Managed by User.
RegistryBook resource - URI of the registry book that claims the 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 --registry-book 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 --registry-book on the command line with a fully specified name;
  • provide the argument --location on the command line.
--registry-book=REGISTRY_BOOK
ID of the registryBook or fully qualified identifier for the registryBook.

To set the registry-book attribute:

  • provide the argument --registry-book on the command line.
--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.
--traffic-type=TRAFFIC_TYPE
Traffic type of realm. TRAFFIC_TYPE must be one of:
internet
Internet traffic.
linklocal
Linklocal traffic.
private
Private traffic.
unset
Unset traffic type.
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.