CreationData interface

Package:

@azure-rest/arm-compute

Data used when creating a disk.

Properties

createOption	This enumerates the possible sources of a disk's creation.
galleryImageReference	Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
imageReference	Disk source information for PIR or user images.
logicalSectorSize	Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
performancePlus	Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
securityDataUri	If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
sourceResourceId	If createOption is Copy, this is the ARM id of the source snapshot or disk.
sourceUri	If createOption is Import, this is the URI of a blob to be imported into a managed disk.
storageAccountId	Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
uploadSizeBytes	If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).

Property Details

createOption

This enumerates the possible sources of a disk's creation.

createOption: "FromImage" | "Empty" | "Attach" | "Import" | "Copy" | "Restore" | "Upload" | "CopyStart" | "ImportSecure" | "UploadPreparedSecure"

Property Value

"FromImage" | "Empty" | "Attach" | "Import" | "Copy" | "Restore" | "Upload" | "CopyStart" | "ImportSecure" | "UploadPreparedSecure"

galleryImageReference

Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.

galleryImageReference?: ImageDiskReference

Property Value

ImageDiskReference

imageReference

Disk source information for PIR or user images.

imageReference?: ImageDiskReference

Property Value

ImageDiskReference

logicalSectorSize

Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.

logicalSectorSize?: number

Property Value

number

performancePlus

Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.

performancePlus?: boolean

Property Value

boolean

securityDataUri

If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.

securityDataUri?: string

Property Value

string

sourceResourceId

If createOption is Copy, this is the ARM id of the source snapshot or disk.

sourceResourceId?: string

Property Value

string

sourceUri

If createOption is Import, this is the URI of a blob to be imported into a managed disk.

sourceUri?: string

Property Value

string

storageAccountId

Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.

storageAccountId?: string

Property Value

string

uploadSizeBytes

If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).

uploadSizeBytes?: number

Property Value

number