Create an instance in a specific subnet

By default, every instance has a single network interface that determinesthe VPC network that the instance uses. You cancreate an instance with multiple network interfaces,but each interface must connect to a different VPC network. Eachnetwork must have at least one subnet, which defines the range of IPv4 orIPv6 addresses that can be assigned to the instance.

For more information, see the following:

By default, Google Cloud creates anauto mode VPC networkcalleddefault for each project. To use a different network or a subnet thatyou manually created in an auto mode or custom mode VPC network,you must specify the subnet when you create the instance and configure thenetwork interface.

Before you begin

Required roles

To get the permissions that you need to create an instance with a specific subnet, ask your administrator to grant you theCompute Instance Admin (v1) (roles/compute.instanceAdmin.v1) IAM role on the project. For more information about granting roles, seeManage access to projects, folders, and organizations.

This predefined role contains the permissions required to create an instance with a specific subnet. To see the exact permissions that are required, expand theRequired permissions section:

Required permissions

The following permissions are required to create an instance with a specific subnet:

  • compute.instances.create on the project
  • To specify a subnet for your instance: compute.subnetworks.use on the project or on the chosen subnet
  • To assign an external IP address to the instance when using a VPC network: compute.subnetworks.useExternalIp on the project or on the chosen subnet

You might also be able to get these permissions withcustom roles or otherpredefined roles.

Requirements

When you create an instance in a subnet, consider these rules:

  • If you don't specify a network or subnet, Compute Engine uses thedefault VPC network and the auto subnet that's in the sameregion as the instance.
  • If you don't specify a network, Compute Engine infers the networkfrom the subnet specified.
  • If you specify a network, you must specify a subnet and it must belong tothe same network. Otherwise, instance creation fails.

You must create the subnet that you want to use before you create theinstance. For more information, seeCreate and manage VPC networks.

Create an instance in a specific subnet

To create an instance in a specific subnet, follow these steps:

