Package com.azure.resourcemanager.compute.fluent

Interface ImagesClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<ImageInner>, InnerSupportsListing<ImageInner>

public interface ImagesClient
extends InnerSupportsGet<ImageInner>, InnerSupportsListing<ImageInner>, InnerSupportsDelete<Void>

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner>	beginCreateOrUpdate(String resourceGroupName, String imageName, ImageInner parameters)	Create or update an image.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner>	beginCreateOrUpdate(String resourceGroupName, String imageName, ImageInner parameters, com.azure.core.util.Context context)	Create or update an image.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner>	beginCreateOrUpdateAsync(String resourceGroupName, String imageName, ImageInner parameters)	Create or update an image.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String imageName)	Deletes an Image.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String imageName, com.azure.core.util.Context context)	Deletes an Image.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void>	beginDeleteAsync(String resourceGroupName, String imageName)	Deletes an Image.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner>	beginUpdate(String resourceGroupName, String imageName, ImageUpdate parameters)	Update an image.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner>	beginUpdate(String resourceGroupName, String imageName, ImageUpdate parameters, com.azure.core.util.Context context)	Update an image.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner>	beginUpdateAsync(String resourceGroupName, String imageName, ImageUpdate parameters)	Update an image.
ImageInner	createOrUpdate(String resourceGroupName, String imageName, ImageInner parameters)	Create or update an image.
ImageInner	createOrUpdate(String resourceGroupName, String imageName, ImageInner parameters, com.azure.core.util.Context context)	Create or update an image.
Mono<ImageInner>	createOrUpdateAsync(String resourceGroupName, String imageName, ImageInner parameters)	Create or update an image.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	createOrUpdateWithResponseAsync(String resourceGroupName, String imageName, ImageInner parameters)	Create or update an image.
void	delete(String resourceGroupName, String imageName)	Deletes an Image.
void	delete(String resourceGroupName, String imageName, com.azure.core.util.Context context)	Deletes an Image.
Mono<Void>	deleteAsync(String resourceGroupName, String imageName)	Deletes an Image.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	deleteWithResponseAsync(String resourceGroupName, String imageName)	Deletes an Image.
ImageInner	getByResourceGroup(String resourceGroupName, String imageName)	Gets an image.
Mono<ImageInner>	getByResourceGroupAsync(String resourceGroupName, String imageName)	Gets an image.
Mono<ImageInner>	getByResourceGroupAsync(String resourceGroupName, String imageName, String expand)	Gets an image.
com.azure.core.http.rest.Response<ImageInner>	getByResourceGroupWithResponse(String resourceGroupName, String imageName, String expand, com.azure.core.util.Context context)	Gets an image.
Mono<com.azure.core.http.rest.Response<ImageInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String imageName, String expand)	Gets an image.
com.azure.core.http.rest.PagedIterable<ImageInner>	list()	Gets the list of Images in the subscription.
com.azure.core.http.rest.PagedIterable<ImageInner>	list(com.azure.core.util.Context context)	Gets the list of Images in the subscription.
com.azure.core.http.rest.PagedFlux<ImageInner>	listAsync()	Gets the list of Images in the subscription.
com.azure.core.http.rest.PagedIterable<ImageInner>	listByResourceGroup(String resourceGroupName)	Gets the list of images under a resource group.
com.azure.core.http.rest.PagedIterable<ImageInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Gets the list of images under a resource group.
com.azure.core.http.rest.PagedFlux<ImageInner>	listByResourceGroupAsync(String resourceGroupName)	Gets the list of images under a resource group.
ImageInner	update(String resourceGroupName, String imageName, ImageUpdate parameters)	Update an image.
ImageInner	update(String resourceGroupName, String imageName, ImageUpdate parameters, com.azure.core.util.Context context)	Update an image.
Mono<ImageInner>	updateAsync(String resourceGroupName, String imageName, ImageUpdate parameters)	Update an image.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	updateWithResponseAsync(String resourceGroupName, String imageName, ImageUpdate parameters)	Update an image.

Method Detail

createOrUpdateWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName,
                                                                                          String imageName,
                                                                                          ImageInner parameters)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

Returns:

the source user image virtual hard disk along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

beginCreateOrUpdateAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner> beginCreateOrUpdateAsync(String resourceGroupName,
                                                                                                                                           String imageName,
                                                                                                                                           ImageInner parameters)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

Returns:

the PollerFlux for polling of the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner>,ImageInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                      String imageName,
                                                                                                                                      ImageInner parameters)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

Returns:

the SyncPoller for polling of the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner>,ImageInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                      String imageName,
                                                                                                                                      ImageInner parameters,
                                                                                                                                      com.azure.core.util.Context context)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

createOrUpdateAsync

Mono<ImageInner> createOrUpdateAsync(String resourceGroupName,
                                     String imageName,
                                     ImageInner parameters)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

Returns:

