Interface CustomImages
public interface CustomImages
Resource collection API of CustomImages.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new CustomImage resource.void
Delete custom image.void
Delete custom image.void
deleteById
(String id) Delete custom image.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete custom image.Get custom image.Get custom image.com.azure.core.http.rest.Response<CustomImage>
getByIdWithResponse
(String id, String expand, com.azure.core.util.Context context) Get custom image.com.azure.core.http.rest.Response<CustomImage>
getWithResponse
(String resourceGroupName, String labName, String name, String expand, com.azure.core.util.Context context) Get custom image.com.azure.core.http.rest.PagedIterable<CustomImage>
List custom images in a given lab.com.azure.core.http.rest.PagedIterable<CustomImage>
list
(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List custom images in a given lab.
-
Method Details
-
list
List custom images in a given lab.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.- Returns:
- the response of a list 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.
-
list
com.azure.core.http.rest.PagedIterable<CustomImage> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List custom images in a given lab.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.expand
- Specify the $expand query. Example: 'properties($select=vm)'.filter
- The filter to apply to the operation. Example: '$filter=contains(name,'myName').top
- The maximum number of resources to return from the operation. Example: '$top=10'.orderby
- The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.context
- The context to associate with this operation.- Returns:
- the response of a list 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.
-
getWithResponse
com.azure.core.http.rest.Response<CustomImage> getWithResponse(String resourceGroupName, String labName, String name, String expand, com.azure.core.util.Context context) Get custom image.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the custom image.expand
- Specify the $expand query. Example: 'properties($select=vm)'.context
- The context to associate with this operation.- Returns:
- custom 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.
-
get
Get custom image.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the custom image.- Returns:
- custom 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.
-
delete
Delete custom image. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the custom 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.
-
delete
void delete(String resourceGroupName, String labName, String name, com.azure.core.util.Context context) Delete custom image. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.name
- The name of the custom image.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.
-
getById
Get custom image.- Parameters:
id
- the resource ID.- Returns:
- custom 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<CustomImage> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context) Get custom image.- Parameters:
id
- the resource ID.expand
- Specify the $expand query. Example: 'properties($select=vm)'.context
- The context to associate with this operation.- Returns:
- custom 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.
-
deleteById
Delete custom image. This operation can take a while to complete.- 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
Delete custom image. This operation can take a while to complete.- Parameters:
id
- the resource ID.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
Begins definition for a new CustomImage resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new CustomImage definition.
-