Skip to content

Latest commit

 

History

History
169 lines (128 loc) · 3.65 KB

Set-SPOStorageEntity.md

File metadata and controls

169 lines (128 loc) · 3.65 KB
Raw
external help file Module Name online version applicable title schema author ms.author ms.reviewer
sharepointonline.xml
Microsoft.Online.SharePoint.PowerShell
SharePoint Online
Set-SPOStorageEntity
2.0.0
trent-green
trgreen

Set-SPOStorageEntity

SYNOPSIS

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.

SYNTAX

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

DESCRIPTION

This cmdlet is used to set a value in the property bag.

EXAMPLES

Example 1

Set-SPOStorageEntity -Site "https://tenant-name.sharepoint.com/sites/app-catalog"  -Key "MyCustomKey" -Value "{'MyKey':1234}" -Comments "This is an example" -Description "This is an example"

This example adds an entry to the property bag.

PARAMETERS

-Site

URL to the tenant or site collection app catalog.

Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Key

The key in the property bag that should be added or updated.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

Value to be set.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Comments

Comment for this property bag entry.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Description of the property.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS