Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Gerenciar atributos usando metadados
Nesta página, descrevemos como gerenciar alguns recursos de instâncias do Vertex AI Workbench
modificando os pares de chave-valor de metadados da instância.
Chaves de metadados
Para informações sobre recursos e as respectivas chaves de metadados, consulte a tabela a seguir.
Recurso
Descrição
Chave de metadados
Valores e padrões aceitos
Ativa o Cloud Storage FUSE em uma imagem de contêiner
Monta /dev/fuse no contêiner e ativa
gcsfuse para uso no contêiner.
container-allow-fuse
true: ativa o Cloud Storage FUSE.
false (padrão): não ativa o Cloud Storage FUSE.
nbconvert
Permite exportar e fazer o download de notebooks como um tipo de arquivo diferente.
notebook-disable-nbconvert
true: desativa o nbconvert.
false (padrão): ativa o nbconvert.
Excluir para a lixeira
Usa o comportamento de lixeira do sistema operacional ao
excluir do JupyterLab.
notebook-enable-delete-to-trash
true: ativa a exclusão para a lixeira.
false (padrão): usa o comportamento padrão do JupyterLab.
Programa atualizações automáticas do SO da instância. Ativa o serviço de upgrade
não supervisionado do Debian e só se aplica a imagens baseadas em VM.
install-unattended-upgrades
true: ativa as atualizações automáticas do SO.
false (padrão): desativa as atualizações automáticas do SO.
Usuário do Jupyter personalizado
Especifica o nome do usuário padrão do Jupyter. Essa configuração determina o nome da pasta para seus notebooks. Por exemplo, em vez do diretório /home/jupyter/ padrão, é possível alterar o diretório para /home/CUSTOM_NAME.
Essa chave de metadados não afeta o acesso à instância.
jupyter-user
Uma string. O valor padrão é jupyter.
Permitir downloads do arquivo
Permite fazer o download de arquivos do JupyterLab.
notebook-disable-downloads
true: desativa o download de arquivos.
false (padrão): ativa o download de arquivos.
Acesso raiz
Ativa o acesso raiz.
notebook-disable-root
true: desativa o acesso raiz.
false (padrão): ativa o acesso raiz.
Acesso ao terminal
Permite o acesso ao terminal.
notebook-disable-terminal
true: desativa o acesso ao terminal.
false (padrão): ativa o acesso ao terminal.
Upgrades programados
Programa upgrades automáticos da instância.
notebook-upgrade-schedule
A programação semanal ou mensal que você define, no formato unix-cron, por exemplo, 00 19 * * MON significa "semanalmente" às segundas-feiras, às 1900 horas, horário de Greenwich (GMT).
Esse recurso fica desativado por padrão.
Script pós-inicialização
Executa um script personalizado após a inicialização.
post-startup-script
O URI de um script de pós-inicialização no Cloud Storage, por exemplo:
gs://bucket/hello.sh. Esse recurso fica desativado por padrão.
Comportamento do script pós-inicialização
Define quando e como o script pós-inicialização é executado.
post-startup-script-behavior
run_once (padrão): executa o script de pós-inicialização uma vez após a criação ou o upgrade da instância.
run_every_start: executa o script pós-inicialização após cada início.
download_and_run_every_start: refaz o download do script pós-inicialização da origem e executa o script após cada início.
Reportar integridade do evento
Verifica a integridade a cada 30 segundos para métricas da VM.
report-event-health
true (padrão): ativa a geração de relatórios de integridade do evento.
false: desativa os relatórios de integridade do evento.
Algumas das chaves de metadados são predefinidas pelo Compute Engine. Para mais informações, consulte Chaves de metadados predefinidas.
Chaves de metadados protegidas
Algumas chaves de metadados são reservadas somente para uso do sistema. Se você atribuir valores a essas chaves de metadados, os novos valores serão substituídos pelos do sistema.
As chaves de metadados reservadas incluem, entre outras:
data-disk-uri
enable-oslogin
framework
notebooks-api
notebooks-api-version
nvidia-driver-gcs-path
proxy-url
restriction
shutdown-script
title
version
Criar uma instância com metadados específicos
É possível criar uma instância do Vertex AI Workbench com metadados específicos usando o Google Cloud console, a Google Cloud CLI,
o Terraform ou a API Notebooks.
Console
Ao criar uma instância do Vertex AI Workbench, é possível adicionar metadados na seção Ambiente de Opções avançadas.
gcloud
Ao criar uma instância do Vertex AI Workbench, é possível adicionar metadados usando o comando a seguir:
Use o método instances.create
com valores de metadados para gerenciar os atributos correspondentes.
Atualizar os metadados de uma instância
É possível atualizar os metadados de uma instância do Vertex AI Workbench
usando o console Google Cloud , a Google Cloud CLI,
o Terraform ou a API Notebooks.
Console
Para atualizar os metadados de uma instância do Vertex AI Workbench,
faça o seguinte:
No console Google Cloud , acesse a página Instâncias.
Use o método instances.patch
com valores de metadados e gce_setup.metadata no updateMask
para gerenciar os recursos correspondentes.
Remover metadados de uma instância
É possível remover metadados de uma instância do Vertex AI Workbench
usando o Google Cloud console, a Google Cloud CLI,
o Terraform ou a API Notebooks.
Console
Para remover metadados de uma instância do Vertex AI Workbench,
faça o seguinte:
No console Google Cloud , acesse a página Instâncias.
Use o método instances.patch com o valor de metadados definido como uma string vazia e gce_setup.metadata no updateMask para remover o atributo correspondente.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-19 UTC."],[],[],null,["# Manage features through metadata\n================================\n\nThis page describes how to manage some Vertex AI Workbench instance features\nby modifying the instance's metadata key-value pairs.\n\nMetadata keys\n-------------\n\nFor information about features and their respective metadata keys,\nsee the following table.\n\nMetadata managed by Compute Engine\n----------------------------------\n\nSome of the metadata keys are predefined by Compute Engine. For more\ninformation, see\n[Predefined metadata\nkeys](/compute/docs/metadata/predefined-metadata-keys).\n\nProtected metadata keys\n-----------------------\n\nSome metadata keys are reserved for system use only. If you assign\nvalues to these metadata keys, the new values will be overwritten by the\nsystem values.\n\nReserved metadata keys include and are not limited to:\n\n- `data-disk-uri`\n- `enable-oslogin`\n- `framework`\n- `notebooks-api`\n- `notebooks-api-version`\n- `nvidia-driver-gcs-path`\n- `proxy-url`\n- `restriction`\n- `shutdown-script`\n- `title`\n- `version`\n\nCreate an instance with specific metadata\n-----------------------------------------\n\nYou can create a Vertex AI Workbench instance with specific metadata\nby using the Google Cloud console, the Google Cloud CLI,\nTerraform, or the Notebooks API. \n\n### Console\n\nWhen you create a Vertex AI Workbench instance, you can add\nmetadata in the **Environment** section of **Advanced options**.\n\n### gcloud\n\nWhen you create a Vertex AI Workbench instance, you can add\nmetadata by using the following command: \n\n```bash\ngcloud workbench instances create INSTANCE_NAME --metadata=KEY=VALUE\n```\n\n### Terraform\n\nTo add metadata, create the resource with metadata key-value pairs.\n\n\u003cbr /\u003e\n\nTo learn how to apply or remove a Terraform configuration, see\n[Basic Terraform commands](/docs/terraform/basic-commands).\n\n\u003cbr /\u003e\n\n resource \"google_workbench_instance\" \"default\" {\n name = \"workbench-instance-example\"\n location = \"us-central1-a\"\n\n gce_setup {\n machine_type = \"n1-standard-1\"\n vm_image {\n project = \"cloud-notebooks-managed\"\n family = \"workbench-instances\"\n }\n metadata = {\n key = \"value\"\n }\n }\n }\n\n### Notebooks API\n\nUse the [`instances.create`](/vertex-ai/docs/workbench/reference/rest/v2/projects.locations.instances/create)\nmethod with metadata values to manage the corresponding features.\n\nUpdate an instance's metadata\n-----------------------------\n\nYou can update the metadata of a Vertex AI Workbench instance\nby using the Google Cloud console, the Google Cloud CLI,\nTerraform, or the Notebooks API. \n\n### Console\n\nTo update the metadata of a Vertex AI Workbench instance,\ndo the following:\n\n1. In the Google Cloud console, go to the **Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/vertex-ai/workbench/instances)\n2. In the list of instances, click the name of the instance that you want\n to update.\n\n3. On the **Instance details** page, click **Software and security**.\n\n4. In the **Metadata** section, update the metadata key-value pairs that\n you want to change.\n\n5. Click **Submit**.\n\n### gcloud\n\nYou can update the metadata on a Vertex AI Workbench instance\nby using the following command: \n\n```bash\ngcloud workbench instances update INSTANCE_NAME --metadata=KEY=VALUE\n```\n\n### Terraform\n\nYou can change the metadata key-value pairs to manage\nthe corresponding features on Vertex AI Workbench instances.\n\n\u003cbr /\u003e\n\nTo learn how to apply or remove a Terraform configuration, see\n[Basic Terraform commands](/docs/terraform/basic-commands).\n\n\u003cbr /\u003e\n\n resource \"google_workbench_instance\" \"default\" {\n name = \"workbench-instance-example\"\n location = \"us-central1-a\"\n\n gce_setup {\n machine_type = \"n1-standard-1\"\n vm_image {\n project = \"cloud-notebooks-managed\"\n family = \"workbench-instances\"\n }\n metadata = {\n key = \"updated_value\"\n }\n }\n }\n\n### Notebooks API\n\nUse the [`instances.patch`](/vertex-ai/docs/workbench/reference/rest/v2/projects.locations.instances/patch)\nmethod with metadata values and `gce_setup.metadata` in the `updateMask`\nto manage the corresponding features.\n\nRemove metadata from an instance\n--------------------------------\n\nYou can remove metadata from a Vertex AI Workbench instance\nby using the Google Cloud console, the Google Cloud CLI,\nTerraform, or the Notebooks API. \n\n### Console\n\nTo remove metadata from a Vertex AI Workbench instance,\ndo the following:\n\n1. In the Google Cloud console, go to the **Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/vertex-ai/workbench/instances)\n2. In the list of instances, click the name of the instance that you want\n to modify.\n\n3. On the **Instance details** page, click **Software and security**.\n\n4. In the **Metadata** section, to the right of a key-value pair that\n you want to delete, click\n delete **Delete**.\n\n5. Click **Submit**.\n\n### gcloud\n\nYou can remove metadata from a Vertex AI Workbench instance\nby using the following command: \n\n```bash\ngcloud workbench instances update INSTANCE_NAME --metadata=KEY\n```\n\n### Terraform\n\nYou can remove metadata key-value pairs to manage the\ncorresponding features of a Vertex AI Workbench instance.\n\n\u003cbr /\u003e\n\nTo learn how to apply or remove a Terraform configuration, see\n[Basic Terraform commands](/docs/terraform/basic-commands).\n\n\u003cbr /\u003e\n\n resource \"google_workbench_instance\" \"default\" {\n name = \"workbench-instance-example\"\n location = \"us-central1-a\"\n\n gce_setup {\n machine_type = \"n1-standard-1\"\n vm_image {\n project = \"cloud-notebooks-managed\"\n family = \"workbench-instances\"\n }\n metadata = {\n }\n }\n }\n\n### Notebooks API\n\nUse the [`instances.patch`](/vertex-ai/docs/workbench/reference/rest/v2/projects.locations.instances/patch)\nmethod with the metadata value set to an empty string and\n`gce_setup.metadata` in the `updateMask` to remove the\ncorresponding feature."]]
