Disks interface

Interface representing a Disks.

Methods

beginAttach(string, string, string, string, AttachDiskProperties, DisksAttachOptionalParams)

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

beginAttachAndWait(string, string, string, string, AttachDiskProperties, DisksAttachOptionalParams)

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

beginCreateOrUpdate(string, string, string, string, Disk, DisksCreateOrUpdateOptionalParams)

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

beginCreateOrUpdateAndWait(string, string, string, string, Disk, DisksCreateOrUpdateOptionalParams)

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

beginDelete(string, string, string, string, DisksDeleteOptionalParams)

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

beginDeleteAndWait(string, string, string, string, DisksDeleteOptionalParams)

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

beginDetach(string, string, string, string, DetachDiskProperties, DisksDetachOptionalParams)

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

beginDetachAndWait(string, string, string, string, DetachDiskProperties, DisksDetachOptionalParams)

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

get(string, string, string, string, DisksGetOptionalParams)

Get disk.

list(string, string, string, DisksListOptionalParams)

List disks in a given user profile.

update(string, string, string, string, DiskFragment, DisksUpdateOptionalParams)

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

Method Details

beginAttach(string, string, string, string, AttachDiskProperties, DisksAttachOptionalParams)

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

function beginAttach(resourceGroupName: string, labName: string, userName: string, name: string, attachDiskProperties: AttachDiskProperties, options?: DisksAttachOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

attachDiskProperties
AttachDiskProperties

Properties of the disk to attach.

options
DisksAttachOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginAttachAndWait(string, string, string, string, AttachDiskProperties, DisksAttachOptionalParams)

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

function beginAttachAndWait(resourceGroupName: string, labName: string, userName: string, name: string, attachDiskProperties: AttachDiskProperties, options?: DisksAttachOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

attachDiskProperties
AttachDiskProperties

Properties of the disk to attach.

options
DisksAttachOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, string, string, Disk, DisksCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, disk: Disk, options?: DisksCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Disk>, Disk>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

disk
Disk

A Disk.

options
DisksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Disk>, Disk>>

beginCreateOrUpdateAndWait(string, string, string, string, Disk, DisksCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, userName: string, name: string, disk: Disk, options?: DisksCreateOrUpdateOptionalParams): Promise<Disk>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

disk
Disk

A Disk.

options
DisksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Disk>

beginDelete(string, string, string, string, DisksDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, labName: string, userName: string, name: string, options?: DisksDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

options
DisksDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, DisksDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, labName: string, userName: string, name: string, options?: DisksDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

options
DisksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDetach(string, string, string, string, DetachDiskProperties, DisksDetachOptionalParams)

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

function beginDetach(resourceGroupName: string, labName: string, userName: string, name: string, detachDiskProperties: DetachDiskProperties, options?: DisksDetachOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

detachDiskProperties
DetachDiskProperties

Properties of the disk to detach.

options
DisksDetachOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDetachAndWait(string, string, string, string, DetachDiskProperties, DisksDetachOptionalParams)

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

function beginDetachAndWait(resourceGroupName: string, labName: string, userName: string, name: string, detachDiskProperties: DetachDiskProperties, options?: DisksDetachOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

detachDiskProperties
DetachDiskProperties

Properties of the disk to detach.

options
DisksDetachOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, DisksGetOptionalParams)

Get disk.

function get(resourceGroupName: string, labName: string, userName: string, name: string, options?: DisksGetOptionalParams): Promise<Disk>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

options
DisksGetOptionalParams

The options parameters.

Returns

Promise<Disk>

list(string, string, string, DisksListOptionalParams)

List disks in a given user profile.

function list(resourceGroupName: string, labName: string, userName: string, options?: DisksListOptionalParams): PagedAsyncIterableIterator<Disk, Disk[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

options
DisksListOptionalParams

The options parameters.

Returns

update(string, string, string, string, DiskFragment, DisksUpdateOptionalParams)

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

function update(resourceGroupName: string, labName: string, userName: string, name: string, disk: DiskFragment, options?: DisksUpdateOptionalParams): Promise<Disk>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

userName

string

The name of the user profile.

name

string

The name of the disk.

disk
DiskFragment

A Disk.

options
DisksUpdateOptionalParams

The options parameters.

Returns

Promise<Disk>