Class Disk

Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * Zonal * Regional Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

Inheritance

object

Disk

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Compute.alpha.Data

Assembly: Google.Apis.Compute.alpha.dll

Syntax

public class Disk : IDirectResponseSchema

Properties

AccessMode

The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types.

Declaration

[JsonProperty("accessMode")]
public virtual string AccessMode { get; set; }

Property Value

Type	Description
string

Architecture

The architecture of the disk. Valid values are ARM64 or X86_64.

Declaration

[JsonProperty("architecture")]
public virtual string Architecture { get; set; }

Property Value

Type	Description
string

AsyncPrimaryDisk

Disk asynchronously replicated into this disk.

Declaration

[JsonProperty("asyncPrimaryDisk")]
public virtual DiskAsyncReplication AsyncPrimaryDisk { get; set; }

Property Value

Type	Description
DiskAsyncReplication

AsyncSecondaryDisks

[Output Only] A list of disks this disk is asynchronously replicated to.

Declaration

[JsonProperty("asyncSecondaryDisks")]
public virtual IDictionary<string, DiskAsyncReplicationList> AsyncSecondaryDisks { get; set; }

Property Value

Type	Description
IDictionary<string, DiskAsyncReplicationList>

CreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Declaration

[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }

Property Value

Type	Description
string

Description

An optional description of this resource. Provide this property when you create the resource.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DiskEncryptionKey

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.

Declaration

[JsonProperty("diskEncryptionKey")]
public virtual CustomerEncryptionKey DiskEncryptionKey { get; set; }

Property Value

Type	Description
CustomerEncryptionKey

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnableConfidentialCompute

Whether this disk is using confidential compute mode.

Declaration

[JsonProperty("enableConfidentialCompute")]
public virtual bool? EnableConfidentialCompute { get; set; }

Property Value

Type	Description
bool?

EraseWindowsVssSignature

Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.

Declaration

