VirtualMachineImageTemplates interface
Interface representing a VirtualMachineImageTemplates.
Methods
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
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
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
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
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
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
The options parameters.
Returns
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
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
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.
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.
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
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
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
The options parameters.
Returns
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.
The options parameters.
Returns
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
The options parameters.