the source user image virtual hard disk on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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 imageName,
                          ImageInner parameters)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

Returns:

the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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 imageName,
                          ImageInner parameters,
                          com.azure.core.util.Context context)

Create or update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Create Image operation.

context - The context to associate with this operation.

Returns:

the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

updateWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> updateWithResponseAsync(String resourceGroupName,
                                                                                  String imageName,
                                                                                  ImageUpdate parameters)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

Returns:

the source user image virtual hard disk along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

beginUpdateAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ImageInner>,ImageInner> beginUpdateAsync(String resourceGroupName,
                                                                                                                                   String imageName,
                                                                                                                                   ImageUpdate parameters)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

Returns:

the PollerFlux for polling of the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner>,ImageInner> beginUpdate(String resourceGroupName,
                                                                                                                              String imageName,
                                                                                                                              ImageUpdate parameters)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

Returns:

the SyncPoller for polling of the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner>,ImageInner> beginUpdate(String resourceGroupName,
                                                                                                                              String imageName,
                                                                                                                              ImageUpdate parameters,
                                                                                                                              com.azure.core.util.Context context)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

updateAsync

Mono<ImageInner> updateAsync(String resourceGroupName,
                             String imageName,
                             ImageUpdate parameters)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

Returns:

the source user image virtual hard disk on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

update

ImageInner update(String resourceGroupName,
                  String imageName,
                  ImageUpdate parameters)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

Returns:

the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

update

ImageInner update(String resourceGroupName,
                  String imageName,
                  ImageUpdate parameters,
                  com.azure.core.util.Context context)

Update an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

parameters - Parameters supplied to the Update Image operation.

context - The context to associate with this operation.

Returns:

the source user image virtual hard disk.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName,
                                                                                  String imageName)

Deletes an Image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

beginDeleteAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName,
                                                                                                                       String imageName)

Deletes an Image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Returns:

the PollerFlux for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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 imageName)

Deletes an Image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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 imageName,
                                                                                                                  com.azure.core.util.Context context)

Deletes an Image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

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.

ApiErrorException - thrown if the request is rejected by server.

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

deleteAsync

Mono<Void> deleteAsync(String resourceGroupName,
                       String imageName)

Deletes an Image.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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 imageName)

Deletes an Image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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 imageName,
            com.azure.core.util.Context context)

Deletes an Image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

getByResourceGroupWithResponseAsync

Mono<com.azure.core.http.rest.Response<ImageInner>> getByResourceGroupWithResponseAsync(String resourceGroupName,
                                                                                        String imageName,
                                                                                        String expand)

Gets an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

expand - The expand expression to apply on the operation.

Returns:

an image along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

getByResourceGroupAsync

Mono<ImageInner> getByResourceGroupAsync(String resourceGroupName,
                                         String imageName,
                                         String expand)

Gets an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

expand - The expand expression to apply on the operation.

Returns:

an image on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

getByResourceGroupAsync

Mono<ImageInner> getByResourceGroupAsync(String resourceGroupName,
                                         String imageName)

Gets an image.

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<ImageInner>

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Returns:

an image on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

getByResourceGroup

ImageInner getByResourceGroup(String resourceGroupName,
                              String imageName)

Gets an image.

Specified by:

getByResourceGroup in interface InnerSupportsGet<ImageInner>

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

Returns:

an image.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                             String imageName,
                                                                             String expand,
                                                                             com.azure.core.util.Context context)

Gets an image.

Parameters:

resourceGroupName - The name of the resource group.

imageName - The name of the image.

expand - The expand expression to apply on the operation.

context - The context to associate with this operation.

Returns:

an image along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

listByResourceGroupAsync

com.azure.core.http.rest.PagedFlux<ImageInner> listByResourceGroupAsync(String resourceGroupName)

Gets the list of images under a resource group.

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<ImageInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the list of images under a resource group as paginated response with PagedFlux.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner> listByResourceGroup(String resourceGroupName)

Gets the list of images under a resource group.

Specified by:

listByResourceGroup in interface InnerSupportsListing<ImageInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the list of images under a resource group as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - 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<ImageInner> listByResourceGroup(String resourceGroupName,
                                                                       com.azure.core.util.Context context)

Gets the list of images under a resource group.

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

the list of images under a resource group as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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

listAsync

com.azure.core.http.rest.PagedFlux<ImageInner> listAsync()

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

Specified by:

listAsync in interface InnerSupportsListing<ImageInner>

Returns:

the list of Images in the subscription as paginated response with PagedFlux.

Throws:

ApiErrorException - 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<ImageInner> list()

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

Specified by:

list in interface InnerSupportsListing<ImageInner>

Returns:

the list of Images in the subscription as paginated response with PagedIterable.

Throws:

ApiErrorException - 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<ImageInner> list(com.azure.core.util.Context context)

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

Parameters:

context - The context to associate with this operation.

Returns:

the list of Images in the subscription as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ApiErrorException - thrown if the request is rejected by server.

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