Package version:

Interface representing a Volumes.

Hierarchy

  • Volumes

Methods

  • Creates or updates the volume.

    Parameters

    • deviceName: string

      The device name

    • volumeContainerName: string

      The volume container name.

    • volumeName: string

      The volume name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • parameters: Volume

      Volume to be created or updated.

    • Optional options: VolumesCreateOrUpdateOptionalParams

      The options parameters.

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

  • Creates or updates the volume.

    Parameters

    • deviceName: string

      The device name

    • volumeContainerName: string

      The volume container name.

    • volumeName: string

      The volume name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • parameters: Volume

      Volume to be created or updated.

    • Optional options: VolumesCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<Volume>

  • Deletes the volume.

    Parameters

    • deviceName: string

      The device name

    • volumeContainerName: string

      The volume container name.

    • volumeName: string

      The volume name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: VolumesDeleteOptionalParams

      The options parameters.

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

  • Deletes the volume.

    Parameters

    • deviceName: string

      The device name

    • volumeContainerName: string

      The volume container name.

    • volumeName: string

      The volume name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: VolumesDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

  • Returns the properties of the specified volume name.

    Parameters

    • deviceName: string

      The device name

    • volumeContainerName: string

      The volume container name.

    • volumeName: string

      The volume name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • Optional options: VolumesGetOptionalParams

      The options parameters.

    Returns Promise<Volume>

  • Gets the metrics for the specified volume.

    Parameters

    • deviceName: string

      The device name

    • volumeContainerName: string

      The volume container name.

    • volumeName: string

      The volume name.

    • resourceGroupName: string

      The resource group name

    • managerName: string

      The manager name

    • filter: string

      OData Filter options

    • Optional options: VolumesListMetricsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Metrics>

Generated using TypeDoc