@azure/arm-imagebuilder package

Classes

Interfaces

DataDisk	Data disk properties.
DistributeVersioner	Describes how to generate new x.y.z version number for distribution.
DistributeVersionerLatest	Generates version number that will be latest based on existing version numbers.
DistributeVersionerSource	Generates version number based on version number of source image
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ImageBuilderClientOptionalParams	Optional parameters for the client.
ImageTemplate	Image template is an ARM resource managed by Microsoft.VirtualMachineImages provider
ImageTemplateAutoRun	Indicates if the image template needs to be built on create/update
ImageTemplateCustomizer	Describes a unit of image customization
ImageTemplateDistributor	Generic distribution object
ImageTemplateFileCustomizer	Uploads files to VMs (Linux, Windows). Corresponds to Packer file provisioner
ImageTemplateFileValidator	Uploads files required for validation to VMs (Linux, Windows). Corresponds to Packer file provisioner
ImageTemplateIdentity	Identity for the image template.
ImageTemplateInVMValidator	Describes a unit of in-VM validation of image
ImageTemplateLastRunStatus	Describes the latest status of running an image template
ImageTemplateManagedImageDistributor	Distribute as a Managed Disk Image.
ImageTemplateManagedImageSource	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.
ImageTemplatePlatformImageSource	Describes an image source from Azure Gallery Images.
ImageTemplatePowerShellCustomizer	Runs the specified PowerShell on the VM (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
ImageTemplatePowerShellValidator	Runs the specified PowerShell script during the validation phase (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
ImageTemplateProperties	Describes the properties of an image template
ImageTemplatePropertiesErrorHandling	Error handling options upon a build failure
ImageTemplatePropertiesOptimize	Specifies optimization to be performed on image.
ImageTemplatePropertiesOptimizeVmBoot	Optimization is applied on the image for a faster VM boot.
ImageTemplatePropertiesOptimizeWorkload	Optimization is applied on the image for specific workloads.
ImageTemplatePropertiesValidate	Configuration options and list of validations to be performed on the resulting image.
ImageTemplateRestartCustomizer	Reboots a VM and waits for it to come back online (Windows). Corresponds to Packer windows-restart provisioner
ImageTemplateSharedImageDistributor	Distribute via Azure Compute Gallery.
ImageTemplateSharedImageVersionSource	Describes an image source that is an image version in an Azure Compute Gallery or a Direct Shared Gallery.
ImageTemplateShellCustomizer	Runs a shell script during the customization phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
ImageTemplateShellValidator	Runs the specified shell script during the validation phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.
ImageTemplateSource	Describes a virtual machine image source for building, customizing and distributing
ImageTemplateUpdateParameters	Parameters for updating an image template.
ImageTemplateUpdateParametersProperties	Parameters for updating an image template.
ImageTemplateVhdDistributor	Distribute via VHD in a storage account.
ImageTemplateVmProfile	Describes the virtual machines used to build and validate images
ImageTemplateWindowsUpdateCustomizer	Installs Windows Updates. Corresponds to Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)
Operation	A REST API operation
OperationDisplay	The object that describes the operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlatformImagePurchasePlan	Purchase plan configuration for platform image.
ProvisioningError	Describes the error happened when create or update an image template
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RunOutput	Represents an output that was created by running an image template.
RunOutputProperties	Describes the properties of a run output
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SourceImageTriggerProperties	Properties of SourceImage kind of trigger
SystemData	Metadata pertaining to creation and last modification of the resource.
TargetRegion	Describes the target region information.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
Trigger	Represents a trigger that can invoke an image template build.
TriggerProperties	Describes the properties of a trigger
TriggerStatus	Describes the status of a trigger
TriggersCreateOrUpdateOptionalParams	Optional parameters.
TriggersDeleteOptionalParams	Optional parameters.
TriggersGetOptionalParams	Optional parameters.
TriggersListByImageTemplateOptionalParams	Optional parameters.
TriggersOperations	Interface representing a Triggers operations.
UserAssignedIdentity	User assigned identity properties
VirtualMachineImageTemplatesCancelOptionalParams	Optional parameters.
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams	Optional parameters.
VirtualMachineImageTemplatesDeleteOptionalParams	Optional parameters.
VirtualMachineImageTemplatesGetOptionalParams	Optional parameters.
VirtualMachineImageTemplatesGetRunOutputOptionalParams	Optional parameters.
VirtualMachineImageTemplatesListByResourceGroupOptionalParams	Optional parameters.
VirtualMachineImageTemplatesListOptionalParams	Optional parameters.
VirtualMachineImageTemplatesListRunOutputsOptionalParams	Optional parameters.
VirtualMachineImageTemplatesOperations	Interface representing a VirtualMachineImageTemplates operations.
VirtualMachineImageTemplatesRunOptionalParams	Optional parameters.
VirtualMachineImageTemplatesUpdateOptionalParams	Optional parameters.
VirtualNetworkConfig	Virtual Network configuration.

Type Aliases

AutoRunState	Enabling this field will trigger an automatic build on image template creation or update.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DistributeVersionerUnion	Alias for DistributeVersionerUnion
ImageTemplateCustomizerUnion	Alias for ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion	Alias for ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion	Alias for ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion	Alias for ImageTemplateSourceUnion
OnBuildError	Error handling behavior upon build failure KnownOnBuildError can be used interchangeably with OnBuildError, this enum contains the known values that the service supports. Known values supported by the service cleanup: cleanup abort: abort
ProvisioningErrorCode	Error code of the provisioning failure KnownProvisioningErrorCode can be used interchangeably with ProvisioningErrorCode, this enum contains the known values that the service supports. Known values supported by the service BadSourceType: BadSourceType BadPIRSource: BadPIRSource BadManagedImageSource: BadManagedImageSource BadSharedImageVersionSource: BadSharedImageVersionSource BadCustomizerType: BadCustomizerType UnsupportedCustomizerType: UnsupportedCustomizerType NoCustomizerScript: NoCustomizerScript BadValidatorType: BadValidatorType UnsupportedValidatorType: UnsupportedValidatorType NoValidatorScript: NoValidatorScript BadDistributeType: BadDistributeType BadSharedImageDistribute: BadSharedImageDistribute BadStagingResourceGroup: BadStagingResourceGroup ServerError: ServerError Other: Other
ProvisioningState	Provisioning state of the resource
ReplicationMode	Describes replication mode for distribution in Azure Compute Gallery. Omit to use the default (Full). KnownReplicationMode can be used interchangeably with ReplicationMode, this enum contains the known values that the service supports. Known values supported by the service Full: Full replication mode Shallow: Shallow replication mode
ResourceIdentityType	The type of identity used for the image template. The type 'None' will remove any identities from the image template.
RunState	State of the last run
RunSubState	Sub-state of the last run
SharedImageStorageAccountType	Specifies the storage account type to be used to store the Azure Compute Gallery image version in. KnownSharedImageStorageAccountType can be used interchangeably with SharedImageStorageAccountType, this enum contains the known values that the service supports. Known values supported by the service Standard_LRS: Standard_LRS Standard_ZRS: Standard_ZRS Premium_LRS: Premium_LRS
TriggerPropertiesUnion	Alias for TriggerPropertiesUnion
VMBootOptimizationState	Enabling this field will improve VM boot time by optimizing the final customized image output.
WorkloadOptimizationState	Enabling this field will optimize vm images for specific workloads.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownOnBuildError	Error handling behavior upon build failure
KnownProvisioningErrorCode	Error code of the provisioning failure
KnownReplicationMode	Describes replication mode for distribution in Azure Compute Gallery. Omit to use the default (Full).
KnownSharedImageStorageAccountType	Specifies the storage account type to be used to store the Azure Compute Gallery image version in.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: ImageBuilderClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-imagebuilder package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type