CustomImagesClient Interface

public interface CustomImagesClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<CustomImageInner>,CustomImageInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage)

Create or replace an existing custom image.

abstract SyncPoller<PollResult<CustomImageInner>,CustomImageInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage, Context context)

Create or replace an existing custom image.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String name)

Delete custom image.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String name, Context context)

Delete custom image.

abstract CustomImageInner createOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage)

Create or replace an existing custom image.

abstract CustomImageInner createOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage, Context context)

Create or replace an existing custom image.

abstract void delete(String resourceGroupName, String labName, String name)

Delete custom image.

abstract void delete(String resourceGroupName, String labName, String name, Context context)

Delete custom image.

abstract CustomImageInner get(String resourceGroupName, String labName, String name)

Get custom image.

abstract Response<CustomImageInner> getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)

Get custom image.

abstract PagedIterable<CustomImageInner> list(String resourceGroupName, String labName)

List custom images in a given lab.

abstract PagedIterable<CustomImageInner> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)

List custom images in a given lab.

abstract CustomImageInner update(String resourceGroupName, String labName, String name, CustomImageFragment customImage)

Allows modifying tags of custom images.

abstract Response<CustomImageInner> updateWithResponse(String resourceGroupName, String labName, String name, CustomImageFragment customImage, Context context)

Allows modifying tags of custom images.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<CustomImageInner>,CustomImageInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage)

Create or replace an existing 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.
customImage - A custom image.

Returns:

the SyncPoller<T,U> for polling of a custom image.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<CustomImageInner>,CustomImageInner> beginCreateOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage, Context context)

Create or replace an existing 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.
customImage - A custom image.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a custom image.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String name)

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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String labName, String name, 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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

createOrUpdate

public abstract CustomImageInner createOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage)

Create or replace an existing 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.
customImage - A custom image.

Returns:

a custom image.

createOrUpdate

public abstract CustomImageInner createOrUpdate(String resourceGroupName, String labName, String name, CustomImageInner customImage, Context context)

Create or replace an existing 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.
customImage - A custom image.
context - The context to associate with this operation.

Returns:

a custom image.

delete

public abstract void delete(String resourceGroupName, String labName, String name)

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.

delete

public abstract void delete(String resourceGroupName, String labName, String name, 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.

get

public abstract CustomImageInner get(String resourceGroupName, String labName, String name)

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.

getWithResponse

public abstract Response<CustomImageInner> getWithResponse(String resourceGroupName, String labName, String name, String expand, 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<T>.

list

public abstract PagedIterable<CustomImageInner> list(String resourceGroupName, String labName)

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<T>.

list

public abstract PagedIterable<CustomImageInner> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, 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<T>.

update

public abstract CustomImageInner update(String resourceGroupName, String labName, String name, CustomImageFragment customImage)

Allows modifying tags of custom images. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
name - The name of the custom image.
customImage - A custom image.

Returns:

a custom image.

updateWithResponse

public abstract Response<CustomImageInner> updateWithResponse(String resourceGroupName, String labName, String name, CustomImageFragment customImage, Context context)

Allows modifying tags of custom images. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
name - The name of the custom image.
customImage - A custom image.
context - The context to associate with this operation.

Returns:

a custom image along with Response<T>.

Applies to