Vertex AI Workbench Runtime

Vertex AI Workbench Runtime is a managed environment in Google Cloud for running Jupyter-based notebooks and machine learning workloads. It provides preconfigured runtimes with popular data science frameworks, seamless integration with Vertex AI services, and scalable compute options. This allows users to develop, train, and deploy models efficiently within a unified environment.

gcp.aiplatform_notebook_runtime

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Timestamp when this NotebookRuntime was created.
data_persistent_disk_speccorejsonOutput only. The specification of persistent disk attached to the notebook runtime as data disk storage.
datadog_display_namecorestring
descriptioncorestringThe description of the NotebookRuntime.
encryption_speccorejsonOutput only. Customer-managed encryption key spec for the notebook runtime.
euc_configcorejsonOutput only. EUC configuration of the notebook runtime.
expiration_timecoretimestampOutput only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
gcp_display_namecorestringRequired. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
health_statecorestringOutput only. The health state of the NotebookRuntime.
idle_shutdown_configcorejsonOutput only. The idle shutdown configuration of the notebook runtime.
is_upgradablecoreboolOutput only. Whether NotebookRuntime is upgradable.
labelscorearray<string>The labels with user-defined metadata to organize your NotebookRuntime. 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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
machine_speccorejsonOutput only. The specification of a single machine used by the notebook runtime.
namecorestringOutput only. The resource name of the NotebookRuntime.
network_speccorejsonOutput only. Network spec of the notebook runtime.
network_tagscorearray<string>Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
notebook_runtime_template_refcorejsonOutput only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
notebook_runtime_typecorestringOutput only. The type of the notebook runtime.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
proxy_uricorestringOutput only. The proxy endpoint used to access the NotebookRuntime.
region_idcorestring
reservation_affinitycorejsonOutput only. Reservation Affinity of the notebook runtime.
resource_namecorestring
runtime_statecorestringOutput only. The runtime (instance) state of the NotebookRuntime.
runtime_usercorestringRequired. The user email of the NotebookRuntime.
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscoreboolOutput only. Reserved for future use.
service_accountcorestringOutput only. Deprecated: This field is no longer used 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. The service account that the NotebookRuntime workload runs as.
shielded_vm_configcorejsonOutput only. Runtime Shielded VM spec.
software_configcorejsonOutput only. Software config of the notebook runtime.
tagscorehstore_csv
update_timecoretimestampOutput only. Timestamp when this NotebookRuntime was most recently updated.
versioncorestringOutput only. The VM os image version of NotebookRuntime.
zone_idcorestring