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

 

Applies To: Windows Azure Pack

Gets a Service [SPFSDK][VMMREF] entity by using the HTTP GET operation.

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

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

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

Method

Request URI

HTTP Version

GET

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

HTTP/1.1

GET

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

HTTP/1.1

URI Parameter

Description

ID

[Edm.Guid] The identifier of the entity.

StampId

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

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

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

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

The response body will contain either (depending on the request headers) an XML or JSON encoded Service [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#Services/@Element",
  "ID": "8a8b4ce5-67f2-4e2a-b31e-52f9cd8462a3",
  "Description": "",
  "Name": "Network Gateway 1",
  "StampId": "56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
  "NewServiceDeployment": {
    "ServiceConfiguration": {
      "ServiceSettings": [
        {
          "Name": null,
          "Value": null,
          "Description": null,
          "IsRequired": false,
          "IsEncrypted": false
        }
      ],
      "Name": null,
      "Description": null,
      "CostCenter": null,
      "Tag": null,
      "Priority": null
    },
    "TierConfigurations": [
      {
        "Name": null,
        "VMConfigurations": [
          {
            "VMName": null,
            "ComputerName": null,
            "Description": null,
            "CostCenter": null,
            "Tag": null
          }
        ]
      }
    ]
  },
  "Owner": {
    "UserName": null,
    "RoleName": null,
    "RoleID": null
  },
  "GrantedToList": [
    {
      "UserName": null,
      "RoleName": "tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06",
      "RoleID": "86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"
    }
  ],
  "AllVMsAccessible": null,
  "CostCenter": "",
  "DeploymentState": "Deployed",
  "DeployedTo": "Cloud",
  "InServicingMode": false,
  "OverallStatus": "OK",
  "PendingServiceTemplatePresent": false,
  "PendingServiceTemplateRelease": null,
  "ServicePriority": "Normal",
  "ServiceTemplateRelease": null,
  "ServiceStatus": "OK",
  "VMHostGroup": null,
  "Enabled": true,
  "AddedTime": "2014-04-29T16:44:11.6-07:00",
  "ModifiedTime": "2014-06-25T17:37:41.4166979-07:00",
  "NotificationsAvailable": false,
  "Accessibility": "Public",
  "Operation": null,
  "IgnorePlacementErrors": null,
  "FailedJobID": null,
  "CloudId": "d1f15abc-672d-464b-b3bc-376d2087bb8e",
  "ServiceTemplateId": "20a730c8-228a-4d6a-9a8f-6506b21236a9",
  "CustomProperty": [],
  "PendingServiceSettings": [],
  "ServiceSettings": [
    {
      "Name": "External",
      "Description": "",
      "Value": "af6a7248-9d48-4149-917c-a6239e502a39",
      "Mandatory": true,
      "HasEncryptedValue": false,
      "IsSecure": false,
      "GlobalSettingType": "VMNetwork"
    },
    {
      "Name": "LocalAdmin",
      "Description": "",
      "Value": "dd9279c1-b3cb-4aff-9df4-a337498b087d",
      "Mandatory": false,
      "HasEncryptedValue": false,
      "IsSecure": false,
      "GlobalSettingType": "RunAsAccount"
    },
    {
      "Name": "Infrastructure",
      "Description": "",
      "Value": "c94721a2-b175-42bc-9ea2-65341cb789c2",
      "Mandatory": true,
      "HasEncryptedValue": false,
      "IsSecure": false,
      "GlobalSettingType": "VMNetwork"
    }
  ],
  "ServicingWindow": {
    "Category": null,
    "Name": null,
    "Description": null,
    "Owner": null,
    "TimeZone": null,
    "StartDate": null,
    "StartTimeOfDay": null,
    "WeeklyScheduleDayOfWeek": null,
    "MonthlyScheduleDayOfWeek": null,
    "DayOfMonth": null,
    "WeekOfMonth": null,
    "DaysToRecur": null,
    "MonthsToRecur": null,
    "WeeksToRecur": null,
    "MinutesDuration": null,
    "ScheduleType": null
  }
}

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

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/Services 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/1.1 200 OK
Cache-Control: no-cache
Content-Length: 2454
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-0c38-c35fe663cf01
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, 11 Jul 2014 21:26:32 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#Services","value":[{"ID":"8a8b4ce5-67f2-4e2a-b31e-52f9cd8462a3","Description":"","Name":"Network Gateway 1","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","NewServiceDeployment":{"ServiceConfiguration":{"ServiceSettings":[{"Name":null,"Value":null,"Description":null,"IsRequired":false,"IsEncrypted":false}],"Name":null,"Description":null,"CostCenter":null,"Tag":null,"Priority":null},"TierConfigurations":[{"Name":null,"VMConfigurations":[{"VMName":null,"ComputerName":null,"Description":null,"CostCenter":null,"Tag":null}]}]},"Owner":{"UserName":null,"RoleName":null,"RoleID":null},"GrantedToList":[{"UserName":null,"RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06","RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"}],"AllVMsAccessible":null,"CostCenter":"","DeploymentState":"Deployed","DeployedTo":"Cloud","InServicingMode":false,"OverallStatus":"OK","PendingServiceTemplatePresent":false,"PendingServiceTemplateRelease":null,"ServicePriority":"Normal","ServiceTemplateRelease":null,"ServiceStatus":"OK","VMHostGroup":null,"Enabled":true,"AddedTime":"2014-04-29T16:44:11.6-07:00","ModifiedTime":"2014-06-25T17:37:41.4166979-07:00","NotificationsAvailable":false,"Accessibility":"Public","Operation":null,"IgnorePlacementErrors":null,"FailedJobID":null,"CloudId":"d1f15abc-672d-464b-b3bc-376d2087bb8e","ServiceTemplateId":"20a730c8-228a-4d6a-9a8f-6506b21236a9","CustomProperty":[],"PendingServiceSettings":[],"ServiceSettings":[{"Name":"External","Description":"","Value":"af6a7248-9d48-4149-917c-a6239e502a39","Mandatory":true,"HasEncryptedValue":false,"IsSecure":false,"GlobalSettingType":"VMNetwork"},{"Name":"LocalAdmin","Description":"","Value":"dd9279c1-b3cb-4aff-9df4-a337498b087d","Mandatory":false,"HasEncryptedValue":false,"IsSecure":false,"GlobalSettingType":"RunAsAccount"},{"Name":"Infrastructure","Description":"","Value":"c94721a2-b175-42bc-9ea2-65341cb789c2","Mandatory":true,"HasEncryptedValue":false,"IsSecure":false,"GlobalSettingType":"VMNetwork"}],"ServicingWindow":{"Category":null,"Name":null,"Description":null,"Owner":null,"TimeZone":null,"StartDate":null,"StartTimeOfDay":null,"WeeklyScheduleDayOfWeek":null,"MonthlyScheduleDayOfWeek":null,"DayOfMonth":null,"WeekOfMonth":null,"DaysToRecur":null,"MonthsToRecur":null,"WeeksToRecur":null,"MinutesDuration":null,"ScheduleType":null}}]}

