VolumesClient Interface

public interface VolumesClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<VolumeInner>,VolumeInner> beginCreateOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters)

Create a new volume or update the properties of the existing one.

abstract SyncPoller<PollResult<VolumeInner>,VolumeInner> beginCreateOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new volume or update the properties of the existing one.

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

Delete the provided volume.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String volumeName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided volume.

abstract VolumeInner createOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters)

Create a new volume or update the properties of the existing one.

abstract VolumeInner createOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new volume or update the properties of the existing one.

abstract void delete(String resourceGroupName, String volumeName)

Delete the provided volume.

abstract void delete(String resourceGroupName, String volumeName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided volume.

abstract VolumeInner getByResourceGroup(String resourceGroupName, String volumeName)

Get properties of the provided volume.

abstract Response<VolumeInner> getByResourceGroupWithResponse(String resourceGroupName, String volumeName, Context context)

Get properties of the provided volume.

abstract PagedIterable<VolumeInner> list()

Get a list of volumes in the provided subscription.

abstract PagedIterable<VolumeInner> list(Integer top, String skipToken, Context context)

Get a list of volumes in the provided subscription.

abstract PagedIterable<VolumeInner> listByResourceGroup(String resourceGroupName)

Get a list of volumes in the provided resource group.

abstract PagedIterable<VolumeInner> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

Get a list of volumes in the provided resource group.

abstract VolumeInner update(String resourceGroupName, String volumeName)

Update tags associated with the provided volume.

abstract Response<VolumeInner> updateWithResponse(String resourceGroupName, String volumeName, String ifMatch, String ifNoneMatch, VolumePatchParameters volumeUpdateParameters, Context context)

Update tags associated with the provided volume.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<VolumeInner>,VolumeInner> beginCreateOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters)

Create a new volume or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
volumeParameters - The request body.

Returns:

the SyncPoller<T,U> for polling of volume represents storage made available for use by resources running on the cluster.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<VolumeInner>,VolumeInner> beginCreateOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new volume or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
volumeParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of volume represents storage made available for use by resources running on the cluster.

beginDelete

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

Delete the provided volume.

Parameters:

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

Returns:

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

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String volumeName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided volume.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

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

createOrUpdate

public abstract VolumeInner createOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters)

Create a new volume or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
volumeParameters - The request body.

Returns:

volume represents storage made available for use by resources running on the cluster.

createOrUpdate

public abstract VolumeInner createOrUpdate(String resourceGroupName, String volumeName, VolumeInner volumeParameters, String ifMatch, String ifNoneMatch, Context context)

Create a new volume or update the properties of the existing one.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
volumeParameters - The request body.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

Returns:

volume represents storage made available for use by resources running on the cluster.

delete

public abstract void delete(String resourceGroupName, String volumeName)

Delete the provided volume.

Parameters:

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

delete

public abstract void delete(String resourceGroupName, String volumeName, String ifMatch, String ifNoneMatch, Context context)

Delete the provided volume.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
context - The context to associate with this operation.

getByResourceGroup

public abstract VolumeInner getByResourceGroup(String resourceGroupName, String volumeName)

Get properties of the provided volume.

Parameters:

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

Returns:

properties of the provided volume.

getByResourceGroupWithResponse

public abstract Response<VolumeInner> getByResourceGroupWithResponse(String resourceGroupName, String volumeName, Context context)

Get properties of the provided volume.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
context - The context to associate with this operation.

Returns:

properties of the provided volume along with Response<T>.

list

public abstract PagedIterable<VolumeInner> list()

Get a list of volumes in the provided subscription.

Returns:

a list of volumes in the provided subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<VolumeInner> list(Integer top, String skipToken, Context context)

Get a list of volumes in the provided subscription.

Parameters:

top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of volumes in the provided subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<VolumeInner> listByResourceGroup(String resourceGroupName)

Get a list of volumes in the provided resource group.

Parameters:

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

Returns:

a list of volumes in the provided resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<VolumeInner> listByResourceGroup(String resourceGroupName, Integer top, String skipToken, Context context)

Get a list of volumes in the provided resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
skipToken - The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets.
context - The context to associate with this operation.

Returns:

a list of volumes in the provided resource group as paginated response with PagedIterable<T>.

update

public abstract VolumeInner update(String resourceGroupName, String volumeName)

Update tags associated with the provided volume.

Parameters:

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

Returns:

volume represents storage made available for use by resources running on the cluster.

updateWithResponse

public abstract Response<VolumeInner> updateWithResponse(String resourceGroupName, String volumeName, String ifMatch, String ifNoneMatch, VolumePatchParameters volumeUpdateParameters, Context context)

Update tags associated with the provided volume.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
volumeName - The name of the volume.
ifMatch - The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
ifNoneMatch - Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.
volumeUpdateParameters - The request body.
context - The context to associate with this operation.

Returns:

volume represents storage made available for use by resources running on the cluster along with Response<T>.

Applies to