Explore the Get request in the Service Fabric Mesh API

  • Article

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 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}?api-version=2018-07-01-preview

Parameters

Name Type Required Location
subscriptionId string Yes Path
resourceGroupName string Yes Path
volumeName string Yes Path
api-version string Yes Query

subscriptionId

Type: string
Required: Yes

The customer subscription identifier

resourceGroupName

Type: string
Required: Yes

Azure resource group name

volumeName

Type: string
Required: Yes

The identity of the volume.

api-version

Type: string
Required: Yes
Default: 2018-07-01-preview

The version of the API. This parameter is required and its value must be 2018-07-01-preview.

Responses

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

Examples

VolumeGet

Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume?api-version=2018-07-01-preview

200 Response

Body
{
  "type": "Microsoft.ServiceFabricMesh/volumes",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume",
  "name": "sbzDemoVolume",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "description": "File share backed by Azure Files storage.",
    "provider": "SFAzureFile",
    "azureFileParameters": {
      "shareName": "sharel",
      "accountName": "sbzdemoaccount"
    }
  }
}