Commands › SharePoint Online

Set-SPOStorageEntity

SharePoint Online Microsoft.Online.SharePoint.PowerShell Set-*

Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets.

Quick start script

# Set-SPOStorageEntity — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-SPOStorageEntity
$before | Format-List

# 3. Make the change (dry run first)
Set-SPOStorageEntity -Comments <String> -Description <String> -Key <String> -WhatIf
Set-SPOStorageEntity -Comments <String> -Description <String> -Key <String>

# 4. Verify and diff
$after = Get-SPOStorageEntity
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-SPOStorageEntity -Site <SpoSitePipeBind> -Key <String> -Value <String> -Comments <String>
 -Description <String> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters (7)

Parameter	Type	Required	What it controls
-Comments	String	yes	Comment for this property bag entry.
-Description	String	yes	Description of the property.
-Key	String	yes	The key in the property bag that should be added or updated.
-Site	SpoSitePipeBind	yes	URL to the tenant or site collection app catalog.
-Value	String	yes	Value to be set.
-Confirm	SwitchParameter		Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`
-WhatIf	SwitchParameter		### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction,...

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.