[JsonProperty("eraseWindowsVssSignature")]
public virtual bool? EraseWindowsVssSignature { 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>

Id

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Declaration

[JsonProperty("id")]
public virtual ulong? Id { get; set; }

Property Value

Type	Description
ulong?

Interface__

[Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Declaration

[JsonProperty("interface")]
public virtual string Interface__ { get; set; }

Property Value

Type	Description
string

Kind

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

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

LabelFingerprint

A fingerprint for the labels being applied to this disk, 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.

Declaration

[JsonProperty("labelFingerprint")]
public virtual string LabelFingerprint { get; set; }

Property Value

Type	Description
string

Labels

Labels to apply to this disk. These can be later modified by the setLabels method.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

LastAttachTimestamp

[Output Only] Last attach timestamp in RFC3339 text format.

Declaration

[JsonProperty("lastAttachTimestamp")]
public virtual string LastAttachTimestamp { get; set; }

Property Value

Type	Description
string

LastDetachTimestamp

[Output Only] Last detach timestamp in RFC3339 text format.

Declaration

[JsonProperty("lastDetachTimestamp")]
public virtual string LastDetachTimestamp { get; set; }

Property Value

Type	Description
string

LicenseCodes

Integer license codes indicating which licenses are attached to this disk.

Declaration

[JsonProperty("licenseCodes")]
public virtual IList<long?> LicenseCodes { get; set; }

Property Value

Type	Description
IList<long?>

Licenses

A list of publicly visible licenses. Reserved for Google's use.

Declaration

[JsonProperty("licenses")]
public virtual IList<string> Licenses { get; set; }

Property Value

Type	Description
IList<string>

LocationHint

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

Declaration

[JsonProperty("locationHint")]
public virtual string LocationHint { get; set; }

Property Value

Type	Description
string

Locked

[Output Only] The field indicates if the disk is created from a locked source image. Attachment of a disk created from a locked source image will cause the following operations to become irreversibly prohibited: - R/W or R/O disk attachment to any other instance - Disk detachment. And the disk can only be deleted when the instance is deleted - Creation of images or snapshots - Disk cloning Furthermore, the instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Further attachment of secondary disks. - Detachment of any disks - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true for locked disks - Attach a locked disk with --auto-delete parameter set to false

Declaration

[JsonProperty("locked")]
public virtual bool? Locked { get; set; }

Property Value

Type	Description
bool?

MultiWriter

Indicates whether or not the disk can be read/write attached to more than one instance.

Declaration

[JsonProperty("multiWriter")]
public virtual bool? MultiWriter { get; set; }

Property Value

Type	Description
bool?

Name

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Options

Internal use only.

Declaration

[JsonProperty("options")]
public virtual string Options { get; set; }

Property Value

Type	Description
string

Params__

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

Declaration

[JsonProperty("params")]
public virtual DiskParams Params__ { get; set; }

Property Value

Type	Description
DiskParams

PhysicalBlockSizeBytes

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

Declaration

[JsonProperty("physicalBlockSizeBytes")]
public virtual long? PhysicalBlockSizeBytes { get; set; }

Property Value

Type	Description
long?

ProvisionedIops

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.

Declaration

[JsonProperty("provisionedIops")]
public virtual long? ProvisionedIops { get; set; }

Property Value

Type	Description
long?

ProvisionedThroughput

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 be greater than or equal to 1.

Declaration

[JsonProperty("provisionedThroughput")]
public virtual long? ProvisionedThroughput { get; set; }

Property Value

Type	Description
long?

Region

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Declaration

[JsonProperty("region")]
public virtual string Region { get; set; }

Property Value

Type	Description
string

ReplicaZones

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

Declaration

[JsonProperty("replicaZones")]
public virtual IList<string> ReplicaZones { get; set; }

Property Value

Type	Description
IList<string>

ResourcePolicies

Resource policies applied to this disk for automatic snapshot creations.

Declaration

[JsonProperty("resourcePolicies")]
public virtual IList<string> ResourcePolicies { get; set; }

Property Value

Type	Description
IList<string>

ResourceStatus

[Output Only] Status information for the disk resource.

Declaration

[JsonProperty("resourceStatus")]
public virtual DiskResourceStatus ResourceStatus { get; set; }

Property Value

Type	Description
DiskResourceStatus

SatisfiesPzi

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

[Output Only] Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

SelfLink

[Output Only] Server-defined fully-qualified URL for this resource.

Declaration

[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }

Property Value

Type	Description
string

SelfLinkWithId

[Output Only] Server-defined URL for this resource's resource id.

Declaration

[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }

Property Value

Type	Description
string

SizeGb

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.

Declaration

[JsonProperty("sizeGb")]
public virtual long? SizeGb { get; set; }

Property Value

Type	Description
long?

SourceConsistencyGroupPolicy

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

Declaration

[JsonProperty("sourceConsistencyGroupPolicy")]
public virtual string SourceConsistencyGroupPolicy { get; set; }

Property Value

Type	Description
string

SourceConsistencyGroupPolicyId

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

Declaration

[JsonProperty("sourceConsistencyGroupPolicyId")]
public virtual string SourceConsistencyGroupPolicyId { get; set; }

Property Value

Type	Description
string

SourceDisk

The source disk used to create this disk. 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 /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk

• regions/region/disks/disk

Declaration

[JsonProperty("sourceDisk")]
public virtual string SourceDisk { get; set; }

Property Value

Type	Description
string

SourceDiskId

[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

Declaration

[JsonProperty("sourceDiskId")]
public virtual string SourceDiskId { get; set; }

Property Value

Type	Description
string

SourceImage

The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, 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

Declaration

[JsonProperty("sourceImage")]
public virtual string SourceImage { get; set; }

Property Value

Type	Description
string

SourceImageEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Declaration

[JsonProperty("sourceImageEncryptionKey")]
public virtual CustomerEncryptionKey SourceImageEncryptionKey { get; set; }

Property Value

Type	Description
CustomerEncryptionKey

SourceImageId

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

Declaration

[JsonProperty("sourceImageId")]
public virtual string SourceImageId { get; set; }

Property Value

Type	Description
string

SourceInstantSnapshot

The source instant snapshot used to create this disk. 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 /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

Declaration

[JsonProperty("sourceInstantSnapshot")]
public virtual string SourceInstantSnapshot { get; set; }

Property Value

Type	Description
string

SourceInstantSnapshotId

[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.

Declaration

[JsonProperty("sourceInstantSnapshotId")]
public virtual string SourceInstantSnapshotId { get; set; }

Property Value

Type	Description
string

SourceSnapshot

The source snapshot used to create this disk. 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 /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

Declaration

[JsonProperty("sourceSnapshot")]
public virtual string SourceSnapshot { get; set; }

Property Value

Type	Description
string

SourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Declaration

[JsonProperty("sourceSnapshotEncryptionKey")]
public virtual CustomerEncryptionKey SourceSnapshotEncryptionKey { get; set; }

Property Value

Type	Description
CustomerEncryptionKey

SourceSnapshotId

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

Declaration

[JsonProperty("sourceSnapshotId")]
public virtual string SourceSnapshotId { get; set; }

Property Value

Type	Description
string

SourceStorageObject

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

Declaration

[JsonProperty("sourceStorageObject")]
public virtual string SourceStorageObject { get; set; }

Property Value

Type	Description
string

Status

[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.

Declaration

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
string

StoragePool

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

Declaration

[JsonProperty("storagePool")]
public virtual string StoragePool { get; set; }

Property Value

Type	Description
string

StorageType

[Deprecated] Storage type of the persistent disk.

Declaration

[JsonProperty("storageType")]
public virtual string StorageType { get; set; }

Property Value

Type	Description
string

Type

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.

Declaration

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

Property Value

Type	Description
string

UserLicenses

A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

Declaration

[JsonProperty("userLicenses")]
public virtual IList<string> UserLicenses { get; set; }

Property Value

Type	Description
IList<string>

Users

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

Declaration

[JsonProperty("users")]
public virtual IList<string> Users { get; set; }

Property Value

Type	Description
IList<string>

Zone

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Declaration

[JsonProperty("zone")]
public virtual string Zone { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema