--- title: "POST /projects/{project}/global/machineImages" method: POST path: "/projects/{project}/global/machineImages" tags: ["machineImages"] --- # POST /projects/{project}/global/machineImages `POST /projects/{project}/global/machineImages` Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. ## Path parameters - `project` string, required ## Query parameters - `requestId` string - `sourceInstance` string ## Request body - MachineImage — Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, seeMachine images. - `selfLink` string — Output only. [Output Only] The URL for this machine image. The server defines this URL. - `totalStorageBytes` string, int64 — Output only. [Output Only] Total size of the storage used by the machine image. - `instanceProperties` InstanceProperties - `serviceAccounts` ServiceAccount[] — A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. - `email` string — Email address of the service account. - `scopes` string[] — The list of scopes to be made available for this service account. - `resourceManagerTags` object — Input only. Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when empty. - `keyRevocationActionType` 'KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED' | 'NONE' | 'STOP' — KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. - `resourcePolicies` string[] — Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. - `machineType` string — The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, the request will result in an `INTERNAL_ERROR`. - `guestAccelerators` AcceleratorConfig[] — A list of guest accelerator cards' type and count to use for instances created from these properties. - `acceleratorType` string — Full or partial URL of the accelerator type resource to attach to this instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. - `acceleratorCount` integer — The number of the guest accelerator cards exposed to this instance. - `reservationAffinity` ReservationAffinity — Specifies the reservations that this instance can consume from. - `consumeReservationType` 'ANY_RESERVATION' | 'NO_RESERVATION' | 'SPECIFIC_RESERVATION' | 'UNSPECIFIED' — Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. - `key` string — Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify the name of your reservation as its value. - `values` string[] — Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. - `metadata` Metadata — A metadata key/value entry. - `kind` string — Output only. [Output Only] Type of the resource. Always compute#metadata for metadata. - `fingerprint` string, byte — Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. - `items` object[] — Array of key/value pairs. The total size of all keys and values must be less than 512 KB. - `key` string — Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. - `value` string — Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). - `description` string — An optional text description for the instances that are created from these properties. - `scheduling` Scheduling — Sets the scheduling options for an Instance. - `locationHint` string — An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. - `skipGuestOsShutdown` boolean — Default is false and there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs. - `minNodeCpus` integer — The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. - `onHostMaintenance` 'MIGRATE' | 'TERMINATE' — Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. Forpreemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy. - `provisioningModel` 'FLEX_START' | 'RESERVATION_BOUND' | 'SPOT' | 'STANDARD' — Specifies the provisioning model of the instance. - `localSsdRecoveryTimeout` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `nanos` integer — Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - `seconds` string, int64 — Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - `maxRunDuration` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `nanos` integer — Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - `seconds` string, int64 — Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - `terminationTime` string — Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance termination action will be performed at the termination time. - `onInstanceStopAction` SchedulingOnInstanceStopAction — Defines the behaviour for instances with the instance_termination_actionSTOP. - `discardLocalSsd` boolean — If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. - `instanceTerminationAction` 'DELETE' | 'INSTANCE_TERMINATION_ACTION_UNSPECIFIED' | 'STOP' — Specifies the termination action for the instance. - `hostErrorTimeoutSeconds` integer — Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. - `automaticRestart` boolean — Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances.Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - `nodeAffinities` SchedulingNodeAffinity[] — A set of node affinity and anti-affinity configurations. Refer toConfiguring node affinity for more information. Overrides reservationAffinity. - `operator` 'IN' | 'NOT_IN' | 'OPERATOR_UNSPECIFIED' — Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity. - `key` string — Corresponds to the label key of Node resource. - `values` string[] — Corresponds to the label values of Node resource. - `preemptible` boolean — Defines whether the instance is preemptible. This can only be set during instance creation or while the instance isstopped and therefore, in a `TERMINATED` state. SeeInstance Life Cycle for more information on the possible instance states. - `availabilityDomain` integer — Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. - `labels` object — Labels to apply to instances that are created from these properties. - `shieldedInstanceConfig` ShieldedInstanceConfig — A set of Shielded Instance options. - `enableVtpm` boolean — Defines whether the instance has the vTPM enabled.Enabled by default. - `enableIntegrityMonitoring` boolean — Defines whether the instance has integrity monitoring enabled.Enabled by default. - `enableSecureBoot` boolean — Defines whether the instance has Secure Boot enabled.Disabled by default. - `workloadIdentityConfig` WorkloadIdentityConfig - `identity` string - `identityCertificateEnabled` boolean - `localSsdEncryptionMode` 'EPHEMERAL_KEY_ENCRYPTION' | 'LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED' | 'STANDARD_ENCRYPTION' — Specifies which method should be used for encrypting the Local SSDs attached to the VM. - `canIpForward` boolean — Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding documentation for more information. - `disks` AttachedDisk[] — An array of disks that are associated with the instances that are created from these properties. - `interface` 'NVME' | 'SCSI' — Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, seeAbout persistent disks. - `guestOsFeatures` GuestOsFeature[] — A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. - `type` 'BARE_METAL_LINUX_COMPATIBLE' | 'CCA_CAPABLE' | 'FEATURE_TYPE_UNSPECIFIED' | 'GVNIC' | 'IDPF' | 'MULTI_IP_SUBNET' | 'SECURE_BOOT' | 'SEV_CAPABLE' | 'SEV_LIVE_MIGRATABLE' | 'SEV_LIVE_MIGRATABLE_V2' | 'SEV_SNP_CAPABLE' | 'SNP_SVSM_CAPABLE' | 'TDX_CAPABLE' | 'UEFI_COMPATIBLE' | 'VIRTIO_SCSI_MULTIQUEUE' | 'WINDOWS' — The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE - CCA_CAPABLE For more information, see Enabling guest operating system features. - `initializeParams` AttachedDiskInitializeParams — [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. - `provisionedIops` string, int64 — Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see theExtreme persistent disk documentation. - `provisionedThroughput` string, int64 — Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1. - `sourceImageEncryptionKey` CustomerEncryptionKey - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 - `sha256` string — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. - `rawKey` string — Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - `kmsKeyServiceAccount` string — The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - `rsaEncryptedKey` string — Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - `licenses` string[] — A list of publicly visible licenses. Reserved for Google's use. - `resourceManagerTags` object — Input only. Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when empty. - `diskName` string — Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. - `sourceSnapshot` string — The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set. Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the bulk insert method. - `resourcePolicies` string[] — Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. - `onUpdateAction` 'RECREATE_DISK' | 'RECREATE_DISK_IF_SOURCE_CHANGED' | 'USE_EXISTING_DISK' — Specifies which action to take on instance update with this disk. Default is to use the existing disk. - `architecture` 'ARCHITECTURE_UNSPECIFIED' | 'ARM64' | 'X86_64' — The architecture of the attached disk. Valid values are arm64 or x86_64. - `diskType` string - `description` string — An optional description. Provide this property when creating the disk. - `sourceSnapshotEncryptionKey` CustomerEncryptionKey - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 - `sha256` string — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. - `rawKey` string — Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - `kmsKeyServiceAccount` string — The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - `rsaEncryptedKey` string — Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - `labels` object — Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for persistent disks. - `sourceImage` string — The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. - `diskSizeGb` string, int64 — Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. - `replicaZones` string[] — Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone. - `enableConfidentialCompute` boolean — Whether this disk is using confidential compute mode. - `storagePool` string — The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks. - `index` integer — Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. - `deviceName` string — Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. - `diskSizeGb` string, int64 — The size of the disk in GB. - `shieldedInstanceInitialState` InitialStateConfig — Initial State for shielded instance, these are public keys which are safe to store in public - `keks` FileContentBuffer[] — The Key Exchange Key (KEK). - `content` string, byte — The raw content in the secure keys file. - `fileType` 'BIN' | 'UNDEFINED' | 'X509' — The file type of source file. - `dbxs` FileContentBuffer[] — The forbidden key database (dbx). - `content` string, byte — The raw content in the secure keys file. - `fileType` 'BIN' | 'UNDEFINED' | 'X509' — The file type of source file. - `pk` FileContentBuffer - `content` string, byte — The raw content in the secure keys file. - `fileType` 'BIN' | 'UNDEFINED' | 'X509' — The file type of source file. - `dbs` FileContentBuffer[] — The Key Database (db). - `content` string, byte — The raw content in the secure keys file. - `fileType` 'BIN' | 'UNDEFINED' | 'X509' — The file type of source file. - `autoDelete` boolean — Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). - `mode` 'READ_ONLY' | 'READ_WRITE' — The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - `savedState` 'DISK_SAVED_STATE_UNSPECIFIED' | 'PRESERVED' — Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api. - `source` string — Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. - `architecture` 'ARCHITECTURE_UNSPECIFIED' | 'ARM64' | 'X86_64' — Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. - `type` 'PERSISTENT' | 'SCRATCH' — Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - `forceAttach` boolean — [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. - `diskEncryptionKey` CustomerEncryptionKey - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 - `sha256` string — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. - `rawKey` string — Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - `kmsKeyServiceAccount` string — The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - `rsaEncryptedKey` string — Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - `licenses` string[] — Output only. [Output Only] Any valid publicly visible licenses. - `boot` boolean — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. - `tags` Tags — A set of instance tags. - `fingerprint` string, byte — Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. - `items` string[] — An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. - `minCpuPlatform` string — Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such asminCpuPlatform: "Intel Haswell" orminCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. - `privateIpv6GoogleAccess` 'ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE' | 'ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE' | 'INHERIT_FROM_SUBNETWORK' — The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. - `advancedMachineFeatures` AdvancedMachineFeatures — Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or disabled). - `threadsPerCore` integer — The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. - `enableNestedVirtualization` boolean — Whether to enable nested virtualization or not (default is false). - `enableUefiNetworking` boolean — Whether to enable UEFI networking for instance creation. - `turboMode` string — Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. - `visibleCoreCount` integer — The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. - `performanceMonitoringUnit` 'ARCHITECTURAL' | 'ENHANCED' | 'PERFORMANCE_MONITORING_UNIT_UNSPECIFIED' | 'STANDARD' — Type of Performance Monitoring Unit requested on instance. - `networkInterfaces` NetworkInterface[] — An array of network access configurations for this interface. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces. - `internalIpv6PrefixLength` integer — The prefix length of the primary internal IPv6 range. - `parentNicName` string — Name of the parent network interface of a dynamic network interface. - `name` string — [Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and7. The default interface value is nic0. - `enableVpcScopedDns` boolean — Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. - `ipv6AccessType` 'EXTERNAL' | 'INTERNAL' — Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - `ipv6AccessConfigs` AccessConfig[] — An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. - `securityPolicy` string — The resource URL for the security policy associated with this access config. - `networkTier` 'FIXED_STANDARD' | 'PREMIUM' | 'STANDARD' | 'STANDARD_OVERRIDES_FIXED_STANDARD' — This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM,STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. - `externalIpv6` string — Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork. - `setPublicPtr` boolean — Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. - `externalIpv6PrefixLength` integer — Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs. - `type` 'DIRECT_IPV6' | 'ONE_TO_ONE_NAT' — The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6. - `name` string — The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the recommend name is External IPv6. - `publicPtrDomainName` string — The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range. - `natIP` string — Applies to accessConfigs (IPv4) only. Anexternal IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. - `networkAttachment` string — The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. - `vlan` integer — VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively. - `fingerprint` string, byte — Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date. - `nicType` 'GVNIC' | 'IDPF' | 'IRDMA' | 'MRDMA' | 'UNSPECIFIED_NIC_TYPE' | 'VIRTIO_NET' — The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. - `networkIP` string — An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. - `ipv6Address` string — An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork. - `stackType` 'IPV4_IPV6' | 'IPV4_ONLY' | 'IPV6_ONLY' — The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations. - `aliasIpRanges` AliasIpRange[] — An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. - `ipCidrRange` string — The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). - `subnetworkRangeName` string — The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. - `igmpQuery` 'IGMP_QUERY_DISABLED' | 'IGMP_QUERY_V2' — Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported. - `serviceClassId` string — Optional. Producer Service's Service class Id for the region of this network interface. Can only be used with network_attachment. It is not possible to use on its own however, network_attachment can be used without service_class_id. - `subnetwork` string — The URL of the Subnetwork resource for this instance. If the network resource is inlegacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork - `aliasIpv6Ranges` AliasIpRange[] — An array of alias IPv6 ranges for this network interface. You can only specify this field for network interfaces in VPC networks. - `ipCidrRange` string — The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). - `subnetworkRangeName` string — The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. - `queueCount` integer — The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. - `accessConfigs` AccessConfig[] — An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have no external internet access. - `securityPolicy` string — The resource URL for the security policy associated with this access config. - `networkTier` 'FIXED_STANDARD' | 'PREMIUM' | 'STANDARD' | 'STANDARD_OVERRIDES_FIXED_STANDARD' — This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM,STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. - `externalIpv6` string — Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork. - `setPublicPtr` boolean — Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. - `externalIpv6PrefixLength` integer — Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs. - `type` 'DIRECT_IPV6' | 'ONE_TO_ONE_NAT' — The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6. - `name` string — The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the recommend name is External IPv6. - `publicPtrDomainName` string — The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range. - `natIP` string — Applies to accessConfigs (IPv4) only. Anexternal IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. - `network` string — URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default - `confidentialInstanceConfig` ConfidentialInstanceConfig — A set of Confidential Instance options. - `confidentialInstanceType` 'CCA' | 'CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED' | 'SEV' | 'SEV_SNP' | 'TDX' — Defines the type of technology used by the confidential instance. - `enableConfidentialCompute` boolean — Defines whether the instance should have confidential compute enabled. - `networkPerformanceConfig` NetworkPerformanceConfig - `totalEgressBandwidthTier` 'DEFAULT' | 'TIER_1' - `id` string, uint64 — Output only. [Output Only] A unique identifier for this machine image. The server defines this identifier. - `savedDisks` SavedDisk[] — Output only. An array of Machine Image specific properties for disks attached to the source instance - `storageBytes` string, int64 — Output only. [Output Only] Size of the individual disk snapshot used by this machine image. - `storageBytesStatus` 'UPDATING' | 'UP_TO_DATE' — Output only. [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. - `sourceDisk` string — Output only. Specifies a URL of the disk attached to the source instance. - `kind` string — Output only. [Output Only] Type of the resource. Always compute#savedDisk for attached disks. - `architecture` 'ARCHITECTURE_UNSPECIFIED' | 'ARM64' | 'X86_64' — Output only. [Output Only] The architecture of the attached disk. - `sourceInstance` string — The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance - projects/project/zones/zone/instances/instance - `status` 'CREATING' | 'DELETING' | 'INVALID' | 'READY' | 'UPLOADING' — Output only. [Output Only] The status of the machine image. One of the following values:INVALID, CREATING, READY,DELETING, and UPLOADING. - `storageLocations` string[] — The regional or multi-regional Cloud Storage bucket location where themachine image is stored. - `params` MachineImageParams — Machine Image parameters - `resourceManagerTags` object — Input only. Resource manager tags to be bound to the machine image. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when empty. - `satisfiesPzs` boolean — Output only. [Output Only] Reserved for future use. - `name` string — Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - `machineImageEncryptionKey` CustomerEncryptionKey - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 - `sha256` string — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. - `rawKey` string — Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - `kmsKeyServiceAccount` string — The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - `rsaEncryptedKey` string — Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - `guestFlush` boolean — [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process. - `kind` string — Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image. - `sourceInstanceProperties` SourceInstanceProperties — DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field. - `canIpForward` boolean — Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding documentation for more information. - `labels` object — Labels to apply to instances that are created from this machine image. - `description` string — An optional text description for the instances that are created from this machine image. - `scheduling` Scheduling — Sets the scheduling options for an Instance. - `locationHint` string — An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. - `skipGuestOsShutdown` boolean — Default is false and there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs. - `minNodeCpus` integer — The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. - `onHostMaintenance` 'MIGRATE' | 'TERMINATE' — Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. Forpreemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy. - `provisioningModel` 'FLEX_START' | 'RESERVATION_BOUND' | 'SPOT' | 'STANDARD' — Specifies the provisioning model of the instance. - `localSsdRecoveryTimeout` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `nanos` integer — Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - `seconds` string, int64 — Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - `maxRunDuration` Duration — A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `nanos` integer — Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - `seconds` string, int64 — Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - `terminationTime` string — Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance termination action will be performed at the termination time. - `onInstanceStopAction` SchedulingOnInstanceStopAction — Defines the behaviour for instances with the instance_termination_actionSTOP. - `discardLocalSsd` boolean — If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time. - `instanceTerminationAction` 'DELETE' | 'INSTANCE_TERMINATION_ACTION_UNSPECIFIED' | 'STOP' — Specifies the termination action for the instance. - `hostErrorTimeoutSeconds` integer — Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. - `automaticRestart` boolean — Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances.Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - `nodeAffinities` SchedulingNodeAffinity[] — A set of node affinity and anti-affinity configurations. Refer toConfiguring node affinity for more information. Overrides reservationAffinity. - `operator` 'IN' | 'NOT_IN' | 'OPERATOR_UNSPECIFIED' — Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity. - `key` string — Corresponds to the label key of Node resource. - `values` string[] — Corresponds to the label values of Node resource. - `preemptible` boolean — Defines whether the instance is preemptible. This can only be set during instance creation or while the instance isstopped and therefore, in a `TERMINATED` state. SeeInstance Life Cycle for more information on the possible instance states. - `availabilityDomain` integer — Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. - `metadata` Metadata — A metadata key/value entry. - `kind` string — Output only. [Output Only] Type of the resource. Always compute#metadata for metadata. - `fingerprint` string, byte — Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. - `items` object[] — Array of key/value pairs. The total size of all keys and values must be less than 512 KB. - `key` string — Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. - `value` string — Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). - `networkInterfaces` NetworkInterface[] — An array of network access configurations for this interface. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces. - `internalIpv6PrefixLength` integer — The prefix length of the primary internal IPv6 range. - `parentNicName` string — Name of the parent network interface of a dynamic network interface. - `name` string — [Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and7. The default interface value is nic0. - `enableVpcScopedDns` boolean — Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. - `ipv6AccessType` 'EXTERNAL' | 'INTERNAL' — Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6. - `ipv6AccessConfigs` AccessConfig[] — An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. - `securityPolicy` string — The resource URL for the security policy associated with this access config. - `networkTier` 'FIXED_STANDARD' | 'PREMIUM' | 'STANDARD' | 'STANDARD_OVERRIDES_FIXED_STANDARD' — This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM,STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. - `externalIpv6` string — Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork. - `setPublicPtr` boolean — Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. - `externalIpv6PrefixLength` integer — Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs. - `type` 'DIRECT_IPV6' | 'ONE_TO_ONE_NAT' — The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6. - `name` string — The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the recommend name is External IPv6. - `publicPtrDomainName` string — The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range. - `natIP` string — Applies to accessConfigs (IPv4) only. Anexternal IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. - `networkAttachment` string — The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. - `vlan` integer — VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively. - `fingerprint` string, byte — Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date. - `nicType` 'GVNIC' | 'IDPF' | 'IRDMA' | 'MRDMA' | 'UNSPECIFIED_NIC_TYPE' | 'VIRTIO_NET' — The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. - `networkIP` string — An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. - `ipv6Address` string — An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork. - `stackType` 'IPV4_IPV6' | 'IPV4_ONLY' | 'IPV6_ONLY' — The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations. - `aliasIpRanges` AliasIpRange[] — An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. - `ipCidrRange` string — The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). - `subnetworkRangeName` string — The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. - `igmpQuery` 'IGMP_QUERY_DISABLED' | 'IGMP_QUERY_V2' — Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported. - `serviceClassId` string — Optional. Producer Service's Service class Id for the region of this network interface. Can only be used with network_attachment. It is not possible to use on its own however, network_attachment can be used without service_class_id. - `subnetwork` string — The URL of the Subnetwork resource for this instance. If the network resource is inlegacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork - regions/region/subnetworks/subnetwork - `aliasIpv6Ranges` AliasIpRange[] — An array of alias IPv6 ranges for this network interface. You can only specify this field for network interfaces in VPC networks. - `ipCidrRange` string — The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24). - `subnetworkRangeName` string — The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. - `queueCount` integer — The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. - `accessConfigs` AccessConfig[] — An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have no external internet access. - `securityPolicy` string — The resource URL for the security policy associated with this access config. - `networkTier` 'FIXED_STANDARD' | 'PREMIUM' | 'STANDARD' | 'STANDARD_OVERRIDES_FIXED_STANDARD' — This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM,STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. - `externalIpv6` string — Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork. - `setPublicPtr` boolean — Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated. - `externalIpv6PrefixLength` integer — Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs. - `type` 'DIRECT_IPV6' | 'ONE_TO_ONE_NAT' — The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6. - `name` string — The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the recommend name is External IPv6. - `publicPtrDomainName` string — The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range. - `natIP` string — Applies to accessConfigs (IPv4) only. Anexternal IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. - `network` string — URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/network - projects/project/global/networks/network - global/networks/default - `tags` Tags — A set of instance tags. - `fingerprint` string, byte — Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance. - `items` string[] — An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. - `minCpuPlatform` string — Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" orminCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. - `disks` SavedAttachedDisk[] — An array of disks that are associated with the instances that are created from this machine image. - `source` string — Specifies a URL of the disk attached to the source instance. - `mode` 'READ_ONLY' | 'READ_WRITE' — The mode in which this disk is attached to the source instance, eitherREAD_WRITE or READ_ONLY. - `storageBytes` string, int64 — Output only. [Output Only] A size of the storage used by the disk's snapshot by this machine image. - `autoDelete` boolean — Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). - `diskType` string — Output only. [Output Only] URL of the disk type resource. For example:projects/project/zones/zone/diskTypes/pd-standard or pd-ssd - `diskSizeGb` string, int64 — The size of the disk in base-2 GB. - `deviceName` string — Specifies the name of the disk attached to the source instance. - `kind` string — Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks. - `index` integer — Output only. Specifies zero-based index of the disk that is attached to the source instance. - `interface` 'NVME' | 'SCSI' — Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. - `guestOsFeatures` GuestOsFeature[] — A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. - `type` 'BARE_METAL_LINUX_COMPATIBLE' | 'CCA_CAPABLE' | 'FEATURE_TYPE_UNSPECIFIED' | 'GVNIC' | 'IDPF' | 'MULTI_IP_SUBNET' | 'SECURE_BOOT' | 'SEV_CAPABLE' | 'SEV_LIVE_MIGRATABLE' | 'SEV_LIVE_MIGRATABLE_V2' | 'SEV_SNP_CAPABLE' | 'SNP_SVSM_CAPABLE' | 'TDX_CAPABLE' | 'UEFI_COMPATIBLE' | 'VIRTIO_SCSI_MULTIQUEUE' | 'WINDOWS' — The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE - CCA_CAPABLE For more information, see Enabling guest operating system features. - `boot` boolean — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. - `licenses` string[] — Output only. [Output Only] Any valid publicly visible licenses. - `storageBytesStatus` 'UPDATING' | 'UP_TO_DATE' — Output only. [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. - `diskEncryptionKey` CustomerEncryptionKey - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 - `sha256` string — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. - `rawKey` string — Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - `kmsKeyServiceAccount` string — The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - `rsaEncryptedKey` string — Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - `type` 'PERSISTENT' | 'SCRATCH' — Specifies the type of the attached disk, either SCRATCH orPERSISTENT. - `keyRevocationActionType` 'KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED' | 'NONE' | 'STOP' — KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. - `postKeyRevocationActionType` 'NOOP' | 'POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED' | 'SHUTDOWN' — PostKeyRevocationActionType of the instance. - `deletionProtection` boolean — Whether the instance created from this machine image should be protected against deletion. - `serviceAccounts` ServiceAccount[] — A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances. - `email` string — Email address of the service account. - `scopes` string[] — The list of scopes to be made available for this service account. - `guestAccelerators` AcceleratorConfig[] — A list of guest accelerator cards' type and count to use for instances created from this machine image. - `acceleratorType` string — Full or partial URL of the accelerator type resource to attach to this instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. - `acceleratorCount` integer — The number of the guest accelerator cards exposed to this instance. - `machineType` string — The machine type to use for instances that are created from this machine image. - `sourceDiskEncryptionKeys` SourceDiskEncryptionKey[] — [Input Only] Thecustomer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key. - `sourceDisk` string — URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk - `diskEncryptionKey` CustomerEncryptionKey - `kmsKeyName` string — The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 - `sha256` string — [Output only] TheRFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. - `rawKey` string — Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" - `kmsKeyServiceAccount` string — The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ - `rsaEncryptedKey` string — Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or thersaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem - `creationTimestamp` string — Output only. [Output Only] The creation timestamp for this machine image inRFC3339 text format. - `description` string — An optional description of this resource. Provide this property when you create the resource. - `labelFingerprint` string, byte — A fingerprint for the labels being applied to this machine image, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the machine image. - `satisfiesPzi` boolean — Output only. Reserved for future use. - `labels` object — Labels to apply to this machine image. These can be later modified by the setLabels method. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/compute.md) · [All operations](https://skmtc.net/google/apis/compute/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/compute/versions/6120ed8969d4/schema)