Read (GET) Variables
Read using the HTTP GET operation.
Code Examples
Request
Method | Request URI | HTTP Version |
---|---|---|
GET |
HTTPS://<HOST>:<PORT>/00000000-0000-0000-0000-000000000000/Variables(guid'<GUID>') |
HTTP/1.1 |
Request URI Parameters
URI Parameter | Description |
---|---|
GUID |
Required. The unique identifier value (VariableID) for a Variable entity. |
Request URI Example
Example URI |
---|
GET https://sma-server:9090/00000000-0000-0000-0000-000000000000/Variables(guid'159fb0d4-8c32-4388-8944-a7ac07678d18') HTTP/1.1 |
Request Headers
For more information about the common request headers used by this operation, see Standard Service Management Automation POST/GET/PUT/DELETE Headers.
Request Body
The GET operation has no request body.
Response
Response Codes
Response Code | Description |
---|---|
HTTP/1.1 200 OK |
Successful HTTP request. |
Response Headers
For more information about the common response headers used by this operation, see Standard Service Management Automation POST/GET/PUT/DELETE Headers.
Response Body
<?xml version="1.0" encoding="utf-8"?><entry xml:base="https://sma-server:9090/00000000-0000-0000-0000-000000000000/" xmlns="http://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://sma-server:9090/00000000-0000-0000-0000-000000000000/Variables(guid'159fb0d4-8c32-4388-8944-a7ac07678d18')</id>
<category term="Orchestrator.ResourceModel.Variable" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="edit" title="Variable" href="Variables(guid'159fb0d4-8c32-4388-8944-a7ac07678d18')" />
<title />
<updated>2014-04-01T15:04:36Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:VariableID m:type="Edm.Guid">159fb0d4-8c32-4388-8944-a7ac07678d18</d:VariableID>
<d:TenantID m:type="Edm.Guid">00000000-0000-0000-0000-000000000000</d:TenantID>
<d:Name>Test Variable Name</d:Name>
<d:Value>Test Variable Value</d:Value>
<d:Description>Test Variable Description</d:Description>
<d:IsEncrypted m:type="Edm.Boolean">false</d:IsEncrypted>
<d:CreationTime m:type="Edm.DateTime">2014-04-01T14:46:02.537</d:CreationTime>
<d:LastModifiedTime m:type="Edm.DateTime">2014-04-01T14:46:02.537</d:LastModifiedTime>
</m:properties>
</content>
</entry>
Code Examples
The following example searches for a specific Variable, identified by the VariableID (a unique guid value).
namespace CodeSample.Microsoft.SystemCenter.SMA
{
public class SMASamples
{
public static void Main()
{
// Replace this with the name of your SMA web service endpoint.
string serviceEndPoint = "https://sma-server:9090/00000000-0000-0000-0000-000000000000";
// Setup the connection to SMA
OrchestratorApi SMAService = new OrchestratorApi(new Uri(serviceEndPoint));
// Set credentials to the default or to a specific user.
((DataServiceContext)SMAService).Credentials = CredentialCache.DefaultCredentials;
//((DataServiceContext)SMAService).Credentials = new NetworkCredential("user", "pwd", "domain");
try
{
// Identify a specific variable instance to search for.
System.Guid variableID = new Guid("159fb0d4-8c32-4388-8944-a7ac07678d18");
// Query for the specific variable instance identified by VariableID.
var variable = SMAService.Variables.Where(r => r.VariableID == variableID).FirstOrDefault();
// Output select properties of the instance to the console.
Console.WriteLine("Found Variable ID : {0}", variable.VariableID);
Console.WriteLine("Found Variable Name : {0}", variable.Name);
Console.WriteLine("Found Variable Value : {0}", variable.Value);
Console.ReadKey();
}
catch (Exception ex)
{
throw new ApplicationException("An error occurred during execution.", ex);
}
}
}
}