gcloud alpha compute instances patch-partner-metadata

NAME
gcloud alpha compute instances patch-partner-metadata - patch partner metadata
SYNOPSIS
gcloud alpha compute instances patch-partner-metadataINSTANCE_NAME[--partner-metadata=[NAMESPACE/KEY=VALUE,…]][--partner-metadata-from-file=LOCAL_FILE_PATH][--zone=ZONE][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) gcloud alpha compute instances patch-partner-metadata canbe used to patch partner metadata of a virtual machine instance. Every instancehas access to a metadata server that can be used to query partner metadata thathas been set through this tool. For information on metadata, seeAbout VMmetadata.

Only namespaces keys that are provided are mutated. Existing Namespaces entrieswill remain unaffected.

In order to retrieve partner metadata, run:

gcloudcomputeinstancesdescribeexample-instance--zoneus-central1-a--view=FULL--format="value(partnerMetadata)"

where example-instance is the name of the virtual machine instance you'requerying partner metadata from.

EXAMPLES
To add partner metadata under namespacetest.compute.googleapis.com to instanceTEST_INSTANCE run:
gcloudalphacomputeinstancespatch-partner-metadataTEST_INSTANCE--partner-metadata=test.compute.googleapis.com/entries/engine="{ "engine": { "type": V8 } }"

To add partner metadata from a file:

gcloudalphacomputeinstancespatch-partner-metadataTEST_INSTANCE--partner-metadata-from-file=examples/engine.json
POSITIONAL ARGUMENTS
INSTANCE_NAME
Name of the instance to set partner metadata on. For details on valid instancenames, refer to the criteria documented under the field 'name' at:https://cloud.google.com/compute/docs/reference/rest/v1/instances
FLAGS
--partner-metadata=[NAMESPACE/KEY=VALUE,…]
Partner metadata specifying namespace and its entries. The entries can bekey-value pairs or in json format.
--partner-metadata-from-file=LOCAL_FILE_PATH
Path to a local json file containing partner metadata. Use a full or relativepath to a local file containing the value of partner_metadata.
--zone=ZONE
Zone of the instance to set partner metadata on. If not specified, you might beprompted to select a zone (interactive mode only).gcloud attempts to identify theappropriate zone by searching for resources in your currently active project. Ifthe zone cannot be determined,gcloud prompts you for a selection withall available Google Cloud Platform zones.

To avoid prompting when this flag is omitted, the user can set thecompute/zone property:

gcloudconfigsetcompute/zoneZONE

A list of zones can be fetched by running:

gcloudcomputezoneslist

To unset the property, run:

gcloudconfigunsetcompute/zone

Alternatively, the zone can be stored in the environment variableCLOUDSDK_COMPUTE_ZONE.

GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudbetacomputeinstancespatch-partner-metadata

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.