Package com.azure.resourcemanager.scvmm.models

Interface VirtualMachineTemplates

public interface VirtualMachineTemplates

Resource collection API of VirtualMachineTemplates.

Method Summary

Modifier and Type	Method	Description
VirtualMachineTemplate.DefinitionStages.Blank	define(String name)	Begins definition for a new VirtualMachineTemplate resource.
void	delete(String resourceGroupName, String virtualMachineTemplateName)	Deregisters the ScVmm VM Template from Azure.
void	delete(String resourceGroupName, String virtualMachineTemplateName, Boolean force)	Deregisters the ScVmm VM Template from Azure.
void	delete(String resourceGroupName, String virtualMachineTemplateName, Boolean force, com.azure.core.util.Context context)	Deregisters the ScVmm VM Template from Azure.
void	deleteById(String id)	Deregisters the ScVmm VM Template from Azure.
void	deleteByIdWithResponse(String id, Boolean force, com.azure.core.util.Context context)	Deregisters the ScVmm VM Template from Azure.
VirtualMachineTemplate	getById(String id)	Implements VirtualMachineTemplate GET method.
com.azure.core.http.rest.Response<VirtualMachineTemplate>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Implements VirtualMachineTemplate GET method.
VirtualMachineTemplate	getByResourceGroup(String resourceGroupName, String virtualMachineTemplateName)	Implements VirtualMachineTemplate GET method.
com.azure.core.http.rest.Response<VirtualMachineTemplate>	getByResourceGroupWithResponse(String resourceGroupName, String virtualMachineTemplateName, com.azure.core.util.Context context)	Implements VirtualMachineTemplate GET method.
com.azure.core.http.rest.PagedIterable<VirtualMachineTemplate>	list()	List of VirtualMachineTemplates in a subscription.
com.azure.core.http.rest.PagedIterable<VirtualMachineTemplate>	list(com.azure.core.util.Context context)	List of VirtualMachineTemplates in a subscription.
com.azure.core.http.rest.PagedIterable<VirtualMachineTemplate>	listByResourceGroup(String resourceGroupName)	List of VirtualMachineTemplates in a resource group.
com.azure.core.http.rest.PagedIterable<VirtualMachineTemplate>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	List of VirtualMachineTemplates in a resource group.

Method Detail

getByResourceGroup

VirtualMachineTemplate getByResourceGroup(String resourceGroupName,
                                          String virtualMachineTemplateName)

Implements VirtualMachineTemplate GET method.

Parameters:

resourceGroupName - The name of the resource group.

virtualMachineTemplateName - Name of the VirtualMachineTemplate.

Returns:

the VirtualMachineTemplates resource definition.

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<VirtualMachineTemplate> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                         String virtualMachineTemplateName,
                                                                                         com.azure.core.util.Context context)

Implements VirtualMachineTemplate GET method.

Parameters:

resourceGroupName - The name of the resource group.

virtualMachineTemplateName - Name of the VirtualMachineTemplate.

context - The context to associate with this operation.

Returns:

the VirtualMachineTemplates resource definition 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.

delete

void delete(String resourceGroupName,
            String virtualMachineTemplateName,
            Boolean force)

Deregisters the ScVmm VM Template from Azure.

Parameters:

resourceGroupName - The name of the resource group.

virtualMachineTemplateName - Name of the VirtualMachineTemplate.

force - Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.

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 virtualMachineTemplateName)

Deregisters the ScVmm VM Template from Azure.

Parameters:

resourceGroupName - The name of the resource group.

virtualMachineTemplateName - Name of the VirtualMachineTemplate.

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 virtualMachineTemplateName,
            Boolean force,
            com.azure.core.util.Context context)

Deregisters the ScVmm VM Template from Azure.

Parameters:

resourceGroupName - The name of the resource group.

virtualMachineTemplateName - Name of the VirtualMachineTemplate.

force - Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.

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.

listByResourceGroup

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

List of VirtualMachineTemplates in a resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

list of VirtualMachineTemplates 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<VirtualMachineTemplate> listByResourceGroup(String resourceGroupName,
                                                                                   com.azure.core.util.Context context)

List of VirtualMachineTemplates in a resource group.

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

list of VirtualMachineTemplates 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.

list

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

List of VirtualMachineTemplates in a subscription.

Returns:

list of VirtualMachineTemplates 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<VirtualMachineTemplate> list(com.azure.core.util.Context context)

List of VirtualMachineTemplates in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

list of VirtualMachineTemplates 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.

getById

VirtualMachineTemplate getById(String id)

Implements VirtualMachineTemplate GET method.

Parameters:

id - the resource ID.

Returns:

the VirtualMachineTemplates resource definition 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.

getByIdWithResponse

com.azure.core.http.rest.Response<VirtualMachineTemplate> getByIdWithResponse(String id,
                                                                              com.azure.core.util.Context context)

Implements VirtualMachineTemplate GET method.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the VirtualMachineTemplates resource definition 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.

deleteById

void deleteById(String id)

Deregisters the ScVmm VM Template from Azure.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            Boolean force,
                            com.azure.core.util.Context context)

Deregisters the ScVmm VM Template from Azure.

Parameters:

id - the resource ID.

force - Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.

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.

define

VirtualMachineTemplate.DefinitionStages.Blank define(String name)

Begins definition for a new VirtualMachineTemplate resource.

Parameters:

name - resource name.

Returns:

the first stage of the new VirtualMachineTemplate definition.