Table of Contents

Set-PnPStorageEntity

SYNOPSIS

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 <PnPConnection>]   

DESCRIPTION

Allows to set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.

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 the 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 at the site collection level.

PARAMETERS

-Comment

Specifies additional comments related to the storage entity being set.

Type: String
Parameter Sets: (All)

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

-Description

The description to set.

Type: String
Parameter Sets: (All)

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

-Key

The key of the value to set.

Type: String
Parameter Sets: (All)

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

-Scope

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

Type: StorageEntityScope
Parameter Sets: (All)
Accepted values: Site, Tenant

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

-Value

The value to set.

Type: String
Parameter Sets: (All)

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

Microsoft 365 Patterns and Practices