ServerPlatformSettings Class

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

Represents the settings typically used for creating a server platform instance.

public ref class ServerPlatformSettings

public class ServerPlatformSettings

type ServerPlatformSettings = class

Public Class ServerPlatformSettings

Inheritance

Object

ServerPlatformSettings

Remarks

Among other things a CollaborationPlatform in server mode must be configured with a port on which the application will listen for incoming connections. While it possible to use TCP connections, MTLS connections are highly recommended for security reasons.

To configure the plaftorm for MTLS, initialize ServerPlatformSettings with a certificate to use. Also, to perform trusted operations such as impersonation the platform must be configured with a trusted Gruu(Globally Routable User Agent Uri). A trusted Gruu is a special Gruu assigned to an application and corresponds to a Trusted Service object in the Active Directory. Refer to the docs on how to provision a trusted application.

Constructors

ServerPlatformSettings(String, String, Int32, String, String, Byte[])	Creates a new instance of the ServerPlatformSettings class.
ServerPlatformSettings(String, String, Int32, String, X509Certificate)	Creates a new instance of the ServerPlatformSettings class.
ServerPlatformSettings(String, String, Int32, String)	Creates a new instance of the ServerPlatformSettings class.

Properties

ApplicationUserAgent	Gets the part of the user agent string that identifies the application.
CertificateIssuerName	Gets the certificate issuer name to be used for TLS.
DefaultAudioVideoProviderEnabled	Gets or sets whether the default audio/video provider is enabled.
Gruu	Gets the trusted Gruu for the application. Can be null.
IpV6SupportDisabled
ListeningIPAddress	Gets or sets the IP address on which to listen.
ListeningPort	Gets the port to listen for incoming connections.
Localhost	Gets the FQDN of the machine where the application is deployed.
OutboundConnectionConfiguration
SecondaryListeningIPAddress	Gets or sets the secondary IP address on which to listen.
TrustedDomainModeForTcp	Gets or sets the value of trusted domain Mode for Tcp connections. The default value is TrustedDomainMode.Other.
TrustedDomains	Gets or sets the list of trusted domains.

Methods

GetCertificateSerialNumber()

Gets the certificate serial number used for MTLS communications.

Extension Methods

EnableHighAvailability(ServerPlatformSettings)

SetDomainsForAlternateCallScreening(ServerPlatformSettings, IEnumerable<String>)

SetTraceFilterConfiguration(ServerPlatformSettings, ITraceFilterConfiguration)

SetTrustedDomainModeForTls(ServerPlatformSettings, TrustedDomainMode)