Class AttachedDisk

An instance-attached disk resource.

Inheritance
object
AttachedDisk
Implements
Inherited Members
Namespace: Google.Apis.Compute.beta.Data
Assembly: Google.Apis.Compute.beta.dll
Syntax
public class AttachedDisk : IDirectResponseSchema

Properties

Architecture

[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.

Declaration
[JsonProperty("architecture")]
public virtual string Architecture { get; set; }
Property Value
Type Description
string

AutoDelete

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Declaration
[JsonProperty("autoDelete")]
public virtual bool? AutoDelete { get; set; }
Property Value
Type Description
bool?

Boot

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Declaration
[JsonProperty("boot")]
public virtual bool? Boot { get; set; }
Property Value
Type Description
bool?

DeviceName

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.

Declaration
[JsonProperty("deviceName")]
public virtual string DeviceName { get; set; }
Property Value
Type Description
string

DiskEncryptionKey

Encrypts or decrypts a disk using a customer-supplied encryption key. 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, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method.

Declaration
[JsonProperty("diskEncryptionKey")]
public virtual CustomerEncryptionKey DiskEncryptionKey { get; set; }
Property Value
Type Description
CustomerEncryptionKey

DiskSizeGb

The size of the disk in GB.

Declaration
[JsonProperty("diskSizeGb")]
public virtual long? DiskSizeGb { get; set; }
Property Value
Type Description
long?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ForceAttach

[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.

Declaration
[JsonProperty("forceAttach")]
public virtual bool? ForceAttach { get; set; }
Property Value
Type Description
bool?

GuestOsFeatures

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.

Declaration
[JsonProperty("guestOsFeatures")]
public virtual IList<GuestOsFeature> GuestOsFeatures { get; set; }
Property Value
Type Description
IList<GuestOsFeature>

Index

[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.

Declaration
[JsonProperty("index")]
public virtual int? Index { get; set; }
Property Value
Type Description
int?

InitializeParams

[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.

Declaration
[JsonProperty("initializeParams")]
public virtual AttachedDiskInitializeParams InitializeParams { get; set; }
Property Value
Type Description
AttachedDiskInitializeParams

Interface__

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.

Declaration
[JsonProperty("interface")]
public virtual string Interface__ { get; set; }
Property Value
Type Description
string

Kind

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

Licenses

[Output Only] Any valid publicly visible licenses.

Declaration
[JsonProperty("licenses")]
public virtual IList<string> Licenses { get; set; }
Property Value
Type Description
IList<string>

Locked

[Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Declaration
[JsonProperty("locked")]
public virtual bool? Locked { get; set; }
Property Value
Type Description
bool?

Mode

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.

Declaration
[JsonProperty("mode")]
public virtual string Mode { get; set; }
Property Value
Type Description
string

SavedState

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.

Declaration
[JsonProperty("savedState")]
public virtual string SavedState { get; set; }
Property Value
Type Description
string

ShieldedInstanceInitialState

[Output Only] shielded vm initial state stored on disk

Declaration
[JsonProperty("shieldedInstanceInitialState")]
public virtual InitialStateConfig ShieldedInstanceInitialState { get; set; }
Property Value
Type Description
InitialStateConfig

Source

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.

Declaration
[JsonProperty("source")]
public virtual string Source { get; set; }
Property Value
Type Description
string

Type

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

UserLicenses

[Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

Declaration
[JsonProperty("userLicenses")]
public virtual IList<string> UserLicenses { get; set; }
Property Value
Type Description
IList<string>

Implements