notebook_runtime_templates

Creates, updates, deletes, gets or lists a notebook_runtime_templates resource.

Overview

Name	`notebook_runtime_templates`
Type	Resource
Id	`google.aiplatform.notebook_runtime_templates`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	The resource name of the NotebookRuntimeTemplate.
`createTime`	`string (google-datetime)`	Output only. Timestamp when this NotebookRuntimeTemplate was created.
`dataPersistentDiskSpec`	`object`	Optional. The specification of persistent disk attached to the runtime as data disk storage. (id: GoogleCloudAiplatformV1PersistentDiskSpec)
`description`	`string`	The description 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.
`encryptionSpec`	`object`	Customer-managed encryption key spec for the notebook runtime. (id: GoogleCloudAiplatformV1EncryptionSpec)
`etag`	`string`	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
`eucConfig`	`object`	EUC configuration of the NotebookRuntimeTemplate. (id: GoogleCloudAiplatformV1NotebookEucConfig)
`idleShutdownConfig`	`object`	The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled. (id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig)
`isDefault`	`boolean`	Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
`labels`	`object`	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.
`machineSpec`	`object`	Optional. Immutable. The specification of a single machine for the template. (id: GoogleCloudAiplatformV1MachineSpec)
`networkSpec`	`object`	Optional. Network spec. (id: GoogleCloudAiplatformV1NetworkSpec)
`networkTags`	`array`	Optional. The Compute Engine tags to add to runtime (see Tagging instances).
`notebookRuntimeType`	`string`	Optional. Immutable. The type of the notebook runtime template. (NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED, USER_DEFINED, ONE_CLICK)
`reservationAffinity`	`object`	Optional. Reservation Affinity of the notebook runtime template. (id: GoogleCloudAiplatformV1NotebookReservationAffinity)
`serviceAccount`	`string`	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.
`shieldedVmConfig`	`object`	Optional. Immutable. Runtime Shielded VM spec. (id: GoogleCloudAiplatformV1ShieldedVmConfig)
`softwareConfig`	`object`	Optional. The notebook software configuration of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookSoftwareConfig)
`updateTime`	`string (google-datetime)`	Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Name	Datatype	Description
`name`	`string`	The resource name of the NotebookRuntimeTemplate.
`createTime`	`string (google-datetime)`	Output only. Timestamp when this NotebookRuntimeTemplate was created.
`dataPersistentDiskSpec`	`object`	Optional. The specification of persistent disk attached to the runtime as data disk storage. (id: GoogleCloudAiplatformV1PersistentDiskSpec)
`description`	`string`	The description 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.
`encryptionSpec`	`object`	Customer-managed encryption key spec for the notebook runtime. (id: GoogleCloudAiplatformV1EncryptionSpec)
`etag`	`string`	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
`eucConfig`	`object`	EUC configuration of the NotebookRuntimeTemplate. (id: GoogleCloudAiplatformV1NotebookEucConfig)
`idleShutdownConfig`	`object`	The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled. (id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig)
`isDefault`	`boolean`	Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
`labels`	`object`	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.
`machineSpec`	`object`	Optional. Immutable. The specification of a single machine for the template. (id: GoogleCloudAiplatformV1MachineSpec)
`networkSpec`	`object`	Optional. Network spec. (id: GoogleCloudAiplatformV1NetworkSpec)
`networkTags`	`array`	Optional. The Compute Engine tags to add to runtime (see Tagging instances).
`notebookRuntimeType`	`string`	Optional. Immutable. The type of the notebook runtime template. (NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED, USER_DEFINED, ONE_CLICK)
`reservationAffinity`	`object`	Optional. Reservation Affinity of the notebook runtime template. (id: GoogleCloudAiplatformV1NotebookReservationAffinity)
`serviceAccount`	`string`	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.
`shieldedVmConfig`	`object`	Optional. Immutable. Runtime Shielded VM spec. (id: GoogleCloudAiplatformV1ShieldedVmConfig)
`softwareConfig`	`object`	Optional. The notebook software configuration of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookSoftwareConfig)
`updateTime`	`string (google-datetime)`	Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `notebookRuntimeTemplatesId`		Gets a NotebookRuntimeTemplate.
`list`	`select`	`projectsId`, `locationsId`	`pageToken`, `orderBy`, `filter`, `pageSize`, `readMask`	Lists NotebookRuntimeTemplates in a Location.
`create`	`insert`	`projectsId`, `locationsId`	`notebookRuntimeTemplateId`	Creates a NotebookRuntimeTemplate.
`patch`	`update`	`projectsId`, `locationsId`, `notebookRuntimeTemplatesId`	`updateMask`	Updates a NotebookRuntimeTemplate.
`delete`	`delete`	`projectsId`, `locationsId`, `notebookRuntimeTemplatesId`		Deletes a NotebookRuntimeTemplate.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`locationsId`	`string`
`notebookRuntimeTemplatesId`	`string`
`projectsId`	`string`
`filter`	`string`
`notebookRuntimeTemplateId`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`readMask`	`string (google-fieldmask)`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets a NotebookRuntimeTemplate.

