VirtualMachineImageTemplatesOperations interface

Package:

@azure/arm-imagebuilder

Interface representing a VirtualMachineImageTemplates operations.

Properties

beginCancel
beginCancelAndWait
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRun
beginRunAndWait
beginUpdate
beginUpdateAndWait
cancel	Cancel the long running image build based on the image template
createOrUpdate	Create or update a virtual machine image template
delete	Delete a virtual machine image template
get	Get information about a virtual machine image template
getRunOutput	Get the specified run output for the specified image template resource
list	Gets information about the VM image templates associated with the subscription.
listByResourceGroup	Gets information about the VM image templates associated with the specified resource group.
listRunOutputs	List all run outputs for the specified Image Template resource
run	Create artifacts from a existing image template
update	Update the tags for this Virtual Machine Image Template

Property Details

beginCancel

Warning

This API is now deprecated.

use cancel instead

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

Property Value

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

beginCancelAndWait

Warning

This API is now deprecated.

use cancel instead

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

Property Value

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

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams) => Promise<void>

beginRun

Warning

This API is now deprecated.

use run instead

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

Property Value

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

beginRunAndWait

Warning

This API is now deprecated.

use run instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

cancel

Cancel the long running image build based on the image template

cancel: (resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesCancelOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesCancelOptionalParams) => PollerLike<OperationState<void>, void>

createOrUpdate

Create or update a virtual machine image template

createOrUpdate: (resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplate, options?: VirtualMachineImageTemplatesCreateOrUpdateOptionalParams) => PollerLike<OperationState<ImageTemplate>, ImageTemplate>

Property Value

(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplate, options?: VirtualMachineImageTemplatesCreateOrUpdateOptionalParams) => PollerLike<OperationState<ImageTemplate>, ImageTemplate>

delete

Delete a virtual machine image template

delete: (resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get information about a virtual machine image template

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

Property Value

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

getRunOutput

Get the specified run output for the specified image template resource

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

Property Value

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

list

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

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

Property Value

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

listByResourceGroup

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

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

Property Value

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

listRunOutputs

List all run outputs for the specified Image Template resource

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

Property Value

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

run

Create artifacts from a existing image template

run: (resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesRunOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesRunOptionalParams) => PollerLike<OperationState<void>, void>

update

Update the tags for this Virtual Machine Image Template

update: (resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplateUpdateParameters, options?: VirtualMachineImageTemplatesUpdateOptionalParams) => PollerLike<OperationState<ImageTemplate>, ImageTemplate>

Property Value

(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplateUpdateParameters, options?: VirtualMachineImageTemplatesUpdateOptionalParams) => PollerLike<OperationState<ImageTemplate>, ImageTemplate>