Create a VM instance in the specified project and zone.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
C#
Before trying this sample, follow the C# setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine C# 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 .
using
Google.Cloud.Compute.V1
;
using
System.Threading.Tasks
;
public
class
CreateInstanceAsyncSample
{
public
async
Task
CreateInstanceAsync
(
// TODO(developer): Set your own default values for these parameters or pass different values when calling this method.
string
projectId
=
"your-project-id"
,
string
zone
=
"us-central1-a"
,
string
machineName
=
"test-machine"
,
string
machineType
=
"n1-standard-1"
,
string
diskImage
=
"projects/debian-cloud/global/images/family/debian-12"
,
long
diskSizeGb
=
10
,
string
networkName
=
"default"
)
{
Instance
instance
=
new
Instance
{
Name
=
machineName
,
// See https://cloud.google.com/compute/docs/machine-types for more information on machine types.
MachineType
=
$"zones/{zone}/machineTypes/{machineType}"
,
// Instance creation requires at least one persistent disk.
Disks
=
{
new
AttachedDisk
{
AutoDelete
=
true
,
Boot
=
true
,
Type
=
ComputeEnumConstants
.
AttachedDisk
.
Type
.
Persistent
,
InitializeParams
=
new
AttachedDiskInitializeParams
{
// See https://cloud.google.com/compute/docs/images for more information on available images.
SourceImage
=
diskImage
,
DiskSizeGb
=
diskSizeGb
}
}
},
NetworkInterfaces
=
{
new
NetworkInterface
{
Name
=
networkName
}
}
};
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests.
InstancesClient
client
=
await
InstancesClient
.
CreateAsync
();
// Insert the instance in the specified project and zone.
var
instanceCreation
=
await
client
.
InsertAsync
(
projectId
,
zone
,
instance
);
// Wait for the operation to complete using client-side polling.
// The server-side operation is not affected by polling,
// and might finish successfully even if polling times out.
await
instanceCreation
.
PollUntilCompletedAsync
();
}
}
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"
)
// createInstance sends an instance creation request to the Compute Engine API and waits for it to complete.
func
createInstance
(
w
io
.
Writer
,
projectID
,
zone
,
instanceName
,
machineType
,
sourceImage
,
networkName
string
)
error
{
// projectID := "your_project_id"
// zone := "europe-central2-b"
// instanceName := "your_instance_name"
// machineType := "n1-standard-1"
// sourceImage := "projects/debian-cloud/global/images/family/debian-12"
// networkName := "global/networks/default"
ctx
:=
context
.
Background
()
instancesClient
,
err
:=
compute
.
NewInstancesRESTClient
(
ctx
)
if
err
!=
nil
{
return
fmt
.
Errorf
(
"NewInstancesRESTClient: %w"
,
err
)
}
defer
instancesClient
.
Close
()
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
:
proto
.
String
(
sourceImage
),
},
AutoDelete
:
proto
.
Bool
(
true
),
Boot
:
proto
.
Bool
(
true
),
Type
:
proto
.
String
(
computepb
.
AttachedDisk_PERSISTENT
.
String
()),
},
},
MachineType
:
proto
.
String
(
fmt
.
Sprintf
(
"zones/%s/machineTypes/%s"
,
zone
,
machineType
)),
NetworkInterfaces
:
[]
*
computepb
.
NetworkInterface
{
{
Name
:
proto
.
String
(
networkName
),
},
},
},
}
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. 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.concurrent.ExecutionException
;
import
java.util.concurrent.TimeUnit
;
import
java.util.concurrent.TimeoutException
;
public
class
CreateInstance
{
public
static
void
main
(
String
[]
args
)
throws
IOException
,
InterruptedException
,
ExecutionException
,
TimeoutException
{
// TODO(developer): Replace these variables before running the sample.
String
project
=
"your-project-id"
;
String
zone
=
"zone-name"
;
String
instanceName
=
"instance-name"
;
createInstance
(
project
,
zone
,
instanceName
);
}
// Create a new instance with the provided "instanceName" value in the specified project and zone.
public
static
void
createInstance
(
String
project
,
String
zone
,
String
instanceName
)
throws
IOException
,
InterruptedException
,
ExecutionException
,
TimeoutException
{
// Below are sample values that can be replaced.
// machineType: machine type of the VM being created.
// * This value uses the format zones/{zone}/machineTypes/{type_name}.
// * For a list of machine types, see https://cloud.google.com/compute/docs/machine-types
// sourceImage: path to the operating system image to mount.
// * For details about images you can mount, see https://cloud.google.com/compute/docs/images
// diskSizeGb: storage size of the boot disk to attach to the instance.
// networkName: network interface to associate with the instance.
String
machineType
=
String
.
format
(
"zones/%s/machineTypes/n1-standard-1"
,
zone
);
String
sourceImage
=
String
.
format
(
"projects/debian-cloud/global/images/family/%s"
,
"debian-11"
);
long
diskSizeGb
=
10L
;
String
networkName
=
"default"
;
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the `instancesClient.close()` method on the client to safely
// clean up any remaining background resources.
try
(
InstancesClient
instancesClient
=
InstancesClient
.
create
())
{
// Instance creation requires at least one persistent disk and one network interface.
AttachedDisk
disk
=
AttachedDisk
.
newBuilder
()
.
setBoot
(
true
)
.
setAutoDelete
(
true
)
.
setType
(
Type
.
PERSISTENT
.
toString
())
.
setDeviceName
(
"disk-1"
)
.
setInitializeParams
(
AttachedDiskInitializeParams
.
newBuilder
()
.
setSourceImage
(
sourceImage
)
.
setDiskSizeGb
(
diskSizeGb
)
.
build
())
.
build
();
// Use the network interface provided in the networkName argument.
NetworkInterface
networkInterface
=
NetworkInterface
.
newBuilder
()
.
setName
(
networkName
)
.
build
();
// Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance.
Instance
instanceResource
=
Instance
.
newBuilder
()
.
setName
(
instanceName
)
.
setMachineType
(
machineType
)
.
addDisks
(
disk
)
.
addNetworkInterfaces
(
networkInterface
)
.
build
();
System
.
out
.
printf
(
"Creating instance: %s at %s %n"
,
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
;
}
System
.
out
.
println
(
"Operation Status: "
+
response
.
getStatus
());
}
}
}
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 machineType = 'n1-standard-1';
// const sourceImage = 'projects/debian-cloud/global/images/family/debian-11';
// const networkName = 'global/networks/default';
const
compute
=
require
(
' @google-cloud/compute
'
);
// Create a new instance with the values provided above in the specified project and zone.
async
function
createInstance
()
{
const
instancesClient
=
new
compute
.
InstancesClient
();
console
.
log
(
`Creating the
${
instanceName
}
instance in
${
zone
}
...`
);
const
[
response
]
=
await
instancesClient
.
insert
({
instanceResource
:
{
name
:
instanceName
,
disks
:
[
{
// Describe the size and source image of the boot disk to attach to the instance.
initializeParams
:
{
diskSizeGb
:
'10'
,
sourceImage
,
},
autoDelete
:
true
,
boot
:
true
,
type
:
'PERSISTENT'
,
},
],
machineType
:
`zones/
${
zone
}
/machineTypes/
${
machineType
}
`
,
networkInterfaces
:
[
{
// Use the network interface provided in the networkName argument.
name
:
networkName
,
},
],
},
project
:
projectId
,
zone
,
});
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.'
);
}
createInstance
();
PHP
Before trying this sample, follow the PHP setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine PHP 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 .
use Google\Cloud\Compute\V1\AttachedDisk;
use Google\Cloud\Compute\V1\AttachedDiskInitializeParams;
use Google\Cloud\Compute\V1\Client\InstancesClient;
use Google\Cloud\Compute\V1\Enums\AttachedDisk\Type;
use Google\Cloud\Compute\V1\InsertInstanceRequest;
/**
* To correctly handle string enums in Cloud Compute library
* use constants defined in the Enums subfolder.
*/
use Google\Cloud\Compute\V1\Instance;
use Google\Cloud\Compute\V1\NetworkInterface;
/**
* Creates an instance in the specified project and zone.
*
* @param string $projectId Project ID of the Cloud project to create the instance in.
* @param string $zone Zone to create the instance in (like "us-central1-a").
* @param string $instanceName Unique name for this Compute Engine instance.
* @param string $machineType Machine type of the instance being created.
* @param string $sourceImage Boot disk image name or family.
* @param string $networkName Network interface to associate with the instance.
*
* @throws \Google\ApiCore\ApiException if the remote call fails.
* @throws \Google\ApiCore\ValidationException if local error occurs before remote call.
*/
function create_instance(
string $projectId,
string $zone,
string $instanceName,
string $machineType = 'n1-standard-1',
string $sourceImage = 'projects/debian-cloud/global/images/family/debian-11',
string $networkName = 'global/networks/default'
) {
// Set the machine type using the specified zone.
$machineTypeFullName = sprintf('zones/%s/machineTypes/%s', $zone, $machineType);
// Describe the source image of the boot disk to attach to the instance.
$diskInitializeParams = (new AttachedDiskInitializeParams())
->setSourceImage($sourceImage);
$disk = (new AttachedDisk())
->setBoot(true)
->setAutoDelete(true)
->setType(Type::PERSISTENT)
->setInitializeParams($diskInitializeParams);
// Use the network interface provided in the $networkName argument.
$network = (new NetworkInterface())
->setName($networkName);
// Create the Instance object.
$instance = (new Instance())
->setName($instanceName)
->setDisks([$disk])
->setMachineType($machineTypeFullName)
->setNetworkInterfaces([$network]);
// Insert the new Compute Engine instance using InstancesClient.
$instancesClient = new InstancesClient();
$request = (new InsertInstanceRequest())
->setInstanceResource($instance)
->setProject($projectId)
->setZone($zone);
$operation = $instancesClient->insert($request);
// Wait for the operation to complete.
$operation->pollUntilComplete();
if ($operation->operationSucceeded()) {
printf('Created instance %s' . PHP_EOL, $instanceName);
} else {
$error = $operation->getError();
printf('Instance creation failed: %s' . PHP_EOL, $error?->getMessage());
}
}
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
)
Ruby
Before trying this sample, follow the Ruby setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Ruby 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 .
require
"google/cloud/compute/v1"
# Sends an instance creation request to the Compute Engine API and waits for it to complete.
#
# @param [String] project project ID or project number of the Cloud project you want to use.
# @param [String] zone name of the zone you want to use. For example: "us-west3-b"
# @param [String] instance_name name of the new virtual machine.
# @param [String] machine_type machine type of the VM being created. For example: "e2-standard-2"
# See https://cloud.google.com/compute/docs/machine-types for more information
# on machine types.
# @param [String] source_image path to the operating system image to mount on your boot
# disk. This can be one of the public images
# (like "projects/debian-cloud/global/images/family/debian-11")
# or a private image you have access to.
# See https://cloud.google.com/compute/docs/images for more information on available images.
# @param [String] network_name name of the network you want the new instance to use.
# For example: "global/networks/default" represents the `default`
# network interface, which is created automatically for each project.
def
create_instance
project
:,
zone
:,
instance_name
:,
machine_type
:
"n2-standard-2"
,
source_image
:
"projects/debian-cloud/global/images/family/debian-11"
,
network_name
:
"global/networks/default"
# Initialize client that will be used to send requests. This client only needs to be created
# once, and can be reused for multiple requests.
client
=
::
Google
::
Cloud
::
Compute
::
V1
::
Instances
::
Rest
::
Client
.
new
# Construct the instance object.
# It can be either a hash or ::Google::Cloud::Compute::V1::Instance instance.
instance
=
{
name
:
instance_name
,
machine_type
:
"zones/
#{
zone
}
/machineTypes/
#{
machine_type
}
"
,
# Instance creation requires at least one persistent disk.
disks
:
[
{
auto_delete
:
true
,
boot
:
true
,
type
:
:PERSISTENT
,
initialize_params
:
{
source_image
:
source_image
,
disk_size_gb
:
10
}
}
]
,
network_interfaces
:
[
{
name
:
network_name
}
]
}
# Prepare a request to create the instance in the specified project and zone.
request
=
{
project
:
project
,
zone
:
zone
,
instance_resource
:
instance
}
puts
"Creating the
#{
instance_name
}
instance in
#{
zone
}
..."
begin
# Send the insert request.
operation
=
client
.
insert
request
# Wait for the create operation to complete.
operation
=
wait_until_done
operation
:
operation
if
operation
.
error?
warn
"Error during creation:"
,
operation
.
error
else
compute_operation
=
operation
.
operation
warn
"Warning during creation:"
,
compute_operation
.
warnings
unless
compute_operation
.
warnings
.
empty?
puts
"Instance
#{
instance_name
}
created."
end
rescue
::
Google
::
Cloud
::
Error
=
>
e
warn
"Exception during creation:"
,
e
end
end
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 instance from a public image
# in the `default` VPC network and subnet
resource
"google_compute_instance"
"default"
{
name
=
"my-vm"
machine_type
=
"n1-standard-1"
zone
=
"us-central1-a"
boot_disk
{
initialize_params
{
image
=
"ubuntu-minimal-2210-kinetic-amd64-v20230126"
}
}
network_interface
{
network
=
"default"
access_config
{}
}
}
What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .
