Table of Contents

Set-PnPContainerType

SYNOPSIS

Required Permissions

  • SharePoint Embedded Administrator or Global Administrator role is required

Changes the name or the application redirect url of a Container Type in SharePoint Embedded.

SYNTAX

Set-PnPContainerType [-Identity] <Guid> [-ContainerTypeName <String>] [-ApplicationRedirectUrl <String>] [-WhatIf] [-Confirm] [-Connection <PnPConnection>]

DESCRIPTION

Changes only the settings for the parameters that are passed in, and returns the Container Type. At least one setting has to be passed. The billing of a standard Container Type is not changed by this cmdlet.

EXAMPLES

EXAMPLE 1

Set-PnPContainerType -Identity 4f0af585-8dcc-0000-223d-661eb2c604e4 -ContainerTypeName "Contoso Legal"

Renames the specified Container Type.

EXAMPLE 2

Set-PnPContainerType -Identity 4f0af585-8dcc-0000-223d-661eb2c604e4 -ApplicationRedirectUrl "https://contoso.com/legal"

Changes the url that files in Containers of the specified Container Type redirect to.

PARAMETERS

-ApplicationRedirectUrl

The url of the application that files in Containers of this Container Type redirect to.

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContainerTypeName

The new name of the Container Type.

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

The id of the Container Type.

Type: Guid
Parameter Sets: (All)
Aliases: ContainerTypeId

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Microsoft 365 Patterns and Practices SharePoint Embedded Container Types

Edit this page