Volumes interface
Interface representing a Volumes.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)
Creates or updates the volume.
function beginCreateOrUpdate(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, parameters: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Volume>, 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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Volume>, Volume>>
beginCreateOrUpdateAndWait(string, string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)
Creates or updates the volume.
function beginCreateOrUpdateAndWait(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, parameters: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<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.
The options parameters.
Returns
Promise<Volume>
beginDelete(string, string, string, string, string, VolumesDeleteOptionalParams)
Deletes the volume.
function beginDelete(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, options?: VolumesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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
- options
- VolumesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, VolumesDeleteOptionalParams)
Deletes the volume.
function beginDeleteAndWait(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, options?: VolumesDeleteOptionalParams): Promise<void>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
- options
- VolumesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, VolumesGetOptionalParams)
Returns the properties of the specified volume name.
function get(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, options?: VolumesGetOptionalParams): Promise<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
- options
- VolumesGetOptionalParams
The options parameters.
Returns
Promise<Volume>
listByDevice(string, string, string, VolumesListByDeviceOptionalParams)
Retrieves all the volumes in a device.
function listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: VolumesListByDeviceOptionalParams): PagedAsyncIterableIterator<Volume, Volume[], PageSettings>Parameters
- deviceName
-
string
The device name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listByVolumeContainer(string, string, string, string, VolumesListByVolumeContainerOptionalParams)
Retrieves all the volumes in a volume container.
function listByVolumeContainer(deviceName: string, volumeContainerName: string, resourceGroupName: string, managerName: string, options?: VolumesListByVolumeContainerOptionalParams): PagedAsyncIterableIterator<Volume, Volume[], PageSettings>Parameters
- deviceName
-
string
The device name
- volumeContainerName
-
string
The volume container name.
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
The options parameters.
Returns
listMetricDefinition(string, string, string, string, string, VolumesListMetricDefinitionOptionalParams)
Gets the metric definitions for the specified volume.
function listMetricDefinition(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, options?: VolumesListMetricDefinitionOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], PageSettings>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
The options parameters.
Returns
listMetrics(string, string, string, string, string, string, VolumesListMetricsOptionalParams)
Gets the metrics for the specified volume.
function listMetrics(deviceName: string, volumeContainerName: string, volumeName: string, resourceGroupName: string, managerName: string, filter: string, options?: VolumesListMetricsOptionalParams): PagedAsyncIterableIterator<Metrics, Metrics[], PageSettings>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
- options
- VolumesListMetricsOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript