Package version:

Interface VolumeGroups

Interface representing a VolumeGroups.

interface VolumeGroups {
    beginCreate(resourceGroupName: string, accountName: string, volumeGroupName: string, body: VolumeGroupDetails, options?: VolumeGroupsCreateOptionalParams): Promise<SimplePollerLike<OperationState<VolumeGroupDetails>, VolumeGroupDetails>>;
    beginCreateAndWait(resourceGroupName: string, accountName: string, volumeGroupName: string, body: VolumeGroupDetails, options?: VolumeGroupsCreateOptionalParams): Promise<VolumeGroupDetails>;
    beginDelete(resourceGroupName: string, accountName: string, volumeGroupName: string, options?: VolumeGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, accountName: string, volumeGroupName: string, options?: VolumeGroupsDeleteOptionalParams): Promise<void>;
    get(resourceGroupName: string, accountName: string, volumeGroupName: string, options?: VolumeGroupsGetOptionalParams): Promise<VolumeGroupDetails>;
    listByNetAppAccount(resourceGroupName: string, accountName: string, options?: VolumeGroupsListByNetAppAccountOptionalParams): PagedAsyncIterableIterator<VolumeGroup>;
}

Methods

beginCreate(resourceGroupName, accountName, volumeGroupName, body, options?): Promise<SimplePollerLike<OperationState<VolumeGroupDetails>, VolumeGroupDetails>>
Create a volume group along with specified volumes
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- volumeGroupName: string
  The name of the volumeGroup
- body: VolumeGroupDetails
  Volume Group object supplied in the body of the operation.
- Optionaloptions: VolumeGroupsCreateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VolumeGroupDetails>, VolumeGroupDetails>>
- Defined in operationsInterfaces/volumeGroups.ts:57

beginCreateAndWait(resourceGroupName, accountName, volumeGroupName, body, options?): Promise<VolumeGroupDetails>
Create a volume group along with specified volumes
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- volumeGroupName: string
  The name of the volumeGroup
- body: VolumeGroupDetails
  Volume Group object supplied in the body of the operation.
- Optionaloptions: VolumeGroupsCreateOptionalParams
  The options parameters.
Returns Promise<VolumeGroupDetails>
- Defined in operationsInterfaces/volumeGroups.ts:77

beginDelete(resourceGroupName, accountName, volumeGroupName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Delete the specified volume group only if there are no volumes under volume group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- volumeGroupName: string
  The name of the volumeGroup
- Optionaloptions: VolumeGroupsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumeGroups.ts:91

beginDeleteAndWait(resourceGroupName, accountName, volumeGroupName, options?): Promise<void>
Delete the specified volume group only if there are no volumes under volume group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- volumeGroupName: string
  The name of the volumeGroup
- Optionaloptions: VolumeGroupsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumeGroups.ts:104

get(resourceGroupName, accountName, volumeGroupName, options?): Promise<VolumeGroupDetails>
Get details of the specified volume group
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- volumeGroupName: string
  The name of the volumeGroup
- Optionaloptions: VolumeGroupsGetOptionalParams
  The options parameters.
Returns Promise<VolumeGroupDetails>
- Defined in operationsInterfaces/volumeGroups.ts:43

listByNetAppAccount(resourceGroupName, accountName, options?): PagedAsyncIterableIterator<VolumeGroup>
List all volume groups for given account
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- accountName: string
  The name of the NetApp account
- Optionaloptions: VolumeGroupsListByNetAppAccountOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VolumeGroup>
- Defined in operationsInterfaces/volumeGroups.ts:31