Set-PnPStorageEntity

Module:
sharepoint-pnp
Applies to:
SharePoint Online
Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.

Syntax

Set-PnPStorageEntity
   -Key <String>
                       -Value <String>
                       [-Comment <String>]
                       [-Description <String>]
                       [-Scope <StorageEntityScope>]
                       [-Connection <SPOnlineConnection>]

Examples

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

Set-PnPStorageEntity -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description"

Sets an existing or adds a new storage entity / farm property at tenant level.

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

Set-PnPStorageEntity -Scope Site -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description"

Sets an existing or adds a new storage entity site collection level.

Required Parameters

-Key

The key of the value to set.

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

The value to set.

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

Optional Parameters

-Comment

The comment to set.

Type:String
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
-Description

The description to set.

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

Defines the scope of the storage entity. Defaults to Tenant.

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