Stay organized with collections
Save and categorize content based on your preferences.
Resource: NotebookRuntimeTemplate
A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.
Fields
name
string
The resource name of the NotebookRuntimeTemplate.
displayName
string
Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description
string
The description of the NotebookRuntimeTemplate.
isDefault (deprecated)
boolean
Output only. Deprecated: This field has no behavior. Use notebookRuntimeType = 'ONE_CLICK' instead.
Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.
The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels
map (key: string, value: string)
The labels with user-defined metadata to organize the NotebookRuntimeTemplates.
label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
Output only. timestamp when this NotebookRuntimeTemplate was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this NotebookRuntimeTemplate was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# REST Resource: projects.locations.notebookRuntimeTemplates\n\nResource: NotebookRuntimeTemplate\n---------------------------------\n\nA template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.\nFields `name` `string` \nThe resource name of the NotebookRuntimeTemplate.\n`displayName` `string` \nRequired. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`description` `string` \nThe description of the NotebookRuntimeTemplate.\n`isDefault` \n**(deprecated)** `boolean` \n| This item is deprecated!\n\nOutput only. Deprecated: This field has no behavior. Use notebookRuntimeType = 'ONE_CLICK' instead.\n\nThe default template to use if not specified.\n`machineSpec` `object (`[MachineSpec](/vertex-ai/docs/reference/rest/v1/MachineSpec)`)` \nOptional. Immutable. The specification of a single machine for the template.\n`dataPersistentDiskSpec` `object (`[PersistentDiskSpec](/vertex-ai/docs/reference/rest/v1/PersistentDiskSpec)`)` \nOptional. The specification of \\[persistent disk\\]\\[https://cloud.google.com/compute/docs/disks/persistent-disks\\] attached to the runtime as data disk storage.\n`networkSpec` `object (`[NetworkSpec](/vertex-ai/docs/reference/rest/v1/NetworkSpec)`)` \nOptional. Network spec.\n`serviceAccount` \n**(deprecated)** `string` \n| This item is deprecated!\n\nDeprecated: This field is ignored and the \"Vertex AI Notebook service Account\" ([service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com](mailto:service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com)) is used for the runtime workload identity. See \u003chttps://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account\u003e for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead.\n\nThe service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.\n\nIf not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.\n`etag` `string` \nUsed to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.\n`labels` `map (key: string, value: string)` \nThe labels with user-defined metadata to organize the NotebookRuntimeTemplates.\n\nlabel keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.\n\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\n`idleShutdownConfig` `object (`[NotebookIdleShutdownConfig](/vertex-ai/docs/reference/rest/v1/NotebookIdleShutdownConfig)`)` \nThe idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.\n`eucConfig` `object (`[NotebookEucConfig](/vertex-ai/docs/reference/rest/v1/NotebookEucConfig)`)` \nEUC configuration of the NotebookRuntimeTemplate.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookRuntimeTemplate was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookRuntimeTemplate was most recently updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`notebookRuntimeType` `enum (`[NotebookRuntimeType](/vertex-ai/docs/reference/rest/v1/NotebookRuntimeType)`)` \nOptional. Immutable. The type of the notebook runtime template.\n`shieldedVmConfig` `object (`[ShieldedVmConfig](/vertex-ai/docs/reference/rest/v1/ShieldedVmConfig)`)` \nOptional. Immutable. Runtime Shielded VM spec.\n`networkTags[]` `string` \nOptional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).\n`encryptionSpec` `object (`[EncryptionSpec](/vertex-ai/docs/reference/rest/v1/EncryptionSpec)`)` \nCustomer-managed encryption key spec for the notebook runtime.\n`softwareConfig` `object (`[NotebookSoftwareConfig](/vertex-ai/docs/reference/rest/v1/NotebookSoftwareConfig)`)` \nOptional. The notebook software configuration of the notebook runtime."]]
