Volume interface
Interface representing a Volume.
Methods
| create(string, string, Volume |
Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties. |
| delete(string, string, Volume |
Deletes the volume resource identified by the name. |
| get(string, string, Volume |
Gets the information about the volume resource with the given name. The information include the description and other properties of the volume. |
| list |
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume. |
| list |
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume. |
Method Details
create(string, string, VolumeResourceDescription, VolumeCreateOptionalParams)
Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.
function create(resourceGroupName: string, volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, options?: VolumeCreateOptionalParams): Promise<VolumeResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- volumeResourceDescription
- VolumeResourceDescription
Description for creating a Volume resource.
- options
- VolumeCreateOptionalParams
The options parameters.
Returns
Promise<VolumeResourceDescription>
delete(string, string, VolumeDeleteOptionalParams)
Deletes the volume resource identified by the name.
function delete(resourceGroupName: string, volumeResourceName: string, options?: VolumeDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- options
- VolumeDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, VolumeGetOptionalParams)
Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.
function get(resourceGroupName: string, volumeResourceName: string, options?: VolumeGetOptionalParams): Promise<VolumeResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- options
- VolumeGetOptionalParams
The options parameters.
Returns
Promise<VolumeResourceDescription>
listByResourceGroup(string, VolumeListByResourceGroupOptionalParams)
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
function listByResourceGroup(resourceGroupName: string, options?: VolumeListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VolumeResourceDescription, VolumeResourceDescription[], PageSettings>Parameters
- resourceGroupName
-
string
Azure resource group name
The options parameters.
Returns
listBySubscription(VolumeListBySubscriptionOptionalParams)
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
function listBySubscription(options?: VolumeListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VolumeResourceDescription, VolumeResourceDescription[], PageSettings>Parameters
The options parameters.
Returns
Azure SDK for JavaScript