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

Name	Datatype	Description
name	string	The resource name of the NotebookRuntimeTemplate.
description	string	The description of the NotebookRuntimeTemplate.
createTime	string	Output only. Timestamp when this NotebookRuntimeTemplate was created.
dataPersistentDiskSpec	object	Represents the spec of persistent disk options.
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	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
eucConfig	object	The euc configuration of NotebookRuntimeTemplate.
idleShutdownConfig	object	The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.
isDefault	boolean	Output only. 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	Specification of a single machine.
networkSpec	object	Network spec.
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.
serviceAccount	string	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	A set of Shielded Instance options. See Images using supported Shielded VM features.
updateTime	string	Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, notebookRuntimeTemplatesId, projectsId	Gets a NotebookRuntimeTemplate.
list	SELECT	locationsId, projectsId	Lists NotebookRuntimeTemplates in a Location.
create	INSERT	locationsId, projectsId	Creates a NotebookRuntimeTemplate.
delete	DELETE	locationsId, notebookRuntimeTemplatesId, projectsId	Deletes a NotebookRuntimeTemplate.
patch	UPDATE	locationsId, notebookRuntimeTemplatesId, projectsId	Updates a NotebookRuntimeTemplate.

SELECT examples

Lists NotebookRuntimeTemplates in a Location.

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

INSERT example

Use the following StackQL query and manifest file to create a new notebook_runtime_templates resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.notebook_runtime_templates (
locationsId,
projectsId,
machineSpec,
notebookRuntimeType,
shieldedVmConfig,
name,
description,
displayName,
labels,
eucConfig,
encryptionSpec,
serviceAccount,
networkSpec,
idleShutdownConfig,
etag,
dataPersistentDiskSpec,
networkTags
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ machineSpec }}',
'{{ notebookRuntimeType }}',
'{{ shieldedVmConfig }}',
'{{ name }}',
'{{ description }}',
'{{ displayName }}',
'{{ labels }}',
'{{ eucConfig }}',
'{{ encryptionSpec }}',
'{{ serviceAccount }}',
'{{ networkSpec }}',
'{{ idleShutdownConfig }}',
'{{ etag }}',
'{{ dataPersistentDiskSpec }}',
'{{ networkTags }}'
;

Manifest

machineSpec:
  acceleratorCount: integer
  reservationAffinity:
    key: string
    reservationAffinityType: string
    values:
      - type: string
  tpuTopology: string
  acceleratorType: string
  machineType: string
notebookRuntimeType: string
shieldedVmConfig:
  enableSecureBoot: boolean
name: string
description: string
displayName: string
labels: object
eucConfig:
  eucDisabled: boolean
  bypassActasCheck: boolean
encryptionSpec:
  kmsKeyName: string
isDefault: boolean
serviceAccount: string
networkSpec:
  subnetwork: string
  enableInternetAccess: boolean
  network: string
createTime: string
idleShutdownConfig:
  idleTimeout: string
  idleShutdownDisabled: boolean
etag: string
dataPersistentDiskSpec:
  diskType: string
  diskSizeGb: string
updateTime: string
networkTags:
  - type: string

UPDATE example

Updates a notebook_runtime_templates resource.

/*+ update */
UPDATE google.aiplatform.notebook_runtime_templates
SET 
machineSpec = '{{ machineSpec }}',
notebookRuntimeType = '{{ notebookRuntimeType }}',
shieldedVmConfig = '{{ shieldedVmConfig }}',
name = '{{ name }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
labels = '{{ labels }}',
eucConfig = '{{ eucConfig }}',
encryptionSpec = '{{ encryptionSpec }}',
serviceAccount = '{{ serviceAccount }}',
networkSpec = '{{ networkSpec }}',
idleShutdownConfig = '{{ idleShutdownConfig }}',
etag = '{{ etag }}',
dataPersistentDiskSpec = '{{ dataPersistentDiskSpec }}',
networkTags = '{{ networkTags }}'
WHERE 
locationsId = '{{ locationsId }}'
AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified notebook_runtime_templates resource.

/*+ delete */
DELETE FROM google.aiplatform.notebook_runtime_templates
WHERE locationsId = '{{ locationsId }}'
AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}'
AND projectsId = '{{ projectsId }}';