Get-PnPSitePolicy.md

external help file	applicable	schema
	SharePoint Server 2013, SharePoint Server 2016, SharePoint Online	2.0.0

Get-PnPSitePolicy

SYNOPSIS

Retrieves all or a specific site policy

SYNTAX

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

EXAMPLES

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

PS:> Get-PnPSitePolicy

Retrieves the current applied site policy.

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

PS:> Get-PnPSitePolicy -AllAvailable

Retrieves all available site policies.

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

PS:> Get-PnPSitePolicy -Name "Contoso HBI"

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

PARAMETERS

-AllAvailable

Retrieve all available site policies

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Name

Retrieves a site policy with a specific name

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: 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
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

OUTPUTS

OfficeDevPnP.Core.Entities.SitePolicyEntity

RELATED LINKS

SharePoint Developer Patterns and Practices