ImageDefinition Class

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview

Assembly:: Az.DevCenter.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a definition for an Image.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.ImageDefinitionTypeConverter))]
public class ImageDefinition : Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IImageDefinition, Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.ImageDefinitionTypeConverter))>]
type ImageDefinition = class
    interface IImageDefinition
    interface IJsonSerializable
    interface IResource
    interface IValidates

Public Class ImageDefinition
Implements IImageDefinition, IValidates

Inheritance: Object
ImageDefinition

Attributes: TypeConverterAttribute

Implements: IImageDefinition IResource IJsonSerializable IValidates

Constructors

Name	Description
ImageDefinition()	Creates an new ImageDefinition instance.

Properties

Name	Description
ActiveImageReferenceExactVersion	The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.
ActiveImageReferenceId	Image ID, or Image version ID. When Image ID is provided, its latest version will be used.
AutoImageBuild	Indicates if automatic image builds will be triggered for image definition updates
ExtendImageDefinition	Name of the referenced Image Definition.
ExtendParameter	Parameters for the referenced Image Definition.
FileUrl	The URL to the repository file containing the image definition.
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
ImageReferenceExactVersion	The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.
ImageReferenceId	Image ID, or Image version ID. When Image ID is provided, its latest version will be used.
ImageValidationErrorDetailCode	An identifier for the error.
ImageValidationErrorDetailMessage	A message describing the error.
ImageValidationStatus	Validation status of the configured image.
LatestBuildEndTime	End time of the task group.
LatestBuildName	Identifier of a build.
LatestBuildStartTime	Start time of the task group.
LatestBuildStatus	The state of an Image Definition Build.
Name	The name of the resource
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Task	Tasks to run at Dev Box provisioning time.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UserTask	Tasks to run when a user first logs into a Dev Box.
ValidationStatus	Validation status for the Image Definition.

Methods

Name	Description
DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of ImageDefinition.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of ImageDefinition.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DevCenter.Models.Api20250401Preview.IImageDefinition.
FromJsonString(String)	Creates a new instance of ImageDefinition, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of ImageDefinition into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to