Console

  1. In the Google Cloud console, go to theCreate an instance page.

    Go to Create an instance

    If prompted, select your project and clickContinue.

    TheCreate an instance page appears and displays theMachine configuration pane.

  2. In theMachine configuration pane, do the following:

    1. In theName field, specify a name for your instance. For moreinformation, seeResource naming convention.

    2. Optional: In theZone field, select a zone for this instance.

      The default selection isAny. If you don't change this defaultselection, then Google automatically chooses a zone for you based onmachine type and availability.

    3. Select the machine family for your instance. The Google Cloud consolethen displays the machine series that are available for yourselected machine family. The following machine family options areavailable:

      • General purpose
      • Compute optimized
      • Memory optimized
      • Storage optimized
      • GPUs

    4. In theSeries column, select the machine series for yourinstance.

      If you selectedGPUs as the machine family in the previous step,then select theGPU type that you want. The machine series isthen automatically selected for the selected GPU type.

    5. In theMachine type section, select the machine type for yourinstance.

  3. In the navigation menu, clickNetworking. In theNetworking panethat appears, do the following:

    1. To permit HTTP or HTTPS traffic to the instance, go to theFirewall section and selectAllow HTTP traffic orAllow HTTPS traffic.

      The Compute Engine adds a network tag to your instance andcreates the corresponding ingress firewall rule that allows allincoming traffic ontcp:80 (HTTP) ortcp:443 (HTTPS). Thenetwork tag associates the firewall rule with the instance. For moreinformation, seeFirewall rules overviewin the Cloud Next Generation Firewall documentation.

    2. To specify the network interface details, go to theNetwork interfaces section and clickAdd a network interface.

      In theNew network interface section that appears, do thefollowing:

      1. In theNetwork field, select the VPC network that containsthe subnet you created.
      2. In theSubnetwork list, select the subnet for the instanceto use.
      3. In theIP stack type field, select the IP stack type forthe network interface.
      4. To confirm the network interface details, clickDone.

  4. Optional: Specify other configuration options. For more information, seeConfiguration options during instance creation.

  5. To create and start the instance, clickCreate.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, aCloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Using the Google Cloud CLI, follow the same instructions tocreate an instance from a public imageor asnapshot, and include thenetworking flags shown in this section when you run thegcloud compute instances create command:

    gcloud compute instances createINSTANCE_NAME \    --zone=ZONE \    --machine-type=MACHINE_TYPE \    --create-disk=boot=yes,image=projects/IMAGE_PROJECT/global/images/IMAGE,size=SIZE \    --network=NETWORK_NAME \    --subnet=SUBNET_NAME \    --stack-type=STACK_TYPE \    --private-network-ip=INTERNAL_IPV4_ADDRESS \    --address=EXTERNAL_IPV4_ADDRESS \    --nic-type=GVNIC

    Replace the following:

    • INSTANCE_NAME: thenameof the compute instance
    • ZONE: the zone where the instance is created,such aseurope-west1-b. The instance's region is inferred from thezone.
    • MACHINE_TYPE: Optional: the machine type touse for the instance.
    • IMAGE_PROJECT: Optional: theimage projectthat contains the image
    • IMAGE: Optional: specify one of thefollowing:
      • A specific version of the OS image—for example,rocky-linux-9-optimized-gcp-v20240717.
      • Animage family,which must be formatted asfamily/IMAGE_FAMILY. This createsthe instance from the most recent, non-deprecated OS image. Forexample, if you specifyfamily/rocky-linux-9-optimized-gcp, thenCompute Engine creates an instance using the latestversion of the OS image in the Rocky Linux 9 optimized forGoogle Cloud image family. For more information about using imagefamilies, seeImage families best practices.
    • SIZE: Optional: the size of the newdisk. The value must be a whole number. The default unit ofmeasurement is GiB.
    • NETWORK_NAME: Optional: name of the network

    • SUBNET_NAME: name of the subnet to usewith the instance.

      To view a list of subnets in the network, use thegcloud compute networks subnets list command.

    • STACK_TYPE: Optional: the stack type forthe network interface.STACK_TYPE must be one of:IPV4_ONLY,IPV4_IPV6, orIPV6_ONLY(Preview).The default value isIPV4_ONLY.

    • INTERNAL_IPV4_ADDRESS: Optional: theinternal IPv4 address that you want the compute instance to use in thetarget subnet. Omit this flag if you don't need a specific IP address.

      To specify an internal IPv6 address, use the flag--internal-ipv6-address instead.

    • EXTERNAL_IPV4_ADDRESS: Optional: the static external IPv4address to use with the network interface. You must have previouslyreserved an external IPv4 address.Do one of the following:

      • Specify a valid IPv4 address from the subnet.
      • Use the flag--network-interface=no-address instead if you don'twant the network interface to have an external IP address.
      • Specifyaddress='' if you want the interface to receivean ephemeral external IP address.

      To specify an external IPv6 address, use the flag--external-ipv6-address instead.

Terraform

To create an instance in a specific subnet, you can use thegoogle_compute_instance resource.

# Create a VM in a custom VPC network and subnetresource "google_compute_instance" "custom_subnet" {  name         = "my-vm-instance"  tags         = ["allow-ssh"]  zone         = "europe-west1-b"  machine_type = "e2-small"  network_interface {    network    = google_compute_network.custom.id    subnetwork = google_compute_subnetwork.custom.id  }  boot_disk {    initialize_params {      image = "debian-cloud/debian-12"    }  }}

To learn how to apply or remove a Terraform configuration, seeBasic Terraform commands.

To generate the Terraform code, you can use theEquivalent code component in the Google Cloud console.
  1. In the Google Cloud console, go to theVM instances page.

    Go to VM Instances

  2. ClickCreate instance.
  3. Specify the parameters you want.
  4. At the top or bottom of the page, clickEquivalent code, and then click theTerraform tab to view the Terraform code.

Go

Before trying this sample, follow theGo setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineGo API reference documentation.

To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.

