Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a NotebookRuntimeTemplate.

post/v1/{+parent}/notebookRuntimeTemplates

Path parameters

parentstring required

Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: projects/{project}/locations/{location}

Query parameters

notebookRuntimeTemplateIdstring

Optional. User specified ID for the notebook runtime template.

Request body

notebookRuntimeType'NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED' | 'USER_DEFINED' | 'ONE_CLICK'

Optional. Immutable. The type of the notebook runtime template.

serviceAccountstring

Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. 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. If not specified, the Compute Engine default service account is used.

displayNamestring

Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.

namestring

The resource name of the NotebookRuntimeTemplate.

descriptionstring

The description of the NotebookRuntimeTemplate.

isDefaultboolean

Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.

networkTagsstring[]

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

updateTimestring google-datetime

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

labelsobject

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. See https://goo.gl/xmQnxf for more information and examples of labels.

etagstring

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

createTimestring google-datetime

Output only. Timestamp when this NotebookRuntimeTemplate was created.

Response

Successful response