Volumes interface

Package:

@azure/arm-networkcloud

Interface representing a Volumes.

Methods

beginCreateOrUpdate(string, string, Volume, VolumesCreateOrUpdateOptionalParams)	Create a new volume or update the properties of the existing one.
beginCreateOrUpdateAndWait(string, string, Volume, VolumesCreateOrUpdateOptionalParams)	Create a new volume or update the properties of the existing one.
beginDelete(string, string, VolumesDeleteOptionalParams)	Delete the provided volume.
beginDeleteAndWait(string, string, VolumesDeleteOptionalParams)	Delete the provided volume.
get(string, string, VolumesGetOptionalParams)	Get properties of the provided volume.
listByResourceGroup(string, VolumesListByResourceGroupOptionalParams)	Get a list of volumes in the provided resource group.
listBySubscription(VolumesListBySubscriptionOptionalParams)	Get a list of volumes in the provided subscription.
update(string, string, VolumesUpdateOptionalParams)	Update tags associated with the provided volume.

Method Details

beginCreateOrUpdate(string, string, Volume, VolumesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, volumeName: string, volumeParameters: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>

Parameters

resourceGroupName

string

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

volumeName

string

The name of the volume.

volumeParameters

Volume

The request body.

options

VolumesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Volume>, Volume>>

beginCreateOrUpdateAndWait(string, string, Volume, VolumesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, volumeName: string, volumeParameters: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<Volume>

Parameters

resourceGroupName

string

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

volumeName

string

The name of the volume.

volumeParameters

Volume

The request body.

options

VolumesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Volume>

beginDelete(string, string, VolumesDeleteOptionalParams)

Delete the provided volume.

function beginDelete(resourceGroupName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

volumeName

string

The name of the volume.

options

VolumesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VolumesDeleteOptionalParams)

Delete the provided volume.

function beginDeleteAndWait(resourceGroupName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

volumeName

string

The name of the volume.

options

VolumesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VolumesGetOptionalParams)

Get properties of the provided volume.

function get(resourceGroupName: string, volumeName: string, options?: VolumesGetOptionalParams): Promise<Volume>

Parameters

resourceGroupName

string

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

volumeName

string

The name of the volume.

options

VolumesGetOptionalParams

The options parameters.

Returns

Promise<Volume>

listByResourceGroup(string, VolumesListByResourceGroupOptionalParams)

Get a list of volumes in the provided resource group.

function listByResourceGroup(resourceGroupName: string, options?: VolumesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

Parameters

resourceGroupName

string

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

options

VolumesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

listBySubscription(VolumesListBySubscriptionOptionalParams)

Get a list of volumes in the provided subscription.

function listBySubscription(options?: VolumesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

Parameters

options

VolumesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

update(string, string, VolumesUpdateOptionalParams)

Update tags associated with the provided volume.

function update(resourceGroupName: string, volumeName: string, options?: VolumesUpdateOptionalParams): Promise<Volume>

Parameters

resourceGroupName

string

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

volumeName

string

The name of the volume.

options

VolumesUpdateOptionalParams

The options parameters.

Returns

Promise<Volume>