IImageTemplate Interface

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models

Assembly:: Az.ImageBuilder.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.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.ImageTemplateTypeConverter))]
public interface IImageTemplate : Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.ITrackedResource

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.ImageTemplateTypeConverter))>]
type IImageTemplate = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource

Public Interface IImageTemplate
Implements ITrackedResource

Derived: Microsoft.Azure.PowerShell.Cmdlets.ImageBuilder.Models.ImageTemplate

Attributes: TypeConverterAttribute

Implements: IResource ITrackedResource IJsonSerializable

Properties

Name	Description
BuildTimeoutInMinute	Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours).
Customize	Specifies the properties used to describe the customization steps of the image, like Image source etc
Distribute	The distribution targets where the image output needs to go to.
ExactStagingResourceGroup	The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty.
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} (Inherited from IResource)
IdentityType	The type of identity used for the image template. The type 'None' will remove any identities from the image template.
IdentityUserAssignedIdentity	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
LastRunStatusEndTime	End time of the last run (UTC)
LastRunStatusMessage	Verbose information about the last run state
LastRunStatusRunState	State of the last run
LastRunStatusRunSubState	Sub-state of the last run
LastRunStatusStartTime	Start time of the last run (UTC)
Location	The geo-location where the resource lives (Inherited from ITrackedResource)
Name	The name of the resource (Inherited from IResource)
ProvisioningErrorCode	Error code of the provisioning failure
ProvisioningErrorMessage	Verbose error message about the provisioning failure
ProvisioningState	Provisioning state of the resource
Source	Specifies the properties used to describe the source image.
StagingResourceGroup	The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain.
SystemDataCreatedAt	The timestamp of resource creation (UTC). (Inherited from IResource)
SystemDataCreatedBy	The identity that created the resource. (Inherited from IResource)
SystemDataCreatedByType	The type of identity that created the resource. (Inherited from IResource)
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC) (Inherited from IResource)
SystemDataLastModifiedBy	The identity that last modified the resource. (Inherited from IResource)
SystemDataLastModifiedByType	The type of identity that last modified the resource. (Inherited from IResource)
Tag	Resource tags. (Inherited from ITrackedResource)
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource)
ValidateContinueDistributeOnFailure	If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.]
ValidateInVMValidation	List of validations to be performed.
ValidateSourceValidationOnly	If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image.
VMBootState	Enabling this field will improve VM boot time by optimizing the final customized image output.
VMProfileOsdiskSizeGb	Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size.
VMProfileUserAssignedIdentity	Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template.
VMProfileVmsize	Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images).
VnetConfigProxyVMSize	Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. Omit or specify empty string to use the default (Standard_A1_v2).
VnetConfigSubnetId	Resource id of a pre-existing subnet.

Methods

Name	Description
ToJson(JsonObject, SerializationMode)	(Inherited from IJsonSerializable)

Applies to