Set-PnPStorageEntity

  • Reference
Module:
PnP.Powershell
Applies to:
SharePoint Online

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Set-PnPStorageEntity.md to change this file.

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>]  
   [<CommonParameters>]

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.

Parameters

-Comment

The comment to set.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

The description to set.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Key

The key of the value to set.

Type:String
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
Accepted values:Site, Tenant
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Value

The value to set.

Type:String
Position:Named
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
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False