import("context""fmt""io"compute"cloud.google.com/go/compute/apiv1"computepb"cloud.google.com/go/compute/apiv1/computepb""google.golang.org/protobuf/proto")// createInstanceWithSubnet creates a new VM instance with Debian 10 operating system in specified network and subnetwork.funccreateInstanceWithSubnet(wio.Writer,projectID,zone,instanceName,networkLink,subnetworkLinkstring)error{// projectID := "your_project_id"// zone := "europe-central2-b"// instanceName := "your_instance_name"// networkLink := "global/networks/default"// subnetworkLink := "regions/region/subnetworks/subnetwork_name"ctx:=context.Background()instancesClient,err:=compute.NewInstancesRESTClient(ctx)iferr!=nil{returnfmt.Errorf("NewInstancesRESTClient: %w",err)}deferinstancesClient.Close()imagesClient,err:=compute.NewImagesRESTClient(ctx)iferr!=nil{returnfmt.Errorf("NewImagesRESTClient: %w",err)}deferimagesClient.Close()// List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details.newestDebianReq:=&computepb.GetFromFamilyImageRequest{Project:"debian-cloud",Family:"debian-12",}newestDebian,err:=imagesClient.GetFromFamily(ctx,newestDebianReq)iferr!=nil{returnfmt.Errorf("unable to get image from family: %w",err)}req:=&computepb.InsertInstanceRequest{Project:projectID,Zone:zone,InstanceResource:&computepb.Instance{Name:proto.String(instanceName),Disks:[]*computepb.AttachedDisk{{InitializeParams:&computepb.AttachedDiskInitializeParams{DiskSizeGb:proto.Int64(10),SourceImage:newestDebian.SelfLink,DiskType:proto.String(fmt.Sprintf("zones/%s/diskTypes/pd-standard",zone)),},AutoDelete:proto.Bool(true),Boot:proto.Bool(true),Type:proto.String(computepb.AttachedDisk_PERSISTENT.String()),},},MachineType:proto.String(fmt.Sprintf("zones/%s/machineTypes/n1-standard-1",zone)),NetworkInterfaces:[]*computepb.NetworkInterface{{Name:proto.String(networkLink),Subnetwork:proto.String(subnetworkLink),},},},}op,err:=instancesClient.Insert(ctx,req)iferr!=nil{returnfmt.Errorf("unable to create instance: %w",err)}iferr=op.Wait(ctx);err!=nil{returnfmt.Errorf("unable to wait for the operation: %w",err)}fmt.Fprintf(w,"Instance created\n")returnnil}

Java

Before trying this sample, follow theJava setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineJava API reference documentation.

To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.

