GetSqlInstances Method

Retrieves a list of the existing SQL Server Instances that host the Data Sources.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function GetSqlInstances( _
   ByVal request As GetSqlInstancesRequest _
) As GetSqlInstancesResponse

Dim instance As SecurityServiceClient
Dim request As GetSqlInstancesRequest
Dim value As GetSqlInstancesResponse
 
value = instance.GetSqlInstances(request)

public GetSqlInstancesResponse GetSqlInstances( 
   GetSqlInstancesRequest request
)

Parameters

request: Contains a GetSqlInstancesRequest for a list of all existing SQL Server Instances that host the Data Sources.

Return Value

A GetSqlInstancesResponse containing a list of SQL Server Instances that host the Data Sources.

Example

The following example shows how to retrieve a list of all SQL Server Instances that host the Data Sources using the GetSqlInstances() method:

using System;
using System.Linq;
using AIR.Services.Common.Data;
using AIR.Services.Security.Api;
            
class SnippetGetSqlInstancesRequest
{
    private void GetSqlServerInstanceSid(string sqlServerName)
    {
        SecurityServiceClient securityClient = new SecurityServiceClient();
        GetSqlInstancesRequest request = new GetSqlInstancesRequest();
        GetSqlInstancesResponse response = securityClient.GetSqlInstances(request);
        if (response.Status.Code == StatusCode.Success)
        {
            AIR.Services.Security.Data.SqlInstance sqlInstance = response.SqlInstances.FirstOrDefault(s => s.Name.ToLower() == sqlServerName);
            if (sqlInstance != null)
            {
                Console.WriteLine("SID: " + sqlInstance.Sid);
            }
        }
    }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SecurityServiceClient Class
SecurityServiceClient Members