Package version:

Interface CreationData

Data used when creating a disk.

interface CreationData {
    createOption: string;
    elasticSanResourceId?: string;
    galleryImageReference?: ImageDiskReference;
    imageReference?: ImageDiskReference;
    logicalSectorSize?: number;
    performancePlus?: boolean;
    provisionedBandwidthCopySpeed?: string;
    securityDataUri?: string;
    sourceResourceId?: string;
    sourceUniqueId?: string;
    sourceUri?: string;
    storageAccountId?: string;
    uploadSizeBytes?: number;
}

Properties

createOption elasticSanResourceId? galleryImageReference? imageReference? logicalSectorSize? performancePlus? provisionedBandwidthCopySpeed? securityDataUri? sourceResourceId? sourceUniqueId? sourceUri? storageAccountId? uploadSizeBytes?

Properties

createOption

createOption: string

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

OptionalelasticSanResourceId

elasticSanResourceId?: string

Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.

OptionalgalleryImageReference

galleryImageReference?: ImageDiskReference

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.

OptionalimageReference

imageReference?: ImageDiskReference

Disk source information for PIR or user images.

OptionallogicalSectorSize

logicalSectorSize?: number

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

OptionalperformancePlus

performancePlus?: boolean

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.

OptionalprovisionedBandwidthCopySpeed

provisionedBandwidthCopySpeed?: string

If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.

OptionalsecurityDataUri

securityDataUri?: string

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

OptionalsourceResourceId

sourceResourceId?: string

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

Optional ReadonlysourceUniqueId

sourceUniqueId?: string

If this field is set, this is the unique id identifying the source of this resource. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalsourceUri

sourceUri?: string

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

OptionalstorageAccountId

storageAccountId?: string

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

OptionaluploadSizeBytes

uploadSizeBytes?: number

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

Settings

Member Visibility