Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Powershell

ConnectAFServer.AFConnectionPreference Property

  • Last UpdatedDec 15, 2025
  • 3 minute read
ConnectAFServer.AFConnectionPreference Property

Defines the connection preference when connecting to an AF Server which is in an HA Collective. If not specified, PreferPrimary is the default.

Namespace:  OSIsoft.PowerShell
Assembly:  OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[ParameterAttribute(Position = 0, Mandatory = false, ParameterSetName = "NoCredential", 
	HelpMessage = "AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "WindowsCredential", 
	HelpMessage = "AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "AccessToken", 
	HelpMessage = "AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "ClientCredentials", 
	HelpMessage = "AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "AuthorizationCode", 
	HelpMessage = "AF Connection Preference")]
[AliasAttribute(new string[] { ... })]
[ValidateNotNullOrEmptyAttribute]
public AFConnectionPreference AFConnectionPreference { get; set; }
<ParameterAttribute(Position := 0, Mandatory := false, ParameterSetName := "NoCredential", 
	HelpMessage := "AF Connection Preference")>
<ParameterAttribute(Position := 1, Mandatory := false, ParameterSetName := "WindowsCredential", 
	HelpMessage := "AF Connection Preference")>
<ParameterAttribute(Position := 1, Mandatory := false, ParameterSetName := "AccessToken", 
	HelpMessage := "AF Connection Preference")>
<ParameterAttribute(Position := 1, Mandatory := false, ParameterSetName := "ClientCredentials", 
	HelpMessage := "AF Connection Preference")>
<ParameterAttribute(Position := 1, Mandatory := false, ParameterSetName := "AuthorizationCode", 
	HelpMessage := "AF Connection Preference")>
<AliasAttribute(New String() { ... })>
<ValidateNotNullOrEmptyAttribute>
Public Property AFConnectionPreference As AFConnectionPreference
	Get
	Set

Dim instance As ConnectAFServer
Dim value As AFConnectionPreference

value = instance.AFConnectionPreference

instance.AFConnectionPreference = value
public:
[ParameterAttribute(Position = 0, Mandatory = false, ParameterSetName = L"NoCredential", 
	HelpMessage = L"AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = L"WindowsCredential", 
	HelpMessage = L"AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = L"AccessToken", 
	HelpMessage = L"AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = L"ClientCredentials", 
	HelpMessage = L"AF Connection Preference")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = L"AuthorizationCode", 
	HelpMessage = L"AF Connection Preference")]
[AliasAttribute(__gc new array<String^>^ { ... })]
[ValidateNotNullOrEmptyAttribute]
property AFConnectionPreference AFConnectionPreference {
	AFConnectionPreference get ();
	void set (AFConnectionPreference value);
}
[<ParameterAttribute(Position = 0, Mandatory = false, ParameterSetName = "NoCredential", 
	HelpMessage = "AF Connection Preference")>]
[<ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "WindowsCredential", 
	HelpMessage = "AF Connection Preference")>]
[<ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "AccessToken", 
	HelpMessage = "AF Connection Preference")>]
[<ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "ClientCredentials", 
	HelpMessage = "AF Connection Preference")>]
[<ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "AuthorizationCode", 
	HelpMessage = "AF Connection Preference")>]
[<AliasAttribute(new string[] { ... })>]
[<ValidateNotNullOrEmptyAttribute>]
member AFConnectionPreference : AFConnectionPreference with get, set

Property Value

Type: AFConnectionPreference

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in