Create a VM in a custom VPC network and a specific subnet.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Go
Before trying this sample, follow the Go setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Go API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set 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.
func
createInstanceWithSubnet
(
w
io
.
Writer
,
projectID
,
zone
,
instanceName
,
networkLink
,
subnetworkLink
string
)
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
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewInstancesRESTClient: %w"
,
err
)
}
defer
instancesClient
.
Close
()
imagesClient
,
err
:=
compute
.
NewImagesRESTClient
(
ctx
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewImagesRESTClient: %w"
,
err
)
}
defer
imagesClient
.
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
)
if
err
!=
nil
{
return
fmt
.
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
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to create instance: %w"
,
err
)
}
if
err
=
op
.
Wait
(
ctx
);
err
!=
nil
{
return
fmt
.
Errorf
(
"unable to wait for the operation: %w"
,
err
)
}
fmt
.
Fprintf
(
w
,
"Instance created\n"
)
return
nil
}
Java
Before trying this sample, follow the Java setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Java API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
com.google.api.gax.longrunning. OperationFuture
;
import
com.google.cloud.compute.v1. AttachedDisk
;
import
com.google.cloud.compute.v1. AttachedDisk
.Type
;
import
com.google.cloud.compute.v1. AttachedDiskInitializeParams
;
import
com.google.cloud.compute.v1. Image
;
import
com.google.cloud.compute.v1. ImagesClient
;
import
com.google.cloud.compute.v1. InsertInstanceRequest
;
import
com.google.cloud.compute.v1. Instance
;
import
com.google.cloud.compute.v1. InstancesClient
;
import
com.google.cloud.compute.v1. NetworkInterface
;
import
com.google.cloud.compute.v1. Operation
;
import
java.io.IOException
;
import
java.util.Vector
;
import
java.util.concurrent.ExecutionException
;
import
java.util.concurrent.TimeUnit
;
import
java.util.concurrent.TimeoutException
;
public
class
CreateInstancesAdvanced
{
/**
* 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.
*/
private
static
AttachedDisk
diskFromImage
(
String
diskType
,
int
diskSizeGb
,
boolean
boot
,
String
sourceImage
)
{
AttachedDisk
disk
=
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
();
return
disk
;
}
/**
* 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.
*/
private
static
Instance
createWithDisks
(
String
project
,
String
zone
,
String
instanceName
,
Vector<AttachedDisk>
disks
,
String
machineType
,
String
network
,
String
subnetwork
)
throws
IOException
,
InterruptedException
,
ExecutionException
,
TimeoutException
{
try
(
InstancesClient
instancesClient
=
InstancesClient
.
create
())
{
// Use the network interface provided in the networkName argument.
NetworkInterface
networkInterface
;
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.
Instance
instanceResource
=
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.
InsertInstanceRequest
insertInstanceRequest
=
InsertInstanceRequest
.
newBuilder
()
.
setProject
(
project
)
.
setZone
(
zone
)
.
setInstanceResource
(
instanceResource
).
build
();
OperationFuture<Operation
,
Operation
>
operation
=
instancesClient
.
insertAsync
(
insertInstanceRequest
);
// Wait for the operation to complete.
Operation
response
=
operation
.
get
(
3
,
TimeUnit
.
MINUTES
);
if
(
response
.
hasError
())
{
System
.
out
.
println
(
"Instance creation failed ! ! "
+
response
);
return
null
;
}
System
.
out
.
println
(
"Operation Status: "
+
response
.
getStatus
());
return
instancesClient
.
get
(
project
,
zone
,
instanceName
);
}
}
Node.js
Before trying this sample, follow the Node.js setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Node.js API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set 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';
const
compute
=
require
(
' @google-cloud/compute
'
);
// Creates a new VM instance with Debian 10 operating system in specified network and subnetwork.
async
function
createInstanceWithSubnet
()
{
const
instancesClient
=
new
compute
.
InstancesClient
();
const
imagesClient
=
new
compute
.
ImagesClient
();
// List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details.
const
[
newestDebian
]
=
await
imagesClient
.
getFromFamily
({
project
:
'debian-cloud'
,
family
:
'debian-11'
,
});
const
[
response
]
=
await
instancesClient
.
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
,
},
],
},
});
let
operation
=
response
.
latestResponse
;
const
operationsClient
=
new
compute
.
ZoneOperationsClient
();
// Wait for the create operation to complete.
while
(
operation
.
status
!==
'DONE'
)
{
[
operation
]
=
await
operationsClient
.
wait
({
operation
:
operation
.
name
,
project
:
projectId
,
zone
:
operation
.
zone
.
split
(
'/'
).
pop
(),
});
}
console
.
log
(
'Instance created.'
);
}
createInstanceWithSubnet
();
Python
Before trying this sample, follow the Python setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Python API reference documentation .
To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
from
__future__
import
annotations
import
re
import
sys
from
typing
import
Any
import
warnings
from
google.api_core.extended_operation
import
ExtendedOperation
from
google.cloud
import
compute_v1
def
get_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-details
newest_image
=
image_client
.
get_from_family
(
project
=
project
,
family
=
family
)
return
newest_image
def
disk_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_image
initialize_params
.
disk_size_gb
=
disk_size_gb
initialize_params
.
disk_type
=
disk_type
boot_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_delete
boot_disk
.
boot
=
boot
return
boot_disk
def
wait_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
)
if
operation
.
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
)
raise
operation
.
exception
()
or
RuntimeError
(
operation
.
error_message
)
if
operation
.
warnings
:
print
(
f
"Warnings during
{
verbose_name
}
:
\n
"
,
file
=
sys
.
stderr
,
flush
=
True
)
for
warning
in
operation
.
warnings
:
print
(
f
" -
{
warning
.
code
}
:
{
warning
.
message
}
"
,
file
=
sys
.
stderr
,
flush
=
True
)
return
result
def
create_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_link
if
subnetwork_link
:
network_interface
.
subnetwork
=
subnetwork_link
if
internal_ip
:
network_interface
.
network_i_p
=
internal_ip
if
external_access
:
access
=
compute_v1
.
AccessConfig
()
access
.
type_
=
compute_v1
.
AccessConfig
.
Type
.
ONE_TO_ONE_NAT
.
name
access
.
name
=
"External NAT"
access
.
network_tier
=
access
.
NetworkTier
.
PREMIUM
.
name
if
external_ipv4
:
access
.
nat_i_p
=
external_ipv4
network_interface
.
access_configs
=
[
access
]
# Collect information into the Instance object.
instance
=
compute_v1
.
Instance
()
instance
.
network_interfaces
=
[
network_interface
]
instance
.
name
=
instance_name
instance
.
disks
=
disks
if
re
.
match
(
r
"^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$"
,
machine_type
):
instance
.
machine_type
=
machine_type
else
:
instance
.
machine_type
=
f
"zones/
{
zone
}
/machineTypes/
{
machine_type
}
"
instance
.
scheduling
=
compute_v1
.
Scheduling
()
if
accelerators
:
instance
.
guest_accelerators
=
accelerators
instance
.
scheduling
.
on_host_maintenance
=
(
compute_v1
.
Scheduling
.
OnHostMaintenance
.
TERMINATE
.
name
)
if
preemptible
:
# Set the preemptible setting
warnings
.
warn
(
"Preemptible VMs are being replaced by Spot VMs."
,
DeprecationWarning
)
instance
.
scheduling
=
compute_v1
.
Scheduling
()
instance
.
scheduling
.
preemptible
=
True
if
spot
:
# Set the Spot VM setting
instance
.
scheduling
.
provisioning_model
=
(
compute_v1
.
Scheduling
.
ProvisioningModel
.
SPOT
.
name
)
instance
.
scheduling
.
instance_termination_action
=
instance_termination_action
if
custom_hostname
is
not
None
:
# Set the custom hostname for the instance
instance
.
hostname
=
custom_hostname
if
delete_protection
:
# Set the delete protection bit
instance
.
deletion_protection
=
True
# Prepare the request to insert an instance.
request
=
compute_v1
.
InsertInstanceRequest
()
request
.
zone
=
zone
request
.
project
=
project_id
request
.
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."
)
return
instance_client
.
get
(
project
=
project_id
,
zone
=
zone
,
instance
=
instance_name
)
def
create_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
,
)
return
instance
Terraform
To learn how to apply or remove a Terraform configuration, see Basic Terraform commands . For more information, see the Terraform provider reference documentation .
# Create a VM in a custom VPC network and subnet
resource
"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"
}
}
}
What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .
