View, update, and delete realms

This page explains how to view, update, and delete realms in Cloud Number Registry.

Before you begin

Set up Cloud Number Registry.
Select the project in your organization that has been configured to provide Cloud Number Registry access.
Verify that you have the permissions required to complete this guide.

Required roles

To get the permissions that you need to manage Cloud Number Registry, ask your administrator to grant you the Cloud Number Registry IPAM Admin (roles/cloudnumberregistry.ipamAdmin) IAM role on your project. For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

List and view realms

In the Google Cloud console, you can list all realms in a given registry book. In the gcloud CLI, you can list all realms in your IPAM admin scope.

Console

In the Google Cloud console, go to the Cloud Number Registry page.

Go to Cloud Number Registry
Click the Registry books tab.
Click a registry book. The realms associated with the registry book are displayed.
To filter the list of realms, click the Discovered realms or Custom realms tab.
Click the realm that you'd like to view. Details about the realm are displayed.
- If the realm is managed by Cloud Number Registry, the associated discovered ranges are displayed.
- If the realm is user-managed, the associated custom ranges are displayed.

gcloud

List realms by using the gcloud alpha number-registry realms list command.
```
gcloud alpha number-registry realms list \
    --location=global
```
View details about a realm by using the gcloud alpha number-registry realms describe command.
```
gcloud alpha number-registry realms describe REALM \
    --location=global
```
Replace the following:
- REALM: the name of the realm that you want to view.

Update a custom realm

You can update custom realms—realms that are user-managed. You can't update discovered realms—realms that are managed by Cloud Number Registry. The management type is displayed when you view details about a realm.

You can modify the following fields on a custom realm:

Registry book
Traffic type

Console

In the Google Cloud console, go to the Cloud Number Registry page.

Go to Cloud Number Registry
Click the Registry books tab.
Click the registry book that contains the realm you want to update.
Click the Custom realms tab.
Click the realm that you want to update.
Click Edit for the field you want to update.
In the dialog that appears, make your changes.
Click Save.

gcloud

The following example shows how to change the traffic type of a custom realm. For information about all editable settings, see the gcloud alpha number-registry realms update reference documentation.

gcloud alpha number-registry realms update REALM \
    --traffic-type=TRAFFIC_TYPE \
    --location=global

Replace the following:

REALM: the name of the realm to update.
TRAFFIC_TYPE: the updated traffic type for the realm.

Delete a custom realm

You can delete realms that are user-managed. You can't delete a realm if it is managed by Cloud Number Registry. The management type is displayed when you view details about a realm.

Console

In the Google Cloud console, go to the Cloud Number Registry page.

Go to Cloud Number Registry
Click the Registry books tab.
Click the registry book that contains the realm you want to delete.
To filter the list of realms, click the Discovered realms or Custom realms tab.
Click the realm that you want to delete.
Click Delete realm.

gcloud

Delete a realm by using the gcloud alpha number-registry realms delete command.

gcloud alpha number-registry realms delete REALM \
    --location=global

Replace REALM with the name of the realm to delete.