Package-level declarations

Types

Link copied to clipboard
data class DistributeVersionerLatestResponse(val major: Int? = null, val scheme: String)

Generates version number that will be latest based on existing version numbers.

Link copied to clipboard

Generates version number based on version number of source image

Link copied to clipboard
data class GetTriggerResult(val azureApiVersion: String, val id: String, val kind: String, val name: String, val provisioningState: String, val status: TriggerStatusResponse, val systemData: SystemDataResponse, val type: String)

Represents a trigger that can invoke an image template build.

Link copied to clipboard
data class GetVirtualMachineImageTemplateResult(val autoRun: ImageTemplateAutoRunResponse? = null, val azureApiVersion: String, val buildTimeoutInMinutes: Int? = null, val customize: List<Any>? = null, val distribute: List<Any>, val errorHandling: ImageTemplatePropertiesResponseErrorHandling? = null, val exactStagingResourceGroup: String, val id: String, val identity: ImageTemplateIdentityResponse, val lastRunStatus: ImageTemplateLastRunStatusResponse, val location: String, val managedResourceTags: Map<String, String>? = null, val name: String, val optimize: ImageTemplatePropertiesResponseOptimize? = null, val provisioningError: ProvisioningErrorResponse, val provisioningState: String, val source: Any, val stagingResourceGroup: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val validate: ImageTemplatePropertiesResponseValidate? = null, val vmProfile: ImageTemplateVmProfileResponse? = null)

Image template is an ARM resource managed by Microsoft.VirtualMachineImages provider

Link copied to clipboard
data class ImageTemplateAutoRunResponse(val state: String? = null)

Indicates if the image template needs to be built on create/update

Link copied to clipboard
data class ImageTemplateFileCustomizerResponse(val destination: String? = null, val name: String? = null, val sha256Checksum: String? = null, val sourceUri: String? = null, val type: String)

Uploads files to VMs (Linux, Windows). Corresponds to Packer file provisioner

Link copied to clipboard
data class ImageTemplateFileValidatorResponse(val destination: String? = null, val name: String? = null, val sha256Checksum: String? = null, val sourceUri: String? = null, val type: String)

Uploads files required for validation to VMs (Linux, Windows). Corresponds to Packer file provisioner

