Get-PnPCopilotAgent
SYNOPSIS
Returns the Microsoft Copilot Agents (*.agent) in a site collection.
SYNTAX
__AllParameterSets
Get-PnPCopilotAgent [-ServerRelativeUrl <string>] [-Connection <PnPConnection>] [<CommonParameters>]
DESCRIPTION
This cmdlet iterates through the document libraries in a site and finds the copilot agents in that site.
EXAMPLES
Example 1
Get-PnPCopilotAgent
This will return all the Microsoft Copilot agents in a site.
Example 2
Get-PnPCopilotAgent -ServerRelativeUrl /sites/demo/siteassets/copilots/approved/main.agent
This will return the specific Microsoft Copilot agent if it exists.
PARAMETERS
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServerRelativeUrl
The server relative URL to the .agent file.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.