Share via

Read (GET) an ISO [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

Gets an ISO [SPFSDK][VMMREF] entity or a set of entities by using the HTTP GET operation.

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

  • Example: Get a specific ISO object

  • Example: Get all ISO objects

Request

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

For more information about the placeholders used in the URI, see URL placeholders.

Method

Request URI

HTTP Version

GET

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

HTTP/1.1

GET

https://{server}:{auth-port}/{subscription-id}/services/systemcenter/vmm/ISOs

HTTP/1.1

Request URI Parameters

This table only applies when reading a specific entity.

URI Parameter

Description

ID

[Edm.Guid] The identifier of the entity.

StampId

[Edm.Guid] The identifier of the stamp that restricts the query.

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 ISO [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.

{
  "odata.metadata": "https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#ISOs/@Element",
  "ID": "9c776401-cd9b-42be-9cc6-8aab2d8c6a1d",
  "State": "Normal",
  "SharePath": "\\\\vmm.contoso.com\\MSSCVMMLibrary\\VHDs\\test.iso",
  "Directory": "\\\\vmm.contoso.com\\MSSCVMMLibrary\\VHDs",
  "Size": "12765213",
  "LibraryGroup": "",
  "Owner": {
    "UserName": null,
    "RoleName": null,
    "RoleID": null
  },
  "OwnerSid": null,
  "Accessibility": "Public",
  "Name": "test.iso",
  "Description": "Test ISO",
  "AddedTime": "2014-01-15T14:33:26.88-08:00",
  "ModifiedTime": "2014-01-16T13:19:14.073-08:00",
  "Enabled": true,
  "StampId": "56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
  "FamilyName": "SPF-Test",
  "HostVolumeId": null,
  "IsOrphaned": false,
  "LibraryShareId": "018f4b4c-d873-4a26-947d-6cd9264c2b66",
  "Namespace": "Global",
  "CloudId": null,
  "Release": "SPF-Test"
}

Example: Get all ISO objects

This example reads all the ISOs 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 isos = vmmService.ISOs.ToList();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/ISOs 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
Connection: Keep-Alive

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 835
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-397c-c15fe663cf01
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: Wed, 11 Jun 2014 22:29:20 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#ISOs","value":[{"ID":"9c776401-cd9b-42be-9cc6-8aab2d8c6a1d","State":"Normal","SharePath":"\\\\vmm.contoso.com\\MSSCVMMLibrary\\VHDs\\test.iso","Directory":"\\\\vmm.contoso.com\\MSSCVMMLibrary\\VHDs","Size":"12765213","LibraryGroup":"","Owner":{"UserName":null,"RoleName":null,"RoleID":null},"OwnerSid":null,"Accessibility":"Public","Name":"test.iso","Description":"Test ISO","AddedTime":"2014-01-15T14:33:26.88-08:00","ModifiedTime":"2014-01-16T13:19:14.073-08:00","Enabled":true,"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","FamilyName":"SPF-Test","HostVolumeId":null,"IsOrphaned":false,"LibraryShareId":"018f4b4c-d873-4a26-947d-6cd9264c2b66","Namespace":"Global","CloudId":null,"Release":"SPF-Test"}]}

Example: Get a specific ISO object

This example reads a specific ISO by 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("56ebc6dc-f63c-46e2-8438-2967e0ad83bc");
Guid isoId = new Guid("9c776401-cd9b-42be-9cc6-8aab2d8c6a1d");

var iso = vmmService.ISOs.Where(i => i.StampId == stampId && i.ID == isoId).First();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/ISOs(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'9c776401-cd9b-42be-9cc6-8aab2d8c6a1d') 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: 832
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-957e-c15fe663cf01
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: Thu, 12 Jun 2014 01:22:17 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#ISOs/@Element","ID":"9c776401-cd9b-42be-9cc6-8aab2d8c6a1d","State":"Normal","SharePath":"\\\\vmm.contoso.com\\MSSCVMMLibrary\\VHDs\\test.iso","Directory":"\\\\vmm.contoso.com\\MSSCVMMLibrary\\VHDs","Size":"12765213","LibraryGroup":"","Owner":{"UserName":null,"RoleName":null,"RoleID":null},"OwnerSid":null,"Accessibility":"Public","Name":"test.iso","Description":"Test ISO","AddedTime":"2014-01-15T14:33:26.88-08:00","ModifiedTime":"2014-01-16T13:19:14.073-08:00","Enabled":true,"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","FamilyName":"SPF-Test","HostVolumeId":null,"IsOrphaned":false,"LibraryShareId":"018f4b4c-d873-4a26-947d-6cd9264c2b66","Namespace":"Global","CloudId":null,"Release":"SPF-Test"}

See Also

ISOs Collection [SPFSDK][VMMREF]
ISO [SPFSDK][VMMREF]