SELECT
name,
createTime,
dataPersistentDiskSpec,
description,
displayName,
encryptionSpec,
etag,
eucConfig,
idleShutdownConfig,
isDefault,
labels,
machineSpec,
networkSpec,
networkTags,
notebookRuntimeType,
reservationAffinity,
serviceAccount,
shieldedVmConfig,
softwareConfig,
updateTime
FROM google.aiplatform.notebook_runtime_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}' -- required
;

Lists NotebookRuntimeTemplates in a Location.

SELECT
name,
createTime,
dataPersistentDiskSpec,
description,
displayName,
encryptionSpec,
etag,
eucConfig,
idleShutdownConfig,
isDefault,
labels,
machineSpec,
networkSpec,
networkTags,
notebookRuntimeType,
reservationAffinity,
serviceAccount,
shieldedVmConfig,
softwareConfig,
updateTime
FROM google.aiplatform.notebook_runtime_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND readMask = '{{ readMask }}'
;

`INSERT` examples

create
Manifest

Creates a NotebookRuntimeTemplate.

INSERT INTO google.aiplatform.notebook_runtime_templates (
data__encryptionSpec,
data__dataPersistentDiskSpec,
data__networkSpec,
data__idleShutdownConfig,
data__notebookRuntimeType,
data__name,
data__machineSpec,
data__labels,
data__serviceAccount,
data__shieldedVmConfig,
data__description,
data__softwareConfig,
data__eucConfig,
data__networkTags,
data__reservationAffinity,
data__displayName,
data__etag,
projectsId,
locationsId,
notebookRuntimeTemplateId
)
SELECT 
'{{ encryptionSpec }}',
'{{ dataPersistentDiskSpec }}',
'{{ networkSpec }}',
'{{ idleShutdownConfig }}',
'{{ notebookRuntimeType }}',
'{{ name }}',
'{{ machineSpec }}',
'{{ labels }}',
'{{ serviceAccount }}',
'{{ shieldedVmConfig }}',
'{{ description }}',
'{{ softwareConfig }}',
'{{ eucConfig }}',
'{{ networkTags }}',
'{{ reservationAffinity }}',
'{{ displayName }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ notebookRuntimeTemplateId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: notebook_runtime_templates
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the notebook_runtime_templates resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the notebook_runtime_templates resource.
  - name: encryptionSpec
    description: |
      Customer-managed encryption key spec for the notebook runtime.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: dataPersistentDiskSpec
    description: |
      Optional. The specification of persistent disk attached to the runtime as data disk storage.
    value:
      diskType: "{{ diskType }}"
      diskSizeGb: "{{ diskSizeGb }}"
  - name: networkSpec
    description: |
      Optional. Network spec.
    value:
      network: "{{ network }}"
      enableInternetAccess: {{ enableInternetAccess }}
      subnetwork: "{{ subnetwork }}"
  - name: idleShutdownConfig
    description: |
      The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.
    value:
      idleTimeout: "{{ idleTimeout }}"
      idleShutdownDisabled: {{ idleShutdownDisabled }}
  - name: notebookRuntimeType
    value: "{{ notebookRuntimeType }}"
    description: |
      Optional. Immutable. The type of the notebook runtime template.
    valid_values: ['NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED', 'USER_DEFINED', 'ONE_CLICK']
  - name: name
    value: "{{ name }}"
    description: |
      The resource name of the NotebookRuntimeTemplate.
  - name: machineSpec
    description: |
      Optional. Immutable. The specification of a single machine for the template.
    value:
      machineType: "{{ machineType }}"
      tpuTopology: "{{ tpuTopology }}"
      reservationAffinity:
        reservationAffinityType: "{{ reservationAffinityType }}"
        key: "{{ key }}"
        values:
          - "{{ values }}"
      acceleratorCount: {{ acceleratorCount }}
      acceleratorType: "{{ acceleratorType }}"
      gpuPartitionSize: "{{ gpuPartitionSize }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      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.
  - name: serviceAccount
    value: "{{ serviceAccount }}"
    description: |
      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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
  - name: shieldedVmConfig
    description: |
      Optional. Immutable. Runtime Shielded VM spec.
    value:
      enableSecureBoot: {{ enableSecureBoot }}
  - name: description
    value: "{{ description }}"
    description: |
      The description of the NotebookRuntimeTemplate.
  - name: softwareConfig
    description: |
      Optional. The notebook software configuration of the notebook runtime.
    value:
      postStartupScriptConfig:
        postStartupScript: "{{ postStartupScript }}"
        postStartupScriptUrl: "{{ postStartupScriptUrl }}"
        postStartupScriptBehavior: "{{ postStartupScriptBehavior }}"
      colabImage:
        releaseName: "{{ releaseName }}"
        description: "{{ description }}"
      env:
        - name: "{{ name }}"
          value: "{{ value }}"
  - name: eucConfig
    description: |
      EUC configuration of the NotebookRuntimeTemplate.
    value:
      eucDisabled: {{ eucDisabled }}
      bypassActasCheck: {{ bypassActasCheck }}
  - name: networkTags
    value:
      - "{{ networkTags }}"
    description: |
      Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
  - name: reservationAffinity
    description: |
      Optional. Reservation Affinity of the notebook runtime template.
    value:
      key: "{{ key }}"
      values:
        - "{{ values }}"
      consumeReservationType: "{{ consumeReservationType }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  - name: etag
    value: "{{ etag }}"
    description: |
      Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  - name: notebookRuntimeTemplateId
    value: "{{ notebookRuntimeTemplateId }}"

