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

PI Powershell

ConnectPIDataArchive.PromptForAccessToken Property

  • Last UpdatedDec 15, 2025
  • 2 minute read
ConnectPIDataArchive.PromptForAccessToken Property

Browser popup to authorize getting access token to use when connecting to a PI Data Archive.

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

Syntax

[ParameterAttribute(Position = 1, Mandatory = true, ParameterSetName = "MachineNameViaAuthorizationCode", 
	HelpMessage = "Browser popup for authorization")]
[ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = "ConnectionConfigurationViaAuthorizationCode", 
	HelpMessage = "Browser popup for authorization")]
[ValidateNotNullOrEmptyAttribute]
public SwitchParameter PromptForAccessToken { get; set; }
<ParameterAttribute(Position := 1, Mandatory := true, ParameterSetName := "MachineNameViaAuthorizationCode", 
	HelpMessage := "Browser popup for authorization")>
<ParameterAttribute(Position := 0, Mandatory := true, ParameterSetName := "ConnectionConfigurationViaAuthorizationCode", 
	HelpMessage := "Browser popup for authorization")>
<ValidateNotNullOrEmptyAttribute>
Public Property PromptForAccessToken As SwitchParameter
	Get
	Set

Dim instance As ConnectPIDataArchive
Dim value As SwitchParameter

value = instance.PromptForAccessToken

instance.PromptForAccessToken = value
public:
[ParameterAttribute(Position = 1, Mandatory = true, ParameterSetName = L"MachineNameViaAuthorizationCode", 
	HelpMessage = L"Browser popup for authorization")]
[ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = L"ConnectionConfigurationViaAuthorizationCode", 
	HelpMessage = L"Browser popup for authorization")]
[ValidateNotNullOrEmptyAttribute]
property SwitchParameter PromptForAccessToken {
	SwitchParameter get ();
	void set (SwitchParameter value);
}
[<ParameterAttribute(Position = 1, Mandatory = true, ParameterSetName = "MachineNameViaAuthorizationCode", 
	HelpMessage = "Browser popup for authorization")>]
[<ParameterAttribute(Position = 0, Mandatory = true, ParameterSetName = "ConnectionConfigurationViaAuthorizationCode", 
	HelpMessage = "Browser popup for authorization")>]
[<ValidateNotNullOrEmptyAttribute>]
member PromptForAccessToken : SwitchParameter with get, set

Property Value

Type: SwitchParameter

See Also

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