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

PI Powershell

ConnectPIDataArchive.PIDataArchiveConnectionConfiguration Property

ConnectPIDataArchive.PIDataArchiveConnectionConfiguration Property

  • Last UpdatedDec 15, 2025
  • 4 minute read
ConnectPIDataArchive.PIDataArchiveConnectionConfiguration Property

Connection configuration object retrieved from the Known Servers Table (KST). Run "Get-Help Get-PIDataArchiveConnectionConfiguration" for more details.

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

Syntax

[ParameterAttribute(Position = 0, ParameterSetName = "ConnectionConfiguration", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaWindowsAccount", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 2, ParameterSetName = "ConnectionConfigurationViaPIUser", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaAccessToken", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaClientCredentials", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaAuthorizationCode", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")]
[AliasAttribute(new string[] { ... })]
[ValidateNotNullOrEmptyAttribute]
public ConnectionEntity PIDataArchiveConnectionConfiguration { get; set; }
<ParameterAttribute(Position := 0, ParameterSetName := "ConnectionConfiguration", 
	Mandatory := true, ValueFromPipeline := true, HelpMessage := "PI Data Archive Connection Configuration")>
<ParameterAttribute(Position := 1, ParameterSetName := "ConnectionConfigurationViaWindowsAccount", 
	Mandatory := true, ValueFromPipeline := true, HelpMessage := "PI Data Archive Connection Configuration")>
<ParameterAttribute(Position := 2, ParameterSetName := "ConnectionConfigurationViaPIUser", 
	Mandatory := true, ValueFromPipeline := true, HelpMessage := "PI Data Archive Connection Configuration")>
<ParameterAttribute(Position := 1, ParameterSetName := "ConnectionConfigurationViaAccessToken", 
	Mandatory := true, ValueFromPipeline := true, HelpMessage := "PI Data Archive Connection Configuration")>
<ParameterAttribute(Position := 1, ParameterSetName := "ConnectionConfigurationViaClientCredentials", 
	Mandatory := true, ValueFromPipeline := true, HelpMessage := "PI Data Archive Connection Configuration")>
<ParameterAttribute(Position := 1, ParameterSetName := "ConnectionConfigurationViaAuthorizationCode", 
	Mandatory := true, ValueFromPipeline := true, HelpMessage := "PI Data Archive Connection Configuration")>
<AliasAttribute(New String() { ... })>
<ValidateNotNullOrEmptyAttribute>
Public Property PIDataArchiveConnectionConfiguration As ConnectionEntity
	Get
	Set

Dim instance As ConnectPIDataArchive
Dim value As ConnectionEntity

value = instance.PIDataArchiveConnectionConfiguration

instance.PIDataArchiveConnectionConfiguration = value
public:
[ParameterAttribute(Position = 0, ParameterSetName = L"ConnectionConfiguration", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = L"PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = L"ConnectionConfigurationViaWindowsAccount", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = L"PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 2, ParameterSetName = L"ConnectionConfigurationViaPIUser", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = L"PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = L"ConnectionConfigurationViaAccessToken", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = L"PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = L"ConnectionConfigurationViaClientCredentials", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = L"PI Data Archive Connection Configuration")]
[ParameterAttribute(Position = 1, ParameterSetName = L"ConnectionConfigurationViaAuthorizationCode", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = L"PI Data Archive Connection Configuration")]
[AliasAttribute(__gc new array<String^>^ { ... })]
[ValidateNotNullOrEmptyAttribute]
property ConnectionEntity^ PIDataArchiveConnectionConfiguration {
	ConnectionEntity^ get ();
	void set (ConnectionEntity^ value);
}
[<ParameterAttribute(Position = 0, ParameterSetName = "ConnectionConfiguration", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")>]
[<ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaWindowsAccount", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")>]
[<ParameterAttribute(Position = 2, ParameterSetName = "ConnectionConfigurationViaPIUser", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")>]
[<ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaAccessToken", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")>]
[<ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaClientCredentials", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")>]
[<ParameterAttribute(Position = 1, ParameterSetName = "ConnectionConfigurationViaAuthorizationCode", 
	Mandatory = true, ValueFromPipeline = true, HelpMessage = "PI Data Archive Connection Configuration")>]
[<AliasAttribute(new string[] { ... })>]
[<ValidateNotNullOrEmptyAttribute>]
member PIDataArchiveConnectionConfiguration : ConnectionEntity with get, set

Property Value

Type: ConnectionEntity

See Also

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