Create a specific version of a user-managed notebooks instance

Vertex AI Workbench user-managed notebooks isdeprecated. On April 14, 2025, support for user-managed notebooks ended and the ability to create user-managed notebooks instances was removed. Existing instances will continue to function until March 30, 2026, but patches, updates, and upgrades won't be available. To continue using Vertex AI Workbench, we recommend that youmigrate your user-managed notebooks instances to Vertex AI Workbench instances.

This page describes how you can createa user-managed notebooks instance based on a specificDeep Learning VM Images version.

Why you might want to create a specific version

To ensure that your user-managed notebooks instance has softwarethat is compatible with your code or application, you might want to createa specific version.

User-managed notebooks instances are created by using Deep Learning VM images. Deep Learning VMimages are updated frequently, and specific versions of preinstalled softwareand packages vary from version to version.

To learn more about specific Deep Learning VM versions,see theDeep Learning VMrelease notes.

After you create a specific version of a user-managed notebooks instance, you can upgrade it. Upgrading the instance updates the preinstalled software and packages. For more information, seeUpgrade a user-managednotebooks instance's environment.

Before you begin

Before you can create a user-managed notebooks instance,you must have aGoogle Cloud project and enable the Notebooks APIfor that project.
  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.
    Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Notebooks API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.
    Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Notebooks API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

    Enable the API

  8. If you plan to use GPUs with your user-managed notebooks instance,check the quotas page in the Google Cloud console to ensure that you have enough GPUs available in your project. If GPUs are not listed on the quotas page, or you require additional GPU quota, you can request a quota increase. SeeRequesting an increase in quota on the Compute EngineResource quotas page.

Required roles

If you created the project, you have the Owner (roles/owner) IAM role on the project, which includes all required permissions. Skip this section and start creating your user-managed notebooks instance. If you didn't create the project yourself, continue in this section.

To get the permissions that you need to create a Vertex AI Workbench user-managed notebooks instance, ask your administrator to grant you the following IAM roles on the project:

For more information about granting roles, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

Find the specific version that you want

To create a user-managed notebooks instance based on a specificDeep Learning VM version, you must knowthe image name of the specific Deep Learning VMversion that you want to use.

Each release of Deep Learning VM includes updates tomany different images, and each image in the release has its ownimage name.

To find the specific image name that you want:

  1. Find the Deep Learning VM release numberthat you want to get image names for.Release numbers are included in theDeep Learning VMrelease notes.Release numbers are in the form of anM followed bythe number of the release, for example,M79.

  2. To list the image names for a specific Deep Learning VMrelease, run the following command.

    gcloudcomputeimageslist--project="deeplearning-platform-release"\--format="value(name)"\--filter="labels.release=RELEASE_NUMBER"\--show-deprecated

    ReplaceRELEASE_NUMBER witha Deep Learning VM release number, such asM79.

  3. Find the image name that you want to use.

Create a specific version from the command line

To create a specific version ofa user-managed notebooks instance fromthe command line, complete the following steps:

  1. Run the followinggcloudnotebooks command:

    gcloudnotebooksinstancescreateINSTANCE_NAME\--vm-image-project="deeplearning-platform-release"\--vm-image-name=VM_IMAGE_NAME\--machine-type=MACHINE_TYPE\--location=LOCATION

    Replace the following:

    • INSTANCE_NAME: the name of your newinstance
    • VM_IMAGE_NAME: the image namethat you want to use to create your instance
    • MACHINE_TYPE: themachinetype of your instance's VM
    • LOCATION: the Google Cloudlocation whereyou want your new instance to be

  2. Access your instance from theGoogle Cloud console.

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-18 UTC.