Interface ImagesClient
public interface ImagesClient
An instance of this class provides access to all the operations defined in ImagesClient.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate
(String resourceGroupName, String labPlanName, String imageName, ImageInner body) Updates an image via PUT.com.azure.core.http.rest.Response<ImageInner>
createOrUpdateWithResponse
(String resourceGroupName, String labPlanName, String imageName, ImageInner body, com.azure.core.util.Context context) Updates an image via PUT.Gets an image.com.azure.core.http.rest.Response<ImageInner>
getWithResponse
(String resourceGroupName, String labPlanName, String imageName, com.azure.core.util.Context context) Gets an image.com.azure.core.http.rest.PagedIterable<ImageInner>
listByLabPlan
(String resourceGroupName, String labPlanName) Gets all images.com.azure.core.http.rest.PagedIterable<ImageInner>
listByLabPlan
(String resourceGroupName, String labPlanName, String filter, com.azure.core.util.Context context) Gets all images.update
(String resourceGroupName, String labPlanName, String imageName, ImageUpdate body) Updates an image.com.azure.core.http.rest.Response<ImageInner>
updateWithResponse
(String resourceGroupName, String labPlanName, String imageName, ImageUpdate body, com.azure.core.util.Context context) Updates an image.
-
Method Details
-
listByLabPlan
com.azure.core.http.rest.PagedIterable<ImageInner> listByLabPlan(String resourceGroupName, String labPlanName) Gets all images.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 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.
-
listByLabPlan
com.azure.core.http.rest.PagedIterable<ImageInner> listByLabPlan(String resourceGroupName, String labPlanName, String filter, com.azure.core.util.Context context) Gets all images.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 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.
-
get
Gets an image.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<ImageInner> getWithResponse(String resourceGroupName, String labPlanName, String imageName, com.azure.core.util.Context context) Gets an image.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.
-
createOrUpdate
ImageInner createOrUpdate(String resourceGroupName, String labPlanName, String imageName, ImageInner body) Updates an image via PUT.Updates an image resource via PUT. Creating new resources via PUT will not function.
- 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.body
- The request body.- Returns:
- lab services virtual machine image.
- 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.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<ImageInner> createOrUpdateWithResponse(String resourceGroupName, String labPlanName, String imageName, ImageInner body, com.azure.core.util.Context context) Updates an image via PUT.Updates an image resource via PUT. Creating new resources via PUT will not function.
- 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.body
- The request body.context
- The context to associate with this operation.- Returns:
- lab services virtual machine image 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.
-
update
Updates an image.Updates 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.body
- The request body.- Returns:
- lab services virtual machine image.
- 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.
-
updateWithResponse
com.azure.core.http.rest.Response<ImageInner> updateWithResponse(String resourceGroupName, String labPlanName, String imageName, ImageUpdate body, com.azure.core.util.Context context) Updates an image.Updates 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.body
- The request body.context
- The context to associate with this operation.- Returns:
- lab services virtual machine image 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.
-