@azure/arm-imagebuilder package
Classes
ImageBuilderClient |
Interfaces
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. (This also follows the OData error response format.). |
ImageBuilderClientOptionalParams |
Optional parameters. |
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 |
ImageTemplateListResult |
The result of List image templates operation |
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. |
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. |
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. |
OperationListResult |
Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results. |
Operations |
Interface representing a Operations. |
OperationsListNextOptionalParams |
Optional parameters. |
OperationsListOptionalParams |
Optional parameters. |
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 |
RunOutput |
Represents an output that was created by running an image template. |
RunOutputCollection |
The result of List run outputs 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. |
TriggerCollection |
The result of List triggers operation |
TriggerProperties |
Describes the properties of a trigger |
TriggerStatus |
Describes the status of a trigger |
Triggers |
Interface representing a Triggers. |
TriggersCreateOrUpdateOptionalParams |
Optional parameters. |
TriggersDeleteHeaders |
Defines headers for Triggers_delete operation. |
TriggersDeleteOptionalParams |
Optional parameters. |
TriggersGetOptionalParams |
Optional parameters. |
TriggersListByImageTemplateNextOptionalParams |
Optional parameters. |
TriggersListByImageTemplateOptionalParams |
Optional parameters. |
UserAssignedIdentity |
User assigned identity properties |
VirtualMachineImageTemplates |
Interface representing a VirtualMachineImageTemplates. |
VirtualMachineImageTemplatesCancelOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesDeleteHeaders |
Defines headers for VirtualMachineImageTemplates_delete operation. |
VirtualMachineImageTemplatesDeleteOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesGetOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesGetRunOutputOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesListNextOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesListOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesListRunOutputsNextOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesListRunOutputsOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesRunOptionalParams |
Optional parameters. |
VirtualMachineImageTemplatesUpdateOptionalParams |
Optional parameters. |
VirtualNetworkConfig |
Virtual Network configuration. |
Type Aliases
AutoRunState |
Defines values for AutoRunState. |
CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
DistributeVersionerUnion | |
ImageTemplateCustomizerUnion | |
ImageTemplateDistributorUnion | |
ImageTemplateInVMValidatorUnion | |
ImageTemplateSourceUnion | |
OnBuildError |
Defines values for OnBuildError. Known values supported by the servicecleanup |
OperationsListNextResponse |
Contains response data for the listNext operation. |
OperationsListResponse |
Contains response data for the list operation. |
ProvisioningErrorCode |
Defines values for ProvisioningErrorCode. Known values supported by the serviceBadSourceType |
ProvisioningState |
Defines values for ProvisioningState. |
ResourceIdentityType |
Defines values for ResourceIdentityType. |
RunState |
Defines values for RunState. |
RunSubState |
Defines values for RunSubState. |
SharedImageStorageAccountType |
Defines values for SharedImageStorageAccountType. Known values supported by the serviceStandard_LRS |
TriggerPropertiesUnion | |
TriggersCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
TriggersDeleteResponse |
Contains response data for the delete operation. |
TriggersGetResponse |
Contains response data for the get operation. |
TriggersListByImageTemplateNextResponse |
Contains response data for the listByImageTemplateNext operation. |
TriggersListByImageTemplateResponse |
Contains response data for the listByImageTemplate operation. |
VMBootOptimizationState |
Defines values for VMBootOptimizationState. |
VirtualMachineImageTemplatesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
VirtualMachineImageTemplatesDeleteResponse |
Contains response data for the delete operation. |
VirtualMachineImageTemplatesGetResponse |
Contains response data for the get operation. |
VirtualMachineImageTemplatesGetRunOutputResponse |
Contains response data for the getRunOutput operation. |
VirtualMachineImageTemplatesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
VirtualMachineImageTemplatesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
VirtualMachineImageTemplatesListNextResponse |
Contains response data for the listNext operation. |
VirtualMachineImageTemplatesListResponse |
Contains response data for the list operation. |
VirtualMachineImageTemplatesListRunOutputsNextResponse |
Contains response data for the listRunOutputsNext operation. |
VirtualMachineImageTemplatesListRunOutputsResponse |
Contains response data for the listRunOutputs operation. |
VirtualMachineImageTemplatesUpdateResponse |
Contains response data for the update operation. |
Enums
KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
KnownOnBuildError |
Known values of OnBuildError that the service accepts. |
KnownProvisioningErrorCode |
Known values of ProvisioningErrorCode that the service accepts. |
KnownSharedImageStorageAccountType |
Known values of SharedImageStorageAccountType that the service accepts. |
Functions
get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value
produced by the byPage
iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value
on the IteratorResult from a byPage
iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.