Get Volume Resource

Gets the volume resource.

Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.

Request

Method Request URI
GET /Resources/Volumes/{volumeResourceName}?api-version=6.3-preview

Parameters

Name Type Required Location
volumeResourceName string Yes Path
api-version string Yes Query

volumeResourceName

Type: string
Required: Yes

Service Fabric volume resource name.


api-version

Type: string
Required: Yes
Default: 6.3-preview

The version of the API. This parameter is required and its value must be '6.3-preview'.

Responses

HTTP Status Code Description Response Schema
200 (OK) OK
VolumeResourceDescription
All other status codes Error
FabricError

Examples

GetVolumeResource

This example shows how to get an volume resource.

Request

GET http://localhost:19080/Resources/Volumes/meshDemoVolume?api-version=6.3-preview

200 Response

Body
{
  "name": "meshDemoVolume",
  "properties": {
    "description": "SeaBreeze HelloWorld Application!",
    "provider": "SFAzureFile",
    "azureFileParameters": {
      "accountName": "sbzdemoaccount",
      "shareName": "sharel"
    }
  }
}