DisksClient Interface

public interface DisksClient

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

Method Summary

Modifier and Type Method and Description
abstract void attach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties)

Attach and create the lease of the disk to the virtual machine.

abstract void attach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties, Context context)

Attach and create the lease of the disk to the virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginAttach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties)

Attach and create the lease of the disk to the virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginAttach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties, Context context)

Attach and create the lease of the disk to the virtual machine.

abstract SyncPoller<PollResult<DiskInner>,DiskInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk)

Create or replace an existing disk.

abstract SyncPoller<PollResult<DiskInner>,DiskInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk, Context context)

Create or replace an existing disk.

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

Delete disk.

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

Delete disk.

abstract SyncPoller<PollResult<Void>,Void> beginDetach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties)

Detach and break the lease of the disk attached to the virtual machine.

abstract SyncPoller<PollResult<Void>,Void> beginDetach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties, Context context)

Detach and break the lease of the disk attached to the virtual machine.

abstract DiskInner createOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk)

Create or replace an existing disk.

abstract DiskInner createOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk, Context context)

Create or replace an existing disk.

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

Delete disk.

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

Delete disk.

abstract void detach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties)

Detach and break the lease of the disk attached to the virtual machine.

abstract void detach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties, Context context)

Detach and break the lease of the disk attached to the virtual machine.

abstract DiskInner get(String resourceGroupName, String labName, String username, String name)

Get disk.

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

Get disk.

abstract PagedIterable<DiskInner> list(String resourceGroupName, String labName, String username)

List disks in a given user profile.

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

List disks in a given user profile.

abstract DiskInner update(String resourceGroupName, String labName, String username, String name, DiskFragment disk)

Allows modifying tags of disks.

abstract Response<DiskInner> updateWithResponse(String resourceGroupName, String labName, String username, String name, DiskFragment disk, Context context)

Allows modifying tags of disks.

Method Details

attach

public abstract void attach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties)

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
attachDiskProperties - Properties of the disk to attach.

attach

public abstract void attach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties, Context context)

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
attachDiskProperties - Properties of the disk to attach.
context - The context to associate with this operation.

beginAttach

public abstract SyncPoller<PollResult<Void>,Void> beginAttach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties)

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
attachDiskProperties - Properties of the disk to attach.

Returns:

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

beginAttach

public abstract SyncPoller<PollResult<Void>,Void> beginAttach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties, Context context)

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
attachDiskProperties - Properties of the disk to attach.
context - The context to associate with this operation.

Returns:

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

beginCreateOrUpdate

public abstract SyncPoller<PollResult<DiskInner>,DiskInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk)

Create or replace an existing disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
disk - A Disk.

Returns:

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

beginCreateOrUpdate

public abstract SyncPoller<PollResult<DiskInner>,DiskInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk, Context context)

Create or replace an existing disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
disk - A Disk.
context - The context to associate with this operation.

Returns:

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

beginDelete

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

Delete disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.

Returns:

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

beginDelete

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

Delete disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
context - The context to associate with this operation.

Returns:

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

beginDetach

public abstract SyncPoller<PollResult<Void>,Void> beginDetach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties)

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
detachDiskProperties - Properties of the disk to detach.

Returns:

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

beginDetach

public abstract SyncPoller<PollResult<Void>,Void> beginDetach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties, Context context)

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
detachDiskProperties - Properties of the disk to detach.
context - The context to associate with this operation.

Returns:

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

createOrUpdate

public abstract DiskInner createOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk)

Create or replace an existing disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
disk - A Disk.

Returns:

a Disk.

createOrUpdate

public abstract DiskInner createOrUpdate(String resourceGroupName, String labName, String username, String name, DiskInner disk, Context context)

Create or replace an existing disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
disk - A Disk.
context - The context to associate with this operation.

Returns:

a Disk.

delete

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

Delete disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.

delete

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

Delete disk. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
context - The context to associate with this operation.

detach

public abstract void detach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties)

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
detachDiskProperties - Properties of the disk to detach.

detach

public abstract void detach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties, Context context)

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
detachDiskProperties - Properties of the disk to detach.
context - The context to associate with this operation.

get

public abstract DiskInner get(String resourceGroupName, String labName, String username, String name)

Get disk.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.

Returns:

disk.

getWithResponse

public abstract Response<DiskInner> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, Context context)

Get disk.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
expand - Specify the $expand query. Example: 'properties($select=diskType)'.
context - The context to associate with this operation.

Returns:

disk along with Response<T>.

list

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

List disks in a given user profile.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

list

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

List disks in a given user profile.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
expand - Specify the $expand query. Example: 'properties($select=diskType)'.
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 DiskInner update(String resourceGroupName, String labName, String username, String name, DiskFragment disk)

Allows modifying tags of disks. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
disk - A Disk.

Returns:

a Disk.

updateWithResponse

public abstract Response<DiskInner> updateWithResponse(String resourceGroupName, String labName, String username, String name, DiskFragment disk, Context context)

Allows modifying tags of disks. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
labName - The name of the lab.
username - The name of the user profile.
name - The name of the disk.
disk - A Disk.
context - The context to associate with this operation.

Returns:

a Disk along with Response<T>.

Applies to