Share via

CustomImage interface

Package:
@azure/arm-devtestlabs

A custom image.

Extends
Resource

Properties

author

The author of the custom image.
creationDate

The creation date of the custom image. NOTE: This property will not be serialized. It can only be populated by the server.
customImagePlan

Storage information about the plan related to this custom image
dataDiskStorageInfo

Storage information about the data disks present in the custom image
description

The description of the custom image.
isPlanAuthorized

Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment
managedImageId

The Managed Image Id backing the custom image.
managedSnapshotId

The Managed Snapshot Id backing the custom image.
provisioningState

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.
vhd

The VHD from which the image is to be created.
vm

The virtual machine from which the image is to be created.

Inherited Properties

id

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
location

The location of the resource.
name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags

The tags of the resource.
type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

author

The author of the custom image.

author?: string

Property Value

string

creationDate

The creation date of the custom image. NOTE: This property will not be serialized. It can only be populated by the server.

creationDate?: Date

Property Value

Date

customImagePlan

Storage information about the plan related to this custom image

customImagePlan?: CustomImagePropertiesFromPlan

Property Value

CustomImagePropertiesFromPlan

dataDiskStorageInfo

Storage information about the data disks present in the custom image

dataDiskStorageInfo?: DataDiskStorageTypeInfo[]

Property Value

DataDiskStorageTypeInfo[]

description

The description of the custom image.

description?: string

Property Value

string

isPlanAuthorized

Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment

isPlanAuthorized?: boolean

Property Value

boolean

managedImageId

The Managed Image Id backing the custom image.

managedImageId?: string

Property Value

string

managedSnapshotId

The Managed Snapshot Id backing the custom image.

managedSnapshotId?: string

Property Value

string

provisioningState

The provisioning status of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

uniqueIdentifier

The unique immutable identifier of a resource (Guid). NOTE: This property will not be serialized. It can only be populated by the server.

uniqueIdentifier?: string

Property Value

string

vhd

The VHD from which the image is to be created.

vhd?: CustomImagePropertiesCustom

Property Value

CustomImagePropertiesCustom

vm

The virtual machine from which the image is to be created.

vm?: CustomImagePropertiesFromVm

Property Value

CustomImagePropertiesFromVm

Inherited Property Details

id

The identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

The location of the resource.

location?: string

Property Value

string

Inherited From Resource.location

name

The name of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

The tags of the resource.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

The type of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type