importcom.google.api.gax.longrunning.OperationFuture;importcom.google.cloud.compute.v1.AttachedDisk;importcom.google.cloud.compute.v1.AttachedDisk.Type;importcom.google.cloud.compute.v1.AttachedDiskInitializeParams;importcom.google.cloud.compute.v1.Image;importcom.google.cloud.compute.v1.ImagesClient;importcom.google.cloud.compute.v1.InsertInstanceRequest;importcom.google.cloud.compute.v1.Instance;importcom.google.cloud.compute.v1.InstancesClient;importcom.google.cloud.compute.v1.NetworkInterface;importcom.google.cloud.compute.v1.Operation;importjava.io.IOException;importjava.util.Vector;importjava.util.concurrent.ExecutionException;importjava.util.concurrent.TimeUnit;importjava.util.concurrent.TimeoutException;publicclassCreateInstancesAdvanced{/**   * Create an AttachedDisk object to be used in VM instance creation. Uses an image as the source   * for the new disk.   *   * @param diskType the type of disk you want to create. This value uses the following format:   * "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example:   * "zones/us-west3-b/diskTypes/pd-ssd"   * @param diskSizeGb size of the new disk in gigabytes   * @param boot boolean flag indicating whether this disk should be used as a boot disk of an   * instance   * @param sourceImage source image to use when creating this disk. You must have read access to   * this disk. This can be one of the publicly available images or an image from one of your   * projects. This value uses the following format:   * "projects/{project_name}/global/images/{image_name}"   * @return AttachedDisk object configured to be created using the specified image.   */privatestaticAttachedDiskdiskFromImage(StringdiskType,intdiskSizeGb,booleanboot,StringsourceImage){AttachedDiskdisk=AttachedDisk.newBuilder().setBoot(boot)// Remember to set auto_delete to True if you want the disk to be deleted when// you delete your VM instance..setAutoDelete(true).setType(Type.PERSISTENT.toString()).setInitializeParams(AttachedDiskInitializeParams.newBuilder().setSourceImage(sourceImage).setDiskSizeGb(diskSizeGb).setDiskType(diskType).build()).build();returndisk;}/**   * Send an instance creation request to the Compute Engine API and wait for it to complete.   *   * @param project project ID or project number of the Cloud project you want to use.   * @param zone name of the zone to create the instance in. For example: "us-west3-b"   * @param instanceName name of the new virtual machine (VM) instance.   * @param disks a list of compute_v1.AttachedDisk objects describing the disks you want to attach   * to your new instance.   * @param machineType machine type of the VM being created. This value uses the following format:   * "zones/{zone}/machineTypes/{type_name}".   * For example: "zones/europe-west3-c/machineTypes/f1-micro"   * @param network name of the network you want the new instance to use. For example:   * "global/networks/default" represents the network named "default", which is created   * automatically for each project.   * @param subnetwork name of the subnetwork you want the new instance to use. This value uses the   * following format: "regions/{region}/subnetworks/{subnetwork_name}"   * @return Instance object.   */privatestaticInstancecreateWithDisks(Stringproject,Stringzone,StringinstanceName,Vector<AttachedDisk>disks,StringmachineType,Stringnetwork,Stringsubnetwork)throwsIOException,InterruptedException,ExecutionException,TimeoutException{try(InstancesClientinstancesClient=InstancesClient.create()){// Use the network interface provided in the networkName argument.NetworkInterfacenetworkInterface;if(subnetwork!=null){networkInterface=NetworkInterface.newBuilder().setName(network).setSubnetwork(subnetwork).build();}else{networkInterface=NetworkInterface.newBuilder().setName(network).build();}machineType=String.format("zones/%s/machineTypes/%s",zone,machineType);// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.InstanceinstanceResource=Instance.newBuilder().setName(instanceName).setMachineType(machineType).addAllDisks(disks).addNetworkInterfaces(networkInterface).build();System.out.printf("Creating instance: %s at %s ",instanceName,zone);// Insert the instance in the specified project and zone.InsertInstanceRequestinsertInstanceRequest=InsertInstanceRequest.newBuilder().setProject(project).setZone(zone).setInstanceResource(instanceResource).build();OperationFuture<Operation,Operation>operation=instancesClient.insertAsync(insertInstanceRequest);// Wait for the operation to complete.Operationresponse=operation.get(3,TimeUnit.MINUTES);if(response.hasError()){System.out.println("Instance creation failed ! ! "+response);returnnull;}System.out.println("Operation Status: "+response.getStatus());returninstancesClient.get(project,zone,instanceName);}}

Node.js

Before trying this sample, follow theNode.js setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EngineNode.js API reference documentation.

To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.

/** * TODO(developer): Uncomment and replace these variables before running the sample. */// const projectId = 'YOUR_PROJECT_ID';// const zone = 'europe-central2-b';// const instanceName = 'YOUR_INSTANCE_NAME';// const networkLink = 'global/networks/default';// const subnetworkLink = 'regions/europe-central2/subnetworks/default';constcompute=require('@google-cloud/compute');// Creates a new VM instance with Debian 10 operating system in specified network and subnetwork.asyncfunctioncreateInstanceWithSubnet(){constinstancesClient=newcompute.InstancesClient();constimagesClient=newcompute.ImagesClient();// List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details.const[newestDebian]=awaitimagesClient.getFromFamily({project:'debian-cloud',family:'debian-11',});const[response]=awaitinstancesClient.insert({project:projectId,zone,instanceResource:{name:instanceName,disks:[{initializeParams:{diskSizeGb:'10',sourceImage:newestDebian.selfLink,diskType:`zones/${zone}/diskTypes/pd-standard`,},autoDelete:true,boot:true,type:'PERSISTENT',},],machineType:`zones/${zone}/machineTypes/n1-standard-1`,networkInterfaces:[{name:networkLink,subnetwork:subnetworkLink,},],},});letoperation=response.latestResponse;constoperationsClient=newcompute.ZoneOperationsClient();// Wait for the create operation to complete.while(operation.status!=='DONE'){[operation]=awaitoperationsClient.wait({operation:operation.name,project:projectId,zone:operation.zone.split('/').pop(),});}console.log('Instance created.');}createInstanceWithSubnet();

Python

Before trying this sample, follow thePython setup instructions in theCompute Engine quickstart using client libraries. For more information, see theCompute EnginePython API reference documentation.

To authenticate to Compute Engine, set up Application Default Credentials. For more information, seeSet up authentication for a local development environment.

from__future__importannotationsimportreimportsysfromtypingimportAnyimportwarningsfromgoogle.api_core.extended_operationimportExtendedOperationfromgoogle.cloudimportcompute_v1defget_image_from_family(project:str,family:str)->compute_v1.Image:"""    Retrieve the newest image that is part of a given family in a project.    Args:        project: project ID or project number of the Cloud project you want to get image from.        family: name of the image family you want to get image from.    Returns:        An Image object.    """image_client=compute_v1.ImagesClient()# List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-detailsnewest_image=image_client.get_from_family(project=project,family=family)returnnewest_imagedefdisk_from_image(disk_type:str,disk_size_gb:int,boot:bool,source_image:str,auto_delete:bool=True,)->compute_v1.AttachedDisk:"""    Create an AttachedDisk object to be used in VM instance creation. Uses an image as the    source for the new disk.    Args:         disk_type: the type of disk you want to create. This value uses the following format:            "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)".            For example: "zones/us-west3-b/diskTypes/pd-ssd"        disk_size_gb: size of the new disk in gigabytes        boot: boolean flag indicating whether this disk should be used as a boot disk of an instance        source_image: source image to use when creating this disk. You must have read access to this disk. This can be one            of the publicly available images or an image from one of your projects.            This value uses the following format: "projects/{project_name}/global/images/{image_name}"        auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it    Returns:        AttachedDisk object configured to be created using the specified image.    """boot_disk=compute_v1.AttachedDisk()initialize_params=compute_v1.AttachedDiskInitializeParams()initialize_params.source_image=source_imageinitialize_params.disk_size_gb=disk_size_gbinitialize_params.disk_type=disk_typeboot_disk.initialize_params=initialize_params# Remember to set auto_delete to True if you want the disk to be deleted when you delete# your VM instance.boot_disk.auto_delete=auto_deleteboot_disk.boot=bootreturnboot_diskdefwait_for_extended_operation(operation:ExtendedOperation,verbose_name:str="operation",timeout:int=300)->Any:"""    Waits for the extended (long-running) operation to complete.    If the operation is successful, it will return its result.    If the operation ends with an error, an exception will be raised.    If there were any warnings during the execution of the operation    they will be printed to sys.stderr.    Args:        operation: a long-running operation you want to wait on.        verbose_name: (optional) a more verbose name of the operation,            used only during error and warning reporting.        timeout: how long (in seconds) to wait for operation to finish.            If None, wait indefinitely.    Returns:        Whatever the operation.result() returns.    Raises:        This method will raise the exception received from `operation.exception()`        or RuntimeError if there is no exception set, but there is an `error_code`        set for the `operation`.        In case of an operation taking longer than `timeout` seconds to complete,        a `concurrent.futures.TimeoutError` will be raised.    """result=operation.result(timeout=timeout)ifoperation.error_code:print(f"Error during{verbose_name}: [Code:{operation.error_code}]:{operation.error_message}",file=sys.stderr,flush=True,)print(f"Operation ID:{operation.name}",file=sys.stderr,flush=True)raiseoperation.exception()orRuntimeError(operation.error_message)ifoperation.warnings:print(f"Warnings during{verbose_name}:\n",file=sys.stderr,flush=True)forwarninginoperation.warnings:print(f" -{warning.code}:{warning.message}",file=sys.stderr,flush=True)returnresultdefcreate_instance(project_id:str,zone:str,instance_name:str,disks:list[compute_v1.AttachedDisk],machine_type:str="n1-standard-1",network_link:str="global/networks/default",subnetwork_link:str=None,internal_ip:str=None,external_access:bool=False,external_ipv4:str=None,accelerators:list[compute_v1.AcceleratorConfig]=None,preemptible:bool=False,spot:bool=False,instance_termination_action:str="STOP",custom_hostname:str=None,delete_protection:bool=False,)->compute_v1.Instance:"""    Send an instance creation request to the Compute Engine API and wait for it to complete.    Args:        project_id: project ID or project number of the Cloud project you want to use.        zone: name of the zone to create the instance in. For example: "us-west3-b"        instance_name: name of the new virtual machine (VM) instance.        disks: a list of compute_v1.AttachedDisk objects describing the disks            you want to attach to your new instance.        machine_type: machine type of the VM being created. This value uses the            following format: "zones/{zone}/machineTypes/{type_name}".            For example: "zones/europe-west3-c/machineTypes/f1-micro"        network_link: name of the network you want the new instance to use.            For example: "global/networks/default" represents the network            named "default", which is created automatically for each project.        subnetwork_link: name of the subnetwork you want the new instance to use.            This value uses the following format:            "regions/{region}/subnetworks/{subnetwork_name}"        internal_ip: internal IP address you want to assign to the new instance.            By default, a free address from the pool of available internal IP addresses of            used subnet will be used.        external_access: boolean flag indicating if the instance should have an external IPv4            address assigned.        external_ipv4: external IPv4 address to be assigned to this instance. If you specify            an external IP address, it must live in the same region as the zone of the instance.            This setting requires `external_access` to be set to True to work.        accelerators: a list of AcceleratorConfig objects describing the accelerators that will            be attached to the new instance.        preemptible: boolean value indicating if the new instance should be preemptible            or not. Preemptible VMs have been deprecated and you should now use Spot VMs.        spot: boolean value indicating if the new instance should be a Spot VM or not.        instance_termination_action: What action should be taken once a Spot VM is terminated.            Possible values: "STOP", "DELETE"        custom_hostname: Custom hostname of the new VM instance.            Custom hostnames must conform to RFC 1035 requirements for valid hostnames.        delete_protection: boolean value indicating if the new virtual machine should be            protected against deletion or not.    Returns:        Instance object.    """instance_client=compute_v1.InstancesClient()# Use the network interface provided in the network_link argument.network_interface=compute_v1.NetworkInterface()network_interface.network=network_linkifsubnetwork_link:network_interface.subnetwork=subnetwork_linkifinternal_ip:network_interface.network_i_p=internal_ipifexternal_access:access=compute_v1.AccessConfig()access.type_=compute_v1.AccessConfig.Type.ONE_TO_ONE_NAT.nameaccess.name="External NAT"access.network_tier=access.NetworkTier.PREMIUM.nameifexternal_ipv4:access.nat_i_p=external_ipv4network_interface.access_configs=[access]# Collect information into the Instance object.instance=compute_v1.Instance()instance.network_interfaces=[network_interface]instance.name=instance_nameinstance.disks=disksifre.match(r"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$",machine_type):instance.machine_type=machine_typeelse:instance.machine_type=f"zones/{zone}/machineTypes/{machine_type}"instance.scheduling=compute_v1.Scheduling()ifaccelerators:instance.guest_accelerators=acceleratorsinstance.scheduling.on_host_maintenance=(compute_v1.Scheduling.OnHostMaintenance.TERMINATE.name)ifpreemptible:# Set the preemptible settingwarnings.warn("Preemptible VMs are being replaced by Spot VMs.",DeprecationWarning)instance.scheduling=compute_v1.Scheduling()instance.scheduling.preemptible=Trueifspot:# Set the Spot VM settinginstance.scheduling.provisioning_model=(compute_v1.Scheduling.ProvisioningModel.SPOT.name)instance.scheduling.instance_termination_action=instance_termination_actionifcustom_hostnameisnotNone:# Set the custom hostname for the instanceinstance.hostname=custom_hostnameifdelete_protection:# Set the delete protection bitinstance.deletion_protection=True# Prepare the request to insert an instance.request=compute_v1.InsertInstanceRequest()request.zone=zonerequest.project=project_idrequest.instance_resource=instance# Wait for the create operation to complete.print(f"Creating the{instance_name} instance in{zone}...")operation=instance_client.insert(request=request)wait_for_extended_operation(operation,"instance creation")print(f"Instance{instance_name} created.")returninstance_client.get(project=project_id,zone=zone,instance=instance_name)defcreate_with_subnet(project_id:str,zone:str,instance_name:str,network_link:str,subnet_link:str)->compute_v1.Instance:"""    Create a new VM instance with Debian 10 operating system in specified network and subnetwork.    Args:        project_id: project ID or project number of the Cloud project you want to use.        zone: name of the zone to create the instance in. For example: "us-west3-b"        instance_name: name of the new virtual machine (VM) instance.        network_link: name of the network you want the new instance to use.            For example: "global/networks/default" represents the network            named "default", which is created automatically for each project.        subnetwork_link: name of the subnetwork you want the new instance to use.            This value uses the following format:            "regions/{region}/subnetworks/{subnetwork_name}"    Returns:        Instance object.    """newest_debian=get_image_from_family(project="debian-cloud",family="debian-12")disk_type=f"zones/{zone}/diskTypes/pd-standard"disks=[disk_from_image(disk_type,10,True,newest_debian.self_link)]instance=create_instance(project_id,zone,instance_name,disks,network_link=network_link,subnetwork_link=subnet_link,)returninstance

REST

Follow theREST instructions tocreate an instance from a public imageor asnapshot, but specify thesubnet field in the request body.

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances{   "machineType":"zones/MACHINE_TYPE_ZONE/machineTypes/MACHINE_TYPE",   "name":"VM_NAME",      "disks":[      {         "initializeParams":{            "sourceImage":"projects/IMAGE_PROJECT/global/images/IMAGE"         },         "boot":true      }   ],         "networkInterfaces":[      {         "network":"global/networks/NETWORK_NAME",         "subnetwork":"regions/REGION/subnetworks/SUBNET_NAME",         "stackType":"STACK_TYPE"      }   ],        "shieldedInstanceConfig":{      "enableSecureBoot":"ENABLE_SECURE_BOOT"   }}

Replace the following:

  • PROJECT_ID: ID of the project to create the VM in
  • ZONE: zone to create the VM in
  • MACHINE_TYPE_ZONE: zone containing the machine type to use for the new VM
  • MACHINE_TYPE: machine type,predefined orcustom, for the new VM
  • VM_NAME:name of the new VM
  • IMAGE_PROJECT:project containing the image
    For example, if you specifydebian-10 as the image family, specifydebian-cloud as the image project.
  • IMAGE: specify one of the following:

    • IMAGE: a specific version of a public image

      For example,"sourceImage": "projects/debian-cloud/global/images/debian-10-buster-v20200309"

    • IMAGE_FAMILY: animage family

      This creates the VM from the most recent, non-deprecated OS image. For example, if you specify"sourceImage": "projects/debian-cloud/global/images/family/debian-10", Compute Engine creates a VM from the latest version of the OS image in theDebian 10 image family.

  • NETWORK_NAME: Optional: the VPC network that you want to use for the VM. You can specifydefault to use your default network.
  • REGION: region where the specified subnet exists. This must be the same region as the VM.
  • SUBNET_NAME: name of the subnet to use
  • STACK_TYPE: Optional: the stack type for the network interface. You can specify one ofIPV4_ONLY,IPV4_IPV6, orIPV6_ONLY. The default value isIPV4_ONLY.

  • ENABLE_SECURE_BOOT: Optional: If you chose an image that supportsShielded VM features, Compute Engine, by default, enables thevirtual trusted platform module (vTPM) andintegrity monitoring. Compute Engine does not enableSecure Boot by default.

    If you specifytrue forenableSecureBoot, Compute Engine creates a VM with all three Shielded VM features enabled. After Compute Engine starts your VM, tomodify Shielded VM options, you must stop the VM.

Note: A network interface can have only one IPv6 address, either internal orexternal, but not both.

What's next?

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-12-15 UTC.