Package com.azure.resourcemanager.labservices.models

Interface Images

public interface Images

Resource collection API of Images.

Method Summary

Modifier and Type	Method	Description
Image.DefinitionStages.Blank	define(String name)	Begins definition for a new Image resource.
Image	get(String resourceGroupName, String labPlanName, String imageName)	Gets an image resource.
Image	getById(String id)	Gets an image resource.
com.azure.core.http.rest.Response<Image>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets an image resource.
com.azure.core.http.rest.Response<Image>	getWithResponse(String resourceGroupName, String labPlanName, String imageName, com.azure.core.util.Context context)	Gets an image resource.
com.azure.core.http.rest.PagedIterable<Image>	listByLabPlan(String resourceGroupName, String labPlanName)	Gets all images from galleries attached to a lab plan.
com.azure.core.http.rest.PagedIterable<Image>	listByLabPlan(String resourceGroupName, String labPlanName, String filter, com.azure.core.util.Context context)	Gets all images from galleries attached to a lab plan.

Method Detail

listByLabPlan

com.azure.core.http.rest.PagedIterable<Image> listByLabPlan(String resourceGroupName,
                                                            String labPlanName)

Gets all images from galleries attached to a lab plan.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

Returns:

all images from galleries attached to a lab plan.

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.

listByLabPlan

com.azure.core.http.rest.PagedIterable<Image> listByLabPlan(String resourceGroupName,
                                                            String labPlanName,
                                                            String filter,
                                                            com.azure.core.util.Context context)

Gets all images from galleries attached to a lab plan.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

filter - The filter to apply to the operation.

context - The context to associate with this operation.

Returns:

all images from galleries attached to a lab plan.

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.

get

Image get(String resourceGroupName,
          String labPlanName,
          String imageName)

Gets an image resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

imageName - The image name.

Returns:

an image 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.

getWithResponse

com.azure.core.http.rest.Response<Image> getWithResponse(String resourceGroupName,
                                                         String labPlanName,
                                                         String imageName,
                                                         com.azure.core.util.Context context)

Gets an image resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

imageName - The image name.

context - The context to associate with this operation.

Returns:

an image 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.

getById

Image getById(String id)

Gets an image resource.

Parameters:

id - the resource ID.

Returns:

an image 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.

getByIdWithResponse

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

Gets an image resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

an image 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.

define

Image.DefinitionStages.Blank define(String name)

Begins definition for a new Image resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Image definition.