Read (GET) a Cloud [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
Get a Cloud [SPFSDK][VMMREF] entity by using the HTTP GET operation.
Here is a list of examples related to this collection operation.
Example: Get all clouds available
Example: Get a specific cloud
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/Clouds(ID=Guid'[value]',StampId=Guid'[value]') |
HTTP/1.1 |
Request URI Parameters
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 Cloud [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#Clouds",
"value": [
{
"ID": "10f8e459-e7c3-4c40-b47c-b8f758ef4dc1",
"Name": "KatalCloud",
"Description": "",
"LastModifiedDate": null,
"WritableLibraryPath": "\\\\waplabhost1\\Storage\\",
"UserRoleID": null,
"StampId": "d70c1a9b-c241-48f5-880a-b6c36071e653"
}
]
}
Example: Get all clouds available
This example reads all the clouds 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 clouds = vmmService.Clouds.ToList();
HTTP Request
GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/Clouds 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: 375
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-eb6c-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: Thu, 18 Sep 2014 18:36:07 GMT
{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#Clouds","value":[{"ID":"10f8e459-e7c3-4c40-b47c-b8f758ef4dc1","Name":"KatalCloud","Description":"","LastModifiedDate":null,"WritableLibraryPath":"\\\\waplabhost1\\Storage\\","UserRoleID":null,"StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653"}]}
Example: Get a specific cloud
This example reads a specific cloud 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("d70c1a9b-c241-48f5-880a-b6c36071e653");
Guid id = new Guid("10f8e459-e7c3-4c40-b47c-b8f758ef4dc1");
var cloud = vmmService.Clouds.Where(c => c.StampId == stampId && c.ID == id).First();
HTTP Request
GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/Clouds(StampId=guid'd70c1a9b-c241-48f5-880a-b6c36071e653',ID=guid'10f8e459-e7c3-4c40-b47c-b8f758ef4dc1') 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: 372
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-276d-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: Thu, 18 Sep 2014 18:36:09 GMT
{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#Clouds/@Element","ID":"10f8e459-e7c3-4c40-b47c-b8f758ef4dc1","Name":"KatalCloud","Description":"","LastModifiedDate":null,"WritableLibraryPath":"\\\\waplabhost1.cdm.lab\\Storage\\","UserRoleID":null,"StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653"}