Compute Engine v1 API - Class AttachedDisk (2.16.0)

public sealed class AttachedDisk : IMessage<AttachedDisk>, IEquatable<AttachedDisk>, IDeepCloneable<AttachedDisk>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class AttachedDisk.

An instance-attached disk resource.

Inheritance

object > AttachedDisk

Implements

IMessage AttachedDisk, IEquatable AttachedDisk, IDeepCloneable AttachedDisk, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

AttachedDisk()

public AttachedDisk()

AttachedDisk(AttachedDisk)

public AttachedDisk(AttachedDisk other)

Parameter
Name	Description
`other`	`AttachedDisk`

Properties

Architecture

public string Architecture { get; set; }

[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

Property Value
Type	Description
`string`

AutoDelete

public bool AutoDelete { get; set; }

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

Property Value
Type	Description
`bool`

Boot

public bool Boot { get; set; }

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

Property Value
Type	Description
`bool`

DeviceName

public string DeviceName { get; set; }

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.

Property Value
Type	Description
`string`

DiskEncryptionKey

public CustomerEncryptionKey DiskEncryptionKey { get; set; }

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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Property Value
Type	Description
`CustomerEncryptionKey`

DiskSizeGb

public long DiskSizeGb { get; set; }

The size of the disk in GB.

Property Value
Type	Description
`long`

ForceAttach

public bool ForceAttach { get; set; }

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

Property Value
Type	Description
`bool`

GuestOsFeatures

public RepeatedField<GuestOsFeature> GuestOsFeatures { get; }

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.

Property Value
Type	Description
`RepeatedFieldGuestOsFeature`

HasArchitecture

public bool HasArchitecture { get; }

Gets whether the "architecture" field is set

Property Value
Type	Description
`bool`

HasAutoDelete

public bool HasAutoDelete { get; }

Gets whether the "auto_delete" field is set

Property Value
Type	Description
`bool`

HasBoot

public bool HasBoot { get; }

Gets whether the "boot" field is set

Property Value
Type	Description
`bool`

HasDeviceName

public bool HasDeviceName { get; }

Gets whether the "device_name" field is set

Property Value
Type	Description
`bool`

HasDiskSizeGb

public bool HasDiskSizeGb { get; }

Gets whether the "disk_size_gb" field is set

Property Value
Type	Description
`bool`

HasForceAttach

public bool HasForceAttach { get; }

Gets whether the "force_attach" field is set

Property Value
Type	Description
`bool`

HasIndex

public bool HasIndex { get; }

Gets whether the "index" field is set

Property Value
Type	Description
`bool`

HasInterface

public bool HasInterface { get; }

Gets whether the "interface" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasMode

public bool HasMode { get; }

Gets whether the "mode" field is set

Property Value
Type	Description
`bool`

HasSavedState

public bool HasSavedState { get; }

Gets whether the "saved_state" field is set

Property Value
Type	Description
`bool`

HasSource

public bool HasSource { get; }

Gets whether the "source" field is set

Property Value
Type	Description
`bool`

HasType

public bool HasType { get; }

Gets whether the "type" field is set

Property Value
Type	Description
`bool`

Index

public int Index { get; set; }

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

Property Value
Type	Description
`int`

InitializeParams

public AttachedDiskInitializeParams InitializeParams { get; set; }

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

Property Value
Type	Description
`AttachedDiskInitializeParams`

Interface

public string Interface { get; set; }

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. Check the Interface enum for the list of possible values.

Property Value
Type	Description
`string`

Kind

public string Kind { get; set; }

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

Property Value
Type	Description
`string`

Licenses

public RepeatedField<string> Licenses { get; }

[Output Only] Any valid publicly visible licenses.

Property Value
Type	Description
`RepeatedFieldstring`

Mode

public string Mode { get; set; }

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. Check the Mode enum for the list of possible values.

Property Value
Type	Description
`string`

SavedState

public string SavedState { get; set; }

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. Check the SavedState enum for the list of possible values.

Property Value
Type	Description
`string`

ShieldedInstanceInitialState

public InitialStateConfig ShieldedInstanceInitialState { get; set; }

[Output Only] shielded vm initial state stored on disk

Property Value
Type	Description
`InitialStateConfig`

Source

public string Source { get; set; }

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. 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.

Property Value
Type	Description
`string`

Type

public string Type { get; set; }

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Check the Type enum for the list of possible values.

Property Value
Type	Description
`string`