Link copied to clipboard
data class ImageTemplateIdentityResponse(val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Identity for the image template.

Link copied to clipboard
data class ImageTemplateLastRunStatusResponse(val endTime: String? = null, val message: String? = null, val runState: String? = null, val runSubState: String? = null, val startTime: String? = null)

Describes the latest status of running an image template

data class ImageTemplateManagedImageDistributorResponse(val artifactTags: Map<String, String>? = null, val imageId: String, val location: String, val runOutputName: String, val type: String)

Distribute as a Managed Disk Image.

Link copied to clipboard
data class ImageTemplateManagedImageSourceResponse(val imageId: String, val type: String)

Describes an image source that is a managed image in customer subscription. This image must reside in the same subscription and region as the Image Builder template.

Link copied to clipboard
data class ImageTemplatePlatformImageSourceResponse(val exactVersion: String, val offer: String? = null, val planInfo: PlatformImagePurchasePlanResponse? = null, val publisher: String? = null, val sku: String? = null, val type: String, val version: String? = null)

Describes an image source from Azure Gallery Images.

data class ImageTemplatePowerShellCustomizerResponse(val inline: List<String>? = null, val name: String? = null, val runAsSystem: Boolean? = null, val runElevated: Boolean? = null, val scriptUri: String? = null, val sha256Checksum: String? = null, val type: String, val validExitCodes: List<Int>? = null)

Runs the specified PowerShell on the VM (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.

Link copied to clipboard
data class ImageTemplatePowerShellValidatorResponse(val inline: List<String>? = null, val name: String? = null, val runAsSystem: Boolean? = null, val runElevated: Boolean? = null, val scriptUri: String? = null, val sha256Checksum: String? = null, val type: String, val validExitCodes: List<Int>? = null)

Runs the specified PowerShell script during the validation phase (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.

data class ImageTemplatePropertiesResponseErrorHandling(val onCustomizerError: String? = null, val onValidationError: String? = null)

Error handling options upon a build failure

Link copied to clipboard

Specifies optimization to be performed on image.

Link copied to clipboard
data class ImageTemplatePropertiesResponseValidate(val continueDistributeOnFailure: Boolean? = null, val inVMValidations: List<Any>? = null, val sourceValidationOnly: Boolean? = null)

Configuration options and list of validations to be performed on the resulting image.

Link copied to clipboard
data class ImageTemplatePropertiesResponseVmBoot(val state: String? = null)

Optimization is applied on the image for a faster VM boot.

Link copied to clipboard
data class ImageTemplateRestartCustomizerResponse(val name: String? = null, val restartCheckCommand: String? = null, val restartCommand: String? = null, val restartTimeout: String? = null, val type: String)

Reboots a VM and waits for it to come back online (Windows). Corresponds to Packer windows-restart provisioner

data class ImageTemplateSharedImageDistributorResponse(val artifactTags: Map<String, String>? = null, val excludeFromLatest: Boolean? = null, val galleryImageId: String, val replicationRegions: List<String>? = null, val runOutputName: String, val storageAccountType: String? = null, val targetRegions: List<TargetRegionResponse>? = null, val type: String, val versioning: Either<DistributeVersionerLatestResponse, DistributeVersionerSourceResponse>? = null)

Distribute via Azure Compute Gallery.

data class ImageTemplateSharedImageVersionSourceResponse(val exactVersion: String, val imageVersionId: String, val type: String)

Describes an image source that is an image version in an Azure Compute Gallery or a Direct Shared Gallery.

Link copied to clipboard
data class ImageTemplateShellCustomizerResponse(val inline: List<String>? = null, val name: String? = null, val scriptUri: String? = null, val sha256Checksum: String? = null, val type: String)

Runs a shell script during the customization phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.

Link copied to clipboard
data class ImageTemplateShellValidatorResponse(val inline: List<String>? = null, val name: String? = null, val scriptUri: String? = null, val sha256Checksum: String? = null, val type: String)

Runs the specified shell script during the validation phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.

Link copied to clipboard
data class ImageTemplateVhdDistributorResponse(val artifactTags: Map<String, String>? = null, val runOutputName: String, val type: String, val uri: String? = null)

Distribute via VHD in a storage account.

Link copied to clipboard
data class ImageTemplateVmProfileResponse(val osDiskSizeGB: Int? = null, val userAssignedIdentities: List<String>? = null, val vmSize: String? = null, val vnetConfig: VirtualNetworkConfigResponse? = null)

Describes the virtual machines used to build and validate images

data class ImageTemplateWindowsUpdateCustomizerResponse(val filters: List<String>? = null, val name: String? = null, val searchCriteria: String? = null, val type: String, val updateLimit: Int? = null)

Installs Windows Updates. Corresponds to Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Link copied to clipboard
data class PlatformImagePurchasePlanResponse(val planName: String, val planProduct: String, val planPublisher: String)

Purchase plan configuration for platform image.

Link copied to clipboard
data class ProvisioningErrorResponse(val message: String? = null, val provisioningErrorCode: String? = null)

Describes the error happened when create or update an image template

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TargetRegionResponse(val name: String, val replicaCount: Int? = null, val storageAccountType: String? = null)

Describes the target region information.

Link copied to clipboard
data class TriggerStatusResponse(val code: String, val message: String, val time: String)

Describes the status of a trigger

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VirtualNetworkConfigResponse(val containerInstanceSubnetId: String? = null, val proxyVmSize: String? = null, val subnetId: String? = null)

Virtual Network configuration.