addedOutput schema / $defs / AttachedDisk
Added value: +{
+ "description": "An instance-attached disk resource.",
+ "properties": {
+ "architecture": {
+ "description": "Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
+ ]
+ },
+ "autoDelete": {
+ "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
+ "type": "boolean"
+ },
+ "boot": {
+ "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.",
+ "type": "boolean"
+ },
+ "deviceName": {
+ "description": "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.",
+ "type": "string"
+ },
+ "diskEncryptionKey": {
+ "$ref": "#/$defs/CustomerEncryptionKey",
+ "description": "Encrypts or decrypts a disk using a customer-supplied encryption key </compute/docs/disks/customer-supplied-encryption>. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys </compute/docs/disks/customer-supplied-encryption>, so you cannot use your own keys to encrypt disks in a managed instance group </compute/docs/instance-groups/>. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method </compute/docs/reference/rest/v1/instances/bulkInsert>."
+ },
+ "diskSizeGb": {
+ "description": "The size of the disk in GB.",
+ "format": "int64",
+ "type": "string"
+ },
+ "forceAttach": {
+ "description": "[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.",
+ "type": "boolean"
+ },
+ "guestOsFeatures": {
+ "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features </compute/docs/images/create-delete-deprecate-private-images#guest-os-features> to see a list of available options.",
+ "items": {
+ "$ref": "#/$defs/GuestOsFeature"
+ },
+ "type": "array"
+ },
+ "index": {
+ "description": "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.",
+ "format": "int32",
+ "readOnly": true,
+ "type": "integer"
+ },
+ "initializeParams": {
+ "$ref": "#/$defs/InitializeParams",
+ "description": "[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 property is mutually exclusive with the source property; you can only define one or the other, but not both."
+ },
+ "interface": {
+ "description": "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, see About persistent disks <https://cloud.google.com/compute/docs/disks/persistent-disks>.",
+ "enum": [
+ "NVME",
+ "SCSI"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "",
+ ""
+ ]
+ },
+ "kind": {
+ "default": "compute#attachedDisk",
+ "description": "Output only. [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "licenses": {
+ "description": "Output only. [Output Only] Any valid publicly visible licenses.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "mode": {
+ "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
+ "enum": [
+ "READ_ONLY",
+ "READ_WRITE"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.",
+ "*[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode."
+ ]
+ },
+ "savedState": {
+ "description": "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.",
+ "enum": [
+ "DISK_SAVED_STATE_UNSPECIFIED",
+ "PRESERVED"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "*[Default]* Disk state has not been preserved.",
+ "Disk state has been preserved."
+ ]
+ },
+ "shieldedInstanceInitialState": {
+ "$ref": "#/$defs/InitialStateConfig",
+ "description": "Output only. [Output Only] shielded vm initial state stored on disk",
+ "readOnly": true
+ },
+ "source": {
+ "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.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.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
+ "enum": [
+ "PERSISTENT",
+ "SCRATCH"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "",
+ ""
+ ]
+ }
+ },
+ "type": "object"
+}
addedOutput schema / $defs / CustomerEncryptionKey
Added value: +{
+ "properties": {
+ "kmsKeyName": {
+ "description": "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 ",
+ "type": "string"
+ },
+ "kmsKeyServiceAccount": {
+ "description": "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/ ",
+ "type": "string"
+ },
+ "rawKey": {
+ "deprecated": true,
+ "description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead. Specifies a 256-bit customer-supplied encryption key </compute/docs/disks/customer-supplied-encryption>, encoded in RFC 4648 base64 <https://tools.ietf.org/html/rfc4648#section-4> to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: \"rawKey\": \"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\" ",
+ "type": "string"
+ },
+ "rsaEncryptedKey": {
+ "deprecated": true,
+ "description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead. Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key </compute/docs/disks/customer-supplied-encryption#rsa-encryption> to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. 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 <https://tools.ietf.org/html/rfc4648#section-4> encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem ",
+ "type": "string"
+ },
+ "sha256": {
+ "deprecated": true,
+ "description": "[DEPRECATED] CSEK is no longer supported. Use CMEK instead. [Output only] The RFC 4648 base64 <https://tools.ietf.org/html/rfc4648#section-4> encoded SHA-256 hash of the customer-supplied encryption key </compute/docs/disks/customer-supplied-encryption> that protects this resource.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+}
addedOutput schema / $defs / FileContentBuffer
Added value: +{
+ "properties": {
+ "content": {
+ "description": "The raw content in the secure keys file.",
+ "format": "byte",
+ "type": "string"
+ },
+ "fileType": {
+ "description": "The file type of source file.",
+ "enum": [
+ "BIN",
+ "UNDEFINED",
+ "X509"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "",
+ "",
+ ""
+ ]
+ }
+ },
+ "type": "object"
+}
addedOutput schema / $defs / GuestOsFeature
Added value: +{
+ "description": "Guest OS features.",
+ "properties": {
+ "type": {
+ "description": "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 - SUSPEND_SAFE_FPR For more information, see Enabling guest operating system features </compute/docs/images/create-delete-deprecate-private-images#guest-os-features> .",
+ "enum": [
+ "BARE_METAL_LINUX_COMPATIBLE",
+ "BMSAI_CAPABLE",
+ "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",
+ "SUSPEND_SAFE_FPR",
+ "TDX_CAPABLE",
+ "UEFI_COMPATIBLE",
+ "VIRTIO_SCSI_MULTIQUEUE",
+ "WINDOWS"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "",
+ "Indicates the guest OS is capable of Bare Metal Secure AI (BMSAI) confidential computing.",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "Indicates the guest OS is safe for free page reporting (FPR) during suspend.",
+ "",
+ "",
+ "",
+ ""
+ ]
+ }
+ },
+ "type": "object"
+}
addedOutput schema / $defs / InitialStateConfig
Added value: +{
+ "description": "Initial State for shielded instance, these are public keys which are safe to store in public",
+ "properties": {
+ "dbs": {
+ "description": "The Key Database (db).",
+ "items": {
+ "$ref": "#/$defs/FileContentBuffer"
+ },
+ "type": "array"
+ },
+ "dbxs": {
+ "description": "The forbidden key database (dbx).",
+ "items": {
+ "$ref": "#/$defs/FileContentBuffer"
+ },
+ "type": "array"
+ },
+ "keks": {
+ "description": "The Key Exchange Key (KEK).",
+ "items": {
+ "$ref": "#/$defs/FileContentBuffer"
+ },
+ "type": "array"
+ },
+ "pk": {
+ "$ref": "#/$defs/FileContentBuffer",
+ "description": "The Platform Key (PK)."
+ }
+ },
+ "type": "object"
+}
addedOutput schema / $defs / InitializeParams
Added value: +{
+ "description": "[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.",
+ "properties": {
+ "architecture": {
+ "description": "The architecture of the attached disk. Valid values are arm64 or x86_64.",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
+ ]
+ },
+ "description": {
+ "description": "An optional description. Provide this property when creating the disk.",
+ "type": "string"
+ },
+ "diskName": {
+ "description": "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.",
+ "type": "string"
+ },
+ "diskSizeGb": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "diskType": {
+ "description": "Specifies the disk type used for the boot disk or an additional data disk. For valid disk type values, see Supported types for Hyperdisk volumes </compute/docs/disks/add-hyperdisk#hd_disk_types> and Persistent Disk type variables </compute/docs/disks/add-persistent-disk#hd_disk_types>. When creating a single instance, you must provide either the full or partial URL of the disk type. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType When creating an instance template, instance flexibility policy, or when creating or updating an all-instances configuration, you specify the disk type without a URL, for example, hyperdisk-balanced. If you omit this field for a disk, the default disk type depends on the instance's machine series, as follows. - For first- and second-generation machine series like N1, N2, T2, and M1, the default disk type is Standard Persistent Disk (pd-standard). - For C3, C3D, and M3 the default is Balanced Persistent Disk ( pd-balanced). - For other third-generation machine series like A3, H3, Z3, all fourth-generation types like C4, N4, M4, and newer machine series, the default is Hyperdisk Balanced (hyperdisk-balanced). The disk type you specify must be compatible with the instance's machine series. For a list of machine series that support Persistent Disk, see Machine series support for Persistent Disk </compute/docs/disks/persistent-disks#pd-machine-series>. For a list of machine series that support Hyperdisk, see Machine series support for Hyperdisk </compute/docs/disks/hyperdisks#machine-type-support>.",
+ "type": "string"
+ },
+ "enableConfidentialCompute": {
+ "description": "Whether this disk is using confidential compute mode.",
+ "type": "boolean"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.",
+ "type": "object"
+ },
+ "licenses": {
+ "description": "A list of publicly visible licenses. Reserved for Google's use.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "onUpdateAction": {
+ "description": "Specifies which action to take on instance update with this disk. Default is to use the existing disk.",
+ "enum": [
+ "RECREATE_DISK",
+ "RECREATE_DISK_IF_SOURCE_CHANGED",
+ "USE_EXISTING_DISK"
+ ],
+ "type": "string",
+ "x-google-enum-descriptions": [
+ "Always recreate the disk.",
+ "Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.",
+ "Use the existing disk, this is the default behaviour."
+ ]
+ },
+ "provisionedIops": {
+ "description": "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 the Extreme persistent disk documentation </compute/docs/disks/extreme-persistent-disk>.",
+ "format": "int64",
+ "type": "string"
+ },
+ "provisionedThroughput": {
+ "description": "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "replicaZones": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "resourceManagerTags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags <https://cloud.google.com/resource-manager/docs/tags/tags-overview>. 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.",
+ "type": "object",
+ "writeOnly": true
+ },
+ "resourcePolicies": {
+ "description": "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.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sourceImage": {
+ "description": "The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images </compute/docs/images/os-details>, specify the image by its family name. For example, specify family/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.",
+ "type": "string"
+ },
+ "sourceImageEncryptionKey": {
+ "$ref": "#/$defs/CustomerEncryptionKey",
+ "description": "The customer-supplied encryption key </compute/docs/disks/customer-supplied-encryption> of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys </compute/docs/disks/customer-supplied-encryption>, so you cannot create disks for instances in a managed instance group </compute/docs/instance-groups/> if the source images are encrypted with your own keys."
+ },
+ "sourceSnapshot": {
+ "description": "The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.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 </compute/docs/reference/rest/v1/instances/bulkInsert>.",
+ "type": "string"
+ },
+ "sourceSnapshotEncryptionKey": {
+ "$ref": "#/$defs/CustomerEncryptionKey",
+ "description": "The customer-supplied encryption key </compute/docs/disks/customer-supplied-encryption> of the source snapshot."
+ },
+ "storagePool": {
+ "description": "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 ",
+ "type": "string"
+ }
+ },
+ "type": "object"
+}
addedOutput schema / $defs / PropertiesFromFlexibilityPolicy / properties / disks
Added value: +{
+ "description": "List of disks to be attached to the instance.",
+ "items": {
+ "$ref": "#/$defs/AttachedDisk"
+ },
+ "type": "array"
+}
addedOutput schema / $defs / PropertiesFromFlexibilityPolicy / properties / minCpuPlatform
Added value: +{
+ "description": "Name of the minimum CPU platform to be used by this instance. e.g. 'Intel Ice Lake'.",
+ "type": "string"
+}