This example reads a specific service 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 serviceId = new Guid("8a8b4ce5-67f2-4e2a-b31e-52f9cd8462a3");

var service = vmmService.Services.Where(s => s.StampId == stampId && s.ID == serviceId).First();


GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/Services(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'8a8b4ce5-67f2-4e2a-b31e-52f9cd8462a3') 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/1.1 200 OK
Cache-Control: no-cache
Content-Length: 2451
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-1235-c35fe663cf01
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, 11 Jul 2014 17:29:32 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#Services/@Element","ID":"8a8b4ce5-67f2-4e2a-b31e-52f9cd8462a3","Description":"","Name":"Network Gateway 1","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","NewServiceDeployment":{"ServiceConfiguration":{"ServiceSettings":[{"Name":null,"Value":null,"Description":null,"IsRequired":false,"IsEncrypted":false}],"Name":null,"Description":null,"CostCenter":null,"Tag":null,"Priority":null},"TierConfigurations":[{"Name":null,"VMConfigurations":[{"VMName":null,"ComputerName":null,"Description":null,"CostCenter":null,"Tag":null}]}]},"Owner":{"UserName":null,"RoleName":null,"RoleID":null},"GrantedToList":[{"UserName":null,"RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06","RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"}],"AllVMsAccessible":null,"CostCenter":"","DeploymentState":"Deployed","DeployedTo":"Cloud","InServicingMode":false,"OverallStatus":"OK","PendingServiceTemplatePresent":false,"PendingServiceTemplateRelease":null,"ServicePriority":"Normal","ServiceTemplateRelease":null,"ServiceStatus":"OK","VMHostGroup":null,"Enabled":true,"AddedTime":"2014-04-29T16:44:11.6-07:00","ModifiedTime":"2014-06-25T17:37:41.4166979-07:00","NotificationsAvailable":false,"Accessibility":"Public","Operation":null,"IgnorePlacementErrors":null,"FailedJobID":null,"CloudId":"d1f15abc-672d-464b-b3bc-376d2087bb8e","ServiceTemplateId":"20a730c8-228a-4d6a-9a8f-6506b21236a9","CustomProperty":[],"PendingServiceSettings":[],"ServiceSettings":[{"Name":"External","Description":"","Value":"af6a7248-9d48-4149-917c-a6239e502a39","Mandatory":true,"HasEncryptedValue":false,"IsSecure":false,"GlobalSettingType":"VMNetwork"},{"Name":"LocalAdmin","Description":"","Value":"dd9279c1-b3cb-4aff-9df4-a337498b087d","Mandatory":false,"HasEncryptedValue":false,"IsSecure":false,"GlobalSettingType":"RunAsAccount"},{"Name":"Infrastructure","Description":"","Value":"c94721a2-b175-42bc-9ea2-65341cb789c2","Mandatory":true,"HasEncryptedValue":false,"IsSecure":false,"GlobalSettingType":"VMNetwork"}],"ServicingWindow":{"Category":null,"Name":null,"Description":null,"Owner":null,"TimeZone":null,"StartDate":null,"StartTimeOfDay":null,"WeeklyScheduleDayOfWeek":null,"MonthlyScheduleDayOfWeek":null,"DayOfMonth":null,"WeekOfMonth":null,"DaysToRecur":null,"MonthsToRecur":null,"WeeksToRecur":null,"MinutesDuration":null,"ScheduleType":null}}

Show: