Package version:

Interface Subvolumes

Interface representing a Subvolumes.

interface Subvolumes {
    beginCreate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumeInfo, options?: SubvolumesCreateOptionalParams): Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>;
    beginCreateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumeInfo, options?: SubvolumesCreateOptionalParams): Promise<SubvolumeInfo>;
    beginDelete(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesDeleteOptionalParams): Promise<void>;
    beginGetMetadata(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetMetadataOptionalParams): Promise<SimplePollerLike<OperationState<SubvolumeModel>, SubvolumeModel>>;
    beginGetMetadataAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetMetadataOptionalParams): Promise<SubvolumeModel>;
    beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumePatchRequest, options?: SubvolumesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>;
    beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumePatchRequest, options?: SubvolumesUpdateOptionalParams): Promise<SubvolumeInfo>;
    get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetOptionalParams): Promise<SubvolumeInfo>;
    listByVolume(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: SubvolumesListByVolumeOptionalParams): PagedAsyncIterableIterator<SubvolumeInfo>;
}

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginGetMetadata beginGetMetadataAndWait beginUpdate beginUpdateAndWait get listByVolume

Methods

beginCreate

  • beginCreate(resourceGroupName, accountName, poolName, volumeName, subvolumeName, body, options?): Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>

  • Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • body: SubvolumeInfo

      Subvolume object supplied in the body of the operation.

    • Optionaloptions: SubvolumesCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>

beginCreateAndWait

  • beginCreateAndWait(resourceGroupName, accountName, poolName, volumeName, subvolumeName, body, options?): Promise<SubvolumeInfo>

  • Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • body: SubvolumeInfo

      Subvolume object supplied in the body of the operation.

    • Optionaloptions: SubvolumesCreateOptionalParams

      The options parameters.

    Returns Promise<SubvolumeInfo>

beginDelete

  • beginDelete(resourceGroupName, accountName, poolName, volumeName, subvolumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Delete subvolume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • Optionaloptions: SubvolumesDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, accountName, poolName, volumeName, subvolumeName, options?): Promise<void>

  • Delete subvolume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • Optionaloptions: SubvolumesDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginGetMetadata

  • beginGetMetadata(resourceGroupName, accountName, poolName, volumeName, subvolumeName, options?): Promise<SimplePollerLike<OperationState<SubvolumeModel>, SubvolumeModel>>

  • Get details of the specified subvolume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • Optionaloptions: SubvolumesGetMetadataOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<SubvolumeModel>, SubvolumeModel>>

beginGetMetadataAndWait

  • beginGetMetadataAndWait(resourceGroupName, accountName, poolName, volumeName, subvolumeName, options?): Promise<SubvolumeModel>

  • Get details of the specified subvolume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • Optionaloptions: SubvolumesGetMetadataOptionalParams

      The options parameters.

    Returns Promise<SubvolumeModel>

beginUpdate

  • beginUpdate(resourceGroupName, accountName, poolName, volumeName, subvolumeName, body, options?): Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>

  • Patch a subvolume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • body: SubvolumePatchRequest

      Subvolume object supplied in the body of the operation.

    • Optionaloptions: SubvolumesUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, accountName, poolName, volumeName, subvolumeName, body, options?): Promise<SubvolumeInfo>

  • Patch a subvolume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • body: SubvolumePatchRequest

      Subvolume object supplied in the body of the operation.

    • Optionaloptions: SubvolumesUpdateOptionalParams

      The options parameters.

    Returns Promise<SubvolumeInfo>

get

  • get(resourceGroupName, accountName, poolName, volumeName, subvolumeName, options?): Promise<SubvolumeInfo>

  • Returns the path associated with the subvolumeName provided

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • subvolumeName: string

      The name of the subvolume.

    • Optionaloptions: SubvolumesGetOptionalParams

      The options parameters.

    Returns Promise<SubvolumeInfo>

listByVolume

  • listByVolume(resourceGroupName, accountName, poolName, volumeName, options?): PagedAsyncIterableIterator<SubvolumeInfo>

  • Returns a list of the subvolumes in the volume

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • poolName: string

      The name of the capacity pool

    • volumeName: string

      The name of the volume

    • Optionaloptions: SubvolumesListByVolumeOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<SubvolumeInfo>

Settings

Member Visibility