IAdmServiceBackend
The IAdmServiceBackend interface is used to retrieve information about the Adaxes Configuration Server (ADAM or AD LDS), where Adaxes stores its configuration.
Inheritance: IUnknown
Methods
-
Method
-
Description
-
GetConfigurationContainerPath()
-
Returns the ADS path of a well-known container that stores Adaxes configuration objects.
Properties
-
Property
-
Description
-
Id
-
Gets the ID of the configuration set the Adaxes Configuration Server belongs to.
-
DnsHostName
-
Gets the host name of the computer that hosts the Adaxes Configuration Server.
-
ServerName
-
Gets the name of the directory server.
-
PortNumber
-
Gets the port number of the Adaxes Configuration Server.
-
PortNumberSsl
-
Gets the SSL port number of the Adaxes Configuration Server.
Details
GetConfigurationContainerPath()
Returns the ADS path of a well-known container that stores Adaxes configuration objects. For details, see Managing Adaxes-specific objects.
string GetConfigurationContainerPath(string containerName)
Parameters
The containerName parameter is a string containing the alias name of the required container. For a complete list of container aliases, see Aliases for containers that store Adaxes configuration objects.
Examples
The following code sample outputs the ADS path of the container for business rules.
- PowerShell
-
[Reflection.Assembly]::LoadWithPartialName("Softerra.Adaxes.Adsi") # Connect to the Adaxes service $ns = New-Object("Softerra.Adaxes.Adsi.AdmNamespace") $service = $ns.GetServiceDirectly("localhost") Write-Host $service.Backend.GetConfigurationContainerPath("BusinessRules")
- C#
-
using System; using Softerra.Adaxes.Adsi; using Softerra.Adaxes.Interop.Adsi.PersistentObjects; class Program { static void Main(string[] args) { // Connect to the Adaxes service AdmNamespace ns = new AdmNamespace(); IAdmService service = ns.GetServiceDirectly("localhost"); Console.WriteLine(service.Backend.GetConfigurationContainerPath("BusinessRules")); } }
Id
Gets the ID of the configuration set the Adaxes Configuration Server belongs to.
- Type:
- string
- Access:
- Read-only
DnsHostName
Gets the host name of the computer that hosts the Adaxes Configuration Server.
- Type:
- string
- Access:
- Read-only
ServerName
Gets the name of the directory server.
- Type:
- string
- Access:
- Read-only
PortNumber
Gets the port number of the Adaxes Configuration Server.
- Type:
- int
- Access:
- Read-only
PortNumberSsl
Gets the SSL port number of the Adaxes Configuration Server.
- Type:
- int
- Access:
- Read-only
Requirements
Minimum required version: 2009.1