Get-PnPSitePolicy

Retrieves all or a specific site policy

Syntax

Get-PnPSitePolicy
   [-AllAvailable [<SwitchParameter>]]
                    [-Name <String>]
                    [-Web <WebPipeBind>]
                    [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Get-PnPSitePolicy

Retrieves the current applied site policy.

------------------EXAMPLE 2------------------

Get-PnPSitePolicy -AllAvailable

Retrieves all available site policies.

------------------EXAMPLE 3------------------

Get-PnPSitePolicy -Name "Contoso HBI"

Retrieves an available site policy with the name "Contoso HBI".

Optional Parameters

-AllAvailable

Retrieve all available site policies

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Name

Retrieves a site policy with a specific name

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False

Outputs

OfficeDevPnP.Core.Entities.SitePolicyEntity