`UPDATE` examples

patch

Updates a NotebookRuntimeTemplate.

UPDATE google.aiplatform.notebook_runtime_templates
SET 
data__encryptionSpec = '{{ encryptionSpec }}',
data__dataPersistentDiskSpec = '{{ dataPersistentDiskSpec }}',
data__networkSpec = '{{ networkSpec }}',
data__idleShutdownConfig = '{{ idleShutdownConfig }}',
data__notebookRuntimeType = '{{ notebookRuntimeType }}',
data__name = '{{ name }}',
data__machineSpec = '{{ machineSpec }}',
data__labels = '{{ labels }}',
data__serviceAccount = '{{ serviceAccount }}',
data__shieldedVmConfig = '{{ shieldedVmConfig }}',
data__description = '{{ description }}',
data__softwareConfig = '{{ softwareConfig }}',
data__eucConfig = '{{ eucConfig }}',
data__networkTags = '{{ networkTags }}',
data__reservationAffinity = '{{ reservationAffinity }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
dataPersistentDiskSpec,
description,
displayName,
encryptionSpec,
etag,
eucConfig,
idleShutdownConfig,
isDefault,
labels,
machineSpec,
networkSpec,
networkTags,
notebookRuntimeType,
reservationAffinity,
serviceAccount,
shieldedVmConfig,
softwareConfig,
updateTime;

`DELETE` examples

delete

Deletes a NotebookRuntimeTemplate.

DELETE FROM google.aiplatform.notebook_runtime_templates
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​