Package version:

Interface Volumes

Interface representing a Volumes.

Hierarchy

Volumes

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByVolumeGroup

Methods

beginCreate

beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<PollerLike<PollOperationState<Volume>, Volume>>
Create a Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- parameters: Volume
  
  Volume object.
- Optional options: VolumesCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Volume>, Volume>>
- Defined in operationsInterfaces/volumes.ts:49

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<Volume>
Create a Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- parameters: Volume
  
  Volume object.
- Optional options: VolumesCreateOptionalParams
  
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:68

beginDelete

beginDelete(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Delete an Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- Optional options: VolumesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:120

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<void>
Delete an Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- Optional options: VolumesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:135

beginUpdate

beginUpdate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: VolumeUpdate, options?: VolumesUpdateOptionalParams): Promise<PollerLike<PollOperationState<Volume>, Volume>>
Update an Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- parameters: VolumeUpdate
  
  Volume object.
- Optional options: VolumesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Volume>, Volume>>
- Defined in operationsInterfaces/volumes.ts:85

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: VolumeUpdate, options?: VolumesUpdateOptionalParams): Promise<Volume>
Update an Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- parameters: VolumeUpdate
  
  Volume object.
- Optional options: VolumesUpdateOptionalParams
  
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:104

get

get(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, options?: VolumesGetOptionalParams): Promise<Volume>
Get an Volume.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- volumeName: string
  
  The name of the Volume.
- Optional options: VolumesGetOptionalParams
  
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:150

listByVolumeGroup

listByVolumeGroup(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumesListByVolumeGroupOptionalParams): PagedAsyncIterableIterator<Volume>
List Volumes in a VolumeGroup.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- elasticSanName: string
  
  The name of the ElasticSan.
- volumeGroupName: string
  
  The name of the VolumeGroup.
- Optional options: VolumesListByVolumeGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Volume>
- Defined in operationsInterfaces/volumes.ts:34

Interface Volumes

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

parameters: Volume

Optional options: VolumesCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<Volume>, Volume>>

beginCreateAndWait

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

parameters: Volume

Optional options: VolumesCreateOptionalParams

Returns Promise<Volume>

beginDelete

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

Optional options: VolumesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

Optional options: VolumesDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

parameters: VolumeUpdate

Optional options: VolumesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Volume>, Volume>>

beginUpdateAndWait

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

parameters: VolumeUpdate

Optional options: VolumesUpdateOptionalParams

Returns Promise<Volume>

get

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

volumeName: string

Optional options: VolumesGetOptionalParams

Returns Promise<Volume>

listByVolumeGroup

Parameters

resourceGroupName: string

elasticSanName: string

volumeGroupName: string

Optional options: VolumesListByVolumeGroupOptionalParams

Returns PagedAsyncIterableIterator<Volume>

Settings

Member Visibility

Theme

`Optional` options: VolumesCreateOptionalParams

`Optional` options: VolumesCreateOptionalParams

`Optional` options: VolumesDeleteOptionalParams

`Optional` options: VolumesDeleteOptionalParams

`Optional` options: VolumesUpdateOptionalParams

`Optional` options: VolumesUpdateOptionalParams

`Optional` options: VolumesGetOptionalParams

`Optional` options: VolumesListByVolumeGroupOptionalParams