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

Inheritance

object

AttachedDiskInitializeParams

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 AttachedDiskInitializeParams : IDirectResponseSchema

Properties

Architecture

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

Description

An optional description. Provide this property when creating the disk.

Declaration

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

Property Value

Type	Description
string

DiskName

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.

Declaration

[JsonProperty("diskName")]
public virtual string DiskName { get; set; }

Property Value

Type	Description
string

DiskSizeGb

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.

Declaration

[JsonProperty("diskSizeGb")]
public virtual long? DiskSizeGb { get; set; }

Property Value

Type	Description
long?

DiskType

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. 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 If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

Declaration

[JsonProperty("diskType")]
public virtual string DiskType { get; set; }

Property Value

Type	Description
string

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?

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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Declaration

[JsonProperty("guestOsFeatures")]
public virtual IList<GuestOsFeature> GuestOsFeatures { get; set; }

Property Value

Type	Description
IList<GuestOsFeature>

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

Labels

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

Declaration

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

Property Value

Type	Description
IDictionary<string, 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>

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?

OnUpdateAction

Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Declaration

[JsonProperty("onUpdateAction")]
public virtual string OnUpdateAction { get; set; }

Property Value

Type	Description
string

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

Declaration

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

Property Value

Type	Description
long?

ReplicaZones

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.

Declaration

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

Property Value

Type	Description
IList<string>

ResourceManagerTags

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Declaration

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

Property Value

Type	Description
IDictionary<string, string>

ResourcePolicies

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.

Declaration

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

Property Value

Type	Description
IList<string>

SourceImage

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

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. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Declaration

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

Property Value

Type	Description
CustomerEncryptionKey

SourceInstantSnapshot

The source instant-snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceInstantSnapshot 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: us-central1-a/instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set.

Declaration

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

Property Value

Type	Description
string

SourceSnapshot

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.

Declaration

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

Property Value

Type	Description
string

SourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot.

Declaration

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

Property Value

Type	Description
CustomerEncryptionKey

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

Implements

IDirectResponseSchema