Manage a zone

This page explains how to update or delete an existing Dataplex zone in a lake.

Before you begin

  • If you haven't done so already, add a zone.

  • Most gcloud lake commands require a location. You can specify the location by using the --location flag.

  • To update or delete a data zone, you must be granted IAM roles containing the dataplex.lakes.create and the dataplex.zones.update IAM permissions respectively. The Dataplex pre-defined roles roles/dataplex.admin and roles/dataplex.editor can be used to grant, update, or delete permission.

  • You can also give update or delete permission to users or groups by using the roles/owner and roles/editor roles.

For more information, see Dataplex Access control with IAM.

Updating a zone

You can update a data zone by issuing a Dataplex API method lakes.zones.patch or by editing data zone parameters on the Zones tab of the lake page opened in a local browser.

Only one update job is supported at a time, and each job can have multiple property updates. You can still use the data zone while it's being updated. The following data zone parameters can be updated:

The following instructions demonstrate how to update a Dataplex lake using the Google Cloud console or the Dataplex API.

Console

  1. In the Cloud console, open the Dataplex page:

    Open Dataplex in the Cloud console

  2. On the Dataplex page, click the lake name of the lake you'd like to update. The lake page for that lake opens.

    lake detail page
  3. On the Zones tab, click the data zone name of the data zone you'd like to update. The data zone page for that data zone opens.

  4. At the top of the page, click Edit. The Edit zone dialog opens.

  5. Choose the updated data zone parameter values.

  6. Click Save to update the data zone.

  7. Verify that you have returned to the data zone page, and that your updated data zone is active.

REST

Follow the API instructions to update a zone by using the APIs Explorer.

When the update succeeds, the data zone automatically enters active state. If it fails, then the data zone is rolled back to its previous healthy state.

Deleting a zone

You can delete a data zone by issuing a Dataplex API method lakes.zones.delete or by clicking delete on the data zone page opened in a local browser.

You may want to delete your data zone if your configurations, such as data zone name or type are wrong and can't be changed.

The following instructions demonstrate how to delete a Dataplex zone using the Google Cloud console or the Dataplex API.

Console

  1. In the Cloud console, open the Dataplex page:

    Open Dataplex in the Cloud console

  2. On the Dataplex page, click the lake name of the lake you'd like to delete a zone from. The lake page for that lake opens.

    lake detail page
  3. On the Zones tab, select the data zone by checking the box to the left of the data zone name.

  4. Click Delete Zone.

  5. Click Delete to confirm the deletion.

    You can also delete your data zone on the data zone page.

  6. On the Dataplex page, click the lake name of the lake you'd like to delete a data zone from. The lake page for that lake opens.

  7. On the Zones tab, click the data zone name of the data zone you'd like to delete.

  8. At the top of the page, click Delete.

  9. On the dialog, click Delete to confirm the deletion.

  10. Verify that you have returned to the lake page, and that your deleted data zone no longer appears in the data zone list.

REST

Follow the API instructions to delete a zone by using the APIs Explorer.

All deletions are immediate.

What's next?