Show / Hide Table of Contents

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 property is mutually exclusive with the source property; you can only define one or the other, but not both.

Inheritance
System.Object
AttachedDiskInitializeParams
Implements
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Compute.v1.Data
Assembly: Google.Apis.Compute.v1.dll
Syntax
public class AttachedDiskInitializeParams : IDirectResponseSchema

Properties

Description

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

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
System.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
System.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
System.Nullable<System.Int64>

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 define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Declaration
[JsonProperty("diskType")]
public virtual string DiskType { get; set; }
Property Value
Type Description
System.String

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.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
System.Collections.Generic.IDictionary<System.String, System.String>

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
System.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
System.Nullable<System.Int64>

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
System.Collections.Generic.IList<System.String>

SourceImage

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. 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
System.String

SourceImageEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates 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

SourceSnapshot

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. 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.

Declaration
[JsonProperty("sourceSnapshot")]
public virtual string SourceSnapshot { get; set; }
Property Value
Type Description
System.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

Implements

IDirectResponseSchema
In This Article
Back to top