Read (GET) Connections

Read using the HTTP GET operation.

Code Examples

Request

Request URI Parameters

Request URI Example

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 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/Connections(guid'5b2be649-2d17-4d3a-861c-02656b6fae21')</id>
  <category term="Orchestrator.ResourceModel.Connection" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <link rel="edit" title="Connection" href="Connections(guid'5b2be649-2d17-4d3a-861c-02656b6fae21')" />
  <link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/ConnectionFieldValues" type="application/atom+xml;type=feed" title="ConnectionFieldValues" href="Connections(guid'5b2be649-2d17-4d3a-861c-02656b6fae21')/ConnectionFieldValues" />
  <link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/ConnectionType" type="application/atom+xml;type=entry" title="ConnectionType" href="Connections(guid'5b2be649-2d17-4d3a-861c-02656b6fae21')/ConnectionType" />
  <title />
  <updated>2014-04-06T20:09:11Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:TenantID m:type="Edm.Guid">00000000-0000-0000-0000-000000000000</d:TenantID>
      <d:ConnectionID m:type="Edm.Guid">5b2be649-2d17-4d3a-861c-02656b6fae21</d:ConnectionID>
      <d:ConnectionTypeID m:type="Edm.Guid">3921d613-e650-46da-bf19-1700c09f2d33</d:ConnectionTypeID>
      <d:Name>Test Connection Name</d:Name>
      <d:Description>Test Connection Description</d:Description>
      <d:CreationTime m:type="Edm.DateTime">2014-04-06T19:14:52.14</d:CreationTime>
      <d:LastModifiedTime m:type="Edm.DateTime">2014-04-06T19:14:52.14</d:LastModifiedTime>
    </m:properties>
  </content>
</entry>

Code Examples

The following example searches for a specific Connection, identified by the ConnectionID (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 connection instance to search for.
                var connectionID = new Guid("5b2be649-2d17-4d3a-861c-02656b6fae21");

                // Query for the specific connection instance identified by ActivityID.
                var connection = SMAService.Connections.Where(r => r.ConnectionID == connectionID).FirstOrDefault();

                // Output select properties of the instance to the console.
                Console.WriteLine("Found Connection ID  : {0}", connection.ConnectionID);
                Console.WriteLine("Found Connection Name: {0}", connection.Name);
                Console.ReadKey();
            }
            catch (Exception ex)
            {
                throw new ApplicationException("An error occurred during execution.", ex);
            }
        }                 
    }
}

See Also

Concepts

Connection
Connections