PI Powershell

GetPIDataArchiveDetails Class

Save PDF

TABLE OF CONTENTS

GetPIDataArchiveDetails Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get the detailed information for a connected PI Data Archive

The Get-PIDataArchiveDetails cmdlet will grab detailed information for a connected PI Data Archive.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellGetPIDataArchiveDetails

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

Syntax

[CmdletAttribute("Get", "PIDataArchiveDetails", SupportsShouldProcess = true)]
public class GetPIDataArchiveDetails : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIDataArchiveDetails", SupportsShouldProcess := true)>
Public Class GetPIDataArchiveDetails
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIDataArchiveDetails

[CmdletAttribute(L"Get", L"PIDataArchiveDetails", SupportsShouldProcess = true)]
public ref class GetPIDataArchiveDetails : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIDataArchiveDetails", SupportsShouldProcess = true)>]
type GetPIDataArchiveDetails =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIDataArchiveDetails type exposes the following members.

Constructors

	Name	Description
	GetPIDataArchiveDetails

Properties

	Name	Description
	Connection	Specifies which connection to a PI Data Archive to use. (Overrides OSICmdletBaseWithConnectionConnection.)

Examples

Get-PIDataArchiveDetails -Connection $con

This example will get the PI Data Archive details for a PI Data Archive specified by the -Connection parameter. Note that you must first connect to the PI Data Archive and and retrieve a PI Connection object (run "Get-Help Connect-PIDataArchive" for details) before getting the PI Data Archive details via this cmdlet.

PI Powershell