Package com.azure.resourcemanager.imagebuilder.fluent

Interface VirtualMachineImageTemplatesClient

public interface VirtualMachineImageTemplatesClient

An instance of this class provides access to all the operations defined in VirtualMachineImageTemplatesClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginCancel(String resourceGroupName, String imageTemplateName)	Cancel the long running image build based on the image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginCancel(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Cancel the long running image build based on the image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner>	beginCreateOrUpdate(String resourceGroupName, String imageTemplateName, ImageTemplateInner parameters)	Create or update a virtual machine image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner>	beginCreateOrUpdate(String resourceGroupName, String imageTemplateName, ImageTemplateInner parameters, com.azure.core.util.Context context)	Create or update a virtual machine image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String imageTemplateName)	Delete a virtual machine image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Delete a virtual machine image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginRun(String resourceGroupName, String imageTemplateName)	Create artifacts from a existing image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginRun(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Create artifacts from a existing image template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner>	beginUpdate(String resourceGroupName, String imageTemplateName, ImageTemplateUpdateParameters parameters)	Update the tags for this Virtual Machine Image Template.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner>	beginUpdate(String resourceGroupName, String imageTemplateName, ImageTemplateUpdateParameters parameters, com.azure.core.util.Context context)	Update the tags for this Virtual Machine Image Template.
void	cancel(String resourceGroupName, String imageTemplateName)	Cancel the long running image build based on the image template.
void	cancel(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Cancel the long running image build based on the image template.
ImageTemplateInner	createOrUpdate(String resourceGroupName, String imageTemplateName, ImageTemplateInner parameters)	Create or update a virtual machine image template.
ImageTemplateInner	createOrUpdate(String resourceGroupName, String imageTemplateName, ImageTemplateInner parameters, com.azure.core.util.Context context)	Create or update a virtual machine image template.
void	delete(String resourceGroupName, String imageTemplateName)	Delete a virtual machine image template.
void	delete(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Delete a virtual machine image template.
ImageTemplateInner	getByResourceGroup(String resourceGroupName, String imageTemplateName)	Get information about a virtual machine image template.
com.azure.core.http.rest.Response<ImageTemplateInner>	getByResourceGroupWithResponse(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Get information about a virtual machine image template.
RunOutputInner	getRunOutput(String resourceGroupName, String imageTemplateName, String runOutputName)	Get the specified run output for the specified image template resource.
com.azure.core.http.rest.Response<RunOutputInner>	getRunOutputWithResponse(String resourceGroupName, String imageTemplateName, String runOutputName, com.azure.core.util.Context context)	Get the specified run output for the specified image template resource.
com.azure.core.http.rest.PagedIterable<ImageTemplateInner>	list()	Gets information about the VM image templates associated with the subscription.
com.azure.core.http.rest.PagedIterable<ImageTemplateInner>	list(com.azure.core.util.Context context)	Gets information about the VM image templates associated with the subscription.
com.azure.core.http.rest.PagedIterable<ImageTemplateInner>	listByResourceGroup(String resourceGroupName)	Gets information about the VM image templates associated with the specified resource group.
com.azure.core.http.rest.PagedIterable<ImageTemplateInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Gets information about the VM image templates associated with the specified resource group.
com.azure.core.http.rest.PagedIterable<RunOutputInner>	listRunOutputs(String resourceGroupName, String imageTemplateName)	List all run outputs for the specified Image Template resource.
com.azure.core.http.rest.PagedIterable<RunOutputInner>	listRunOutputs(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	List all run outputs for the specified Image Template resource.
void	run(String resourceGroupName, String imageTemplateName)	Create artifacts from a existing image template.
void	run(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)	Create artifacts from a existing image template.
ImageTemplateInner	update(String resourceGroupName, String imageTemplateName, ImageTemplateUpdateParameters parameters)	Update the tags for this Virtual Machine Image Template.
ImageTemplateInner	update(String resourceGroupName, String imageTemplateName, ImageTemplateUpdateParameters parameters, com.azure.core.util.Context context)	Update the tags for this Virtual Machine Image Template.

Method Detail

list

com.azure.core.http.rest.PagedIterable<ImageTemplateInner> list()

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

Returns:

information about the VM image templates associated with the subscription as paginated response with PagedIterable.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ImageTemplateInner> list(com.azure.core.util.Context context)

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

Parameters:

context - The context to associate with this operation.

Returns:

information about the VM image templates associated with the subscription as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ImageTemplateInner> listByResourceGroup(String resourceGroupName)

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

Parameters:

resourceGroupName - The name of the resource group.

Returns:

information about the VM image templates associated with the specified resource group as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ImageTemplateInner> listByResourceGroup(String resourceGroupName,
                                                                               com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

information about the VM image templates associated with the specified resource group as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                      String imageTemplateName,
                                                                                                                                                      ImageTemplateInner parameters)

Create or update a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Parameters supplied to the CreateImageTemplate operation.

Returns:

the SyncPoller for polling of image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                      String imageTemplateName,
                                                                                                                                                      ImageTemplateInner parameters,
                                                                                                                                                      com.azure.core.util.Context context)

Create or update a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Parameters supplied to the CreateImageTemplate operation.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

ImageTemplateInner createOrUpdate(String resourceGroupName,
                                  String imageTemplateName,
                                  ImageTemplateInner parameters)

Create or update a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Parameters supplied to the CreateImageTemplate operation.

Returns:

image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

ImageTemplateInner createOrUpdate(String resourceGroupName,
                                  String imageTemplateName,
                                  ImageTemplateInner parameters,
                                  com.azure.core.util.Context context)

Create or update a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Parameters supplied to the CreateImageTemplate operation.

context - The context to associate with this operation.

Returns:

image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner> beginUpdate(String resourceGroupName,
                                                                                                                                              String imageTemplateName,
                                                                                                                                              ImageTemplateUpdateParameters parameters)

Update the tags for this Virtual Machine Image Template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Additional parameters for Image Template update.

Returns:

the SyncPoller for polling of image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageTemplateInner>,ImageTemplateInner> beginUpdate(String resourceGroupName,
                                                                                                                                              String imageTemplateName,
                                                                                                                                              ImageTemplateUpdateParameters parameters,
                                                                                                                                              com.azure.core.util.Context context)

Update the tags for this Virtual Machine Image Template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Additional parameters for Image Template update.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

ImageTemplateInner update(String resourceGroupName,
                          String imageTemplateName,
                          ImageTemplateUpdateParameters parameters)

Update the tags for this Virtual Machine Image Template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Additional parameters for Image Template update.

Returns:

image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

ImageTemplateInner update(String resourceGroupName,
                          String imageTemplateName,
                          ImageTemplateUpdateParameters parameters,
                          com.azure.core.util.Context context)

Update the tags for this Virtual Machine Image Template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

parameters - Additional parameters for Image Template update.

context - The context to associate with this operation.

Returns:

image template is an ARM resource managed by Microsoft.VirtualMachineImages provider.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

ImageTemplateInner getByResourceGroup(String resourceGroupName,
                                      String imageTemplateName)

Get information about a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Returns:

information about a virtual machine image template.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<ImageTemplateInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                     String imageTemplateName,
                                                                                     com.azure.core.util.Context context)

Get information about a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Returns:

information about a virtual machine image template along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String imageTemplateName)

Delete a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String imageTemplateName,
                                                                                                                  com.azure.core.util.Context context)

Delete a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String imageTemplateName)

Delete a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String imageTemplateName,
            com.azure.core.util.Context context)

Delete a virtual machine image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginRun

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRun(String resourceGroupName,
                                                                                                               String imageTemplateName)

Create artifacts from a existing image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginRun

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRun(String resourceGroupName,
                                                                                                               String imageTemplateName,
                                                                                                               com.azure.core.util.Context context)

Create artifacts from a existing image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

run

void run(String resourceGroupName,
         String imageTemplateName)

Create artifacts from a existing image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

run

void run(String resourceGroupName,
         String imageTemplateName,
         com.azure.core.util.Context context)

Create artifacts from a existing image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCancel

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginCancel(String resourceGroupName,
                                                                                                                  String imageTemplateName)

Cancel the long running image build based on the image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCancel

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginCancel(String resourceGroupName,
                                                                                                                  String imageTemplateName,
                                                                                                                  com.azure.core.util.Context context)

Cancel the long running image build based on the image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

cancel

void cancel(String resourceGroupName,
            String imageTemplateName)

Cancel the long running image build based on the image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

cancel

void cancel(String resourceGroupName,
            String imageTemplateName,
            com.azure.core.util.Context context)

Cancel the long running image build based on the image template.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listRunOutputs

com.azure.core.http.rest.PagedIterable<RunOutputInner> listRunOutputs(String resourceGroupName,
                                                                      String imageTemplateName)

List all run outputs for the specified Image Template resource.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

Returns:

the result of List run outputs operation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listRunOutputs

com.azure.core.http.rest.PagedIterable<RunOutputInner> listRunOutputs(String resourceGroupName,
                                                                      String imageTemplateName,
                                                                      com.azure.core.util.Context context)

List all run outputs for the specified Image Template resource.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

context - The context to associate with this operation.

Returns:

the result of List run outputs operation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRunOutput

RunOutputInner getRunOutput(String resourceGroupName,
                            String imageTemplateName,
                            String runOutputName)

Get the specified run output for the specified image template resource.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

runOutputName - The name of the run output.

Returns:

the specified run output for the specified image template resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRunOutputWithResponse

com.azure.core.http.rest.Response<RunOutputInner> getRunOutputWithResponse(String resourceGroupName,
                                                                           String imageTemplateName,
                                                                           String runOutputName,
                                                                           com.azure.core.util.Context context)

Get the specified run output for the specified image template resource.

Parameters:

resourceGroupName - The name of the resource group.

imageTemplateName - The name of the image Template.

runOutputName - The name of the run output.

context - The context to associate with this operation.

Returns:

the specified run output for the specified image template resource along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.