Share via

VirtualMachineImageTemplates interface

  • Reference
Package:
@azure/arm-imagebuilder

Interface representing a VirtualMachineImageTemplates.

Methods

beginCancel(string, string, VirtualMachineImageTemplatesCancelOptionalParams)

Cancel the long running image build based on the image template
beginCancelAndWait(string, string, VirtualMachineImageTemplatesCancelOptionalParams)

Cancel the long running image build based on the image template
beginCreateOrUpdate(string, string, ImageTemplate, VirtualMachineImageTemplatesCreateOrUpdateOptionalParams)

Create or update a virtual machine image template
beginCreateOrUpdateAndWait(string, string, ImageTemplate, VirtualMachineImageTemplatesCreateOrUpdateOptionalParams)

Create or update a virtual machine image template
beginDelete(string, string, VirtualMachineImageTemplatesDeleteOptionalParams)

Delete a virtual machine image template
beginDeleteAndWait(string, string, VirtualMachineImageTemplatesDeleteOptionalParams)

Delete a virtual machine image template
beginRun(string, string, VirtualMachineImageTemplatesRunOptionalParams)

Create artifacts from a existing image template
beginRunAndWait(string, string, VirtualMachineImageTemplatesRunOptionalParams)

Create artifacts from a existing image template
beginUpdate(string, string, ImageTemplateUpdateParameters, VirtualMachineImageTemplatesUpdateOptionalParams)

Update the tags for this Virtual Machine Image Template
beginUpdateAndWait(string, string, ImageTemplateUpdateParameters, VirtualMachineImageTemplatesUpdateOptionalParams)

Update the tags for this Virtual Machine Image Template
get(string, string, VirtualMachineImageTemplatesGetOptionalParams)

Get information about a virtual machine image template
getRunOutput(string, string, string, VirtualMachineImageTemplatesGetRunOutputOptionalParams)

Get the specified run output for the specified image template resource
list(VirtualMachineImageTemplatesListOptionalParams)

Gets information about the VM image templates associated with the subscription.
listByResourceGroup(string, VirtualMachineImageTemplatesListByResourceGroupOptionalParams)

Gets information about the VM image templates associated with the specified resource group.
listRunOutputs(string, string, VirtualMachineImageTemplatesListRunOutputsOptionalParams)

List all run outputs for the specified Image Template resource

Method Details

beginCancel(string, string, VirtualMachineImageTemplatesCancelOptionalParams)

Cancel the long running image build based on the image template

function beginCancel(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesCancelOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesCancelOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginCancelAndWait(string, string, VirtualMachineImageTemplatesCancelOptionalParams)

Cancel the long running image build based on the image template

function beginCancelAndWait(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesCancelOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesCancelOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, ImageTemplate, VirtualMachineImageTemplatesCreateOrUpdateOptionalParams)

Create or update a virtual machine image template

function beginCreateOrUpdate(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplate, options?: VirtualMachineImageTemplatesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ImageTemplate>, ImageTemplate>>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

parameters
ImageTemplate

Parameters supplied to the CreateImageTemplate operation

options
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ImageTemplate>, ImageTemplate>>

beginCreateOrUpdateAndWait(string, string, ImageTemplate, VirtualMachineImageTemplatesCreateOrUpdateOptionalParams)

Create or update a virtual machine image template

function beginCreateOrUpdateAndWait(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplate, options?: VirtualMachineImageTemplatesCreateOrUpdateOptionalParams): Promise<ImageTemplate>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

parameters
ImageTemplate

Parameters supplied to the CreateImageTemplate operation

options
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ImageTemplate>

beginDelete(string, string, VirtualMachineImageTemplatesDeleteOptionalParams)

Delete a virtual machine image template

function beginDelete(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineImageTemplatesDeleteHeaders>, VirtualMachineImageTemplatesDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualMachineImageTemplatesDeleteHeaders>, VirtualMachineImageTemplatesDeleteHeaders>>

beginDeleteAndWait(string, string, VirtualMachineImageTemplatesDeleteOptionalParams)

Delete a virtual machine image template

function beginDeleteAndWait(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams): Promise<VirtualMachineImageTemplatesDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesDeleteOptionalParams

The options parameters.

Returns

Promise<VirtualMachineImageTemplatesDeleteHeaders>

beginRun(string, string, VirtualMachineImageTemplatesRunOptionalParams)

Create artifacts from a existing image template

function beginRun(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesRunOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesRunOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRunAndWait(string, string, VirtualMachineImageTemplatesRunOptionalParams)

Create artifacts from a existing image template

function beginRunAndWait(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesRunOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesRunOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ImageTemplateUpdateParameters, VirtualMachineImageTemplatesUpdateOptionalParams)

Update the tags for this Virtual Machine Image Template

function beginUpdate(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplateUpdateParameters, options?: VirtualMachineImageTemplatesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ImageTemplate>, ImageTemplate>>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

parameters
ImageTemplateUpdateParameters

Additional parameters for Image Template update.

options
VirtualMachineImageTemplatesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ImageTemplate>, ImageTemplate>>

beginUpdateAndWait(string, string, ImageTemplateUpdateParameters, VirtualMachineImageTemplatesUpdateOptionalParams)

Update the tags for this Virtual Machine Image Template

function beginUpdateAndWait(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplateUpdateParameters, options?: VirtualMachineImageTemplatesUpdateOptionalParams): Promise<ImageTemplate>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

parameters
ImageTemplateUpdateParameters

Additional parameters for Image Template update.

options
VirtualMachineImageTemplatesUpdateOptionalParams

The options parameters.

Returns

Promise<ImageTemplate>

get(string, string, VirtualMachineImageTemplatesGetOptionalParams)

Get information about a virtual machine image template

function get(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesGetOptionalParams): Promise<ImageTemplate>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesGetOptionalParams

The options parameters.

Returns

Promise<ImageTemplate>

getRunOutput(string, string, string, VirtualMachineImageTemplatesGetRunOutputOptionalParams)

Get the specified run output for the specified image template resource

function getRunOutput(resourceGroupName: string, imageTemplateName: string, runOutputName: string, options?: VirtualMachineImageTemplatesGetRunOutputOptionalParams): Promise<RunOutput>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

runOutputName

string

The name of the run output

options
VirtualMachineImageTemplatesGetRunOutputOptionalParams

The options parameters.

Returns

Promise<RunOutput>

list(VirtualMachineImageTemplatesListOptionalParams)

Gets information about the VM image templates associated with the subscription.

function list(options?: VirtualMachineImageTemplatesListOptionalParams): PagedAsyncIterableIterator<ImageTemplate, ImageTemplate[], PageSettings>

Parameters

options
VirtualMachineImageTemplatesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ImageTemplate, ImageTemplate[], PageSettings>

listByResourceGroup(string, VirtualMachineImageTemplatesListByResourceGroupOptionalParams)

Gets information about the VM image templates associated with the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: VirtualMachineImageTemplatesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ImageTemplate, ImageTemplate[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options
VirtualMachineImageTemplatesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ImageTemplate, ImageTemplate[], PageSettings>

listRunOutputs(string, string, VirtualMachineImageTemplatesListRunOutputsOptionalParams)

List all run outputs for the specified Image Template resource

function listRunOutputs(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesListRunOutputsOptionalParams): PagedAsyncIterableIterator<RunOutput, RunOutput[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

imageTemplateName

string

The name of the image Template

options
VirtualMachineImageTemplatesListRunOutputsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RunOutput, RunOutput[], PageSettings>