Get

Gets the Volume resource with the given name.

Gets the information about the Volume resource with the given name. The information include the description and other properties of the Volume.

Request

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

Parameters

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

volumeResourceName

Type: string
Required: Yes

The identity of the volume.


api-version

Type: string
Required: Yes
Default: 6.4-preview

The version of the API. This parameter is required and its value must be '6.4-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 a volume resource. If the volume resource exists, its description is returned along with an OK (200) status code. If the volume resource does not exist, an error is returned with an appropriate status code.

Request

GET http://localhost:19080/Resources/Volumes/sampleVolume?api-version=6.4-preview

200 Response

Body
{
  "name": "sampleVolume",
  "properties": {
    "description": "Service Fabric Mesh sample volume.",
    "provider": "SFAzureFile",
    "azureFileParameters": {
      "accountName": "sbzdemoaccount",
      "accountKey": null,
      "shareName": "sharel"
    },
    "status": "Ready"
  }
}