Share via

Read (GET) a LibraryShare [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

Get a LibraryShare [SPFSDK][VMMREF] entity by using the HTTP GET operation.

Here is a list of examples related to this collection operation.

  • Example: Get a specific library share

  • Example: Get all library shares

Request

For more information about returning multiple entities, see Common GET HTTP Info.

Method

Request URI

HTTP Version

GET

https://{server-name}:{auth-port}/{subscription-id}/services/systemcenter/vmm/LibraryShares(ID=Guid'[value]',StampId=Guid'[value]')

HTTP/1.1

Request URI Parameters

URI Parameter

Description

ID

[Edm.Guid] The type identifier of the entity. You require a value for this parameter to read a specific entity.

StampId

[Edm.Guid] The type identifier of the stamp that restricts the query. You require a value for this parameter to read a specific entity.

Request Headers

This operation does not use any non-standard request headers.

For more information about the common request headers used by this operation, see Common HTTP request information.

Request Body

None

Response

Response Codes

This operation does not return any non-standard OData response codes. If successful, it will return code 200 OK.

Response Headers

This operation does not use any non-standard response headers.

For more information about the common response headers used by this operation, see Common HTTP response information.

Response Body

The response body will contain either (depending on the request headers) an XML or JSON encoded LibraryShare [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.

{
  "odata.metadata": "https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#LibraryShares/@Element",
  "ID": "03f0e6b0-b6b3-4d6f-8756-2f6407bbec43",
  "StampId": "d70c1a9b-c241-48f5-880a-b6c36071e653",
  "Description": "",
  "Name": "Storage",
  "Path": "\\\\vmhost1\\Storage"
}

Example: Get all library shares

This example reads all the library shares available to the authenticated tenant.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

var shares = vmmService.LibraryShares.ToList();

HTTP Request

GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/LibraryShares HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 540
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: d3df681c-b278-0000-b37d-e2d378b2cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Fri, 19 Sep 2014 21:08:16 GMT

{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#LibraryShares","value":[{"ID":"03f0e6b0-b6b3-4d6f-8756-2f6407bbec43","StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653","Description":"","Name":"Storage","Path":"\\\\vmhost1\\Storage"},{"ID":"1f2bdad5-7618-44df-b8d9-b390427c6f67","StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653","Description":"Virtual Machine Manager Library Files","Name":"MSSCVMMLibrary","Path":"\\\\vmmserver.contso.com\\MSSCVMMLibrary"}]}

Example: Get a specific library share

This example reads a specific library share by its identifier.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

Guid stampId = new Guid("d70c1a9b-c241-48f5-880a-b6c36071e653");
Guid shareId = new Guid("03f0e6b0-b6b3-4d6f-8756-2f6407bbec43");

var shares = vmmService.LibraryShares.Where(s => s.StampId == stampId && s.ID == shareId).First();

HTTP Request

GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/LibraryShares(StampId=guid'd70c1a9b-c241-48f5-880a-b6c36071e653',ID=guid'03f0e6b0-b6b3-4d6f-8756-2f6407bbec43') HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 317
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: d3df681c-b278-0000-bb7d-e2d378b2cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Fri, 19 Sep 2014 21:08:31 GMT

{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#LibraryShares/@Element","ID":"03f0e6b0-b6b3-4d6f-8756-2f6407bbec43","StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653","Description":"","Name":"Storage","Path":"\\\\vmhost1\\Storage"}

See Also

LibraryShares Collection [SPFSDK][VMMREF]
LibraryShare [SPFSDK][VMMREF]