Skip to content

spo storageentity set

Sets tenant property on the specified SharePoint Online app catalog

Usage

spo storageentity set [options]

Options

Option Description
--help output usage information
-u, --appCatalogUrl <appCatalogUrl> URL of the app catalog site
-k, --key <key> Name of the tenant property to retrieve
-v, --value <value> Value to set for the property
-d, --description [description] Description to set for the property (optional)
-c, --comment [comment] Comment to set for the property (optional)
-o, --output [output] Output type. json|text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Important

Before using this command, log in to a SharePoint Online tenant admin site, using the spo login command.

Remarks

To set a tenant property, you have to first log in to a tenant admin site using the spo login command, eg. spo login https://contoso-admin.sharepoint.com. If you are logged in to a different site and will try to manage tenant properties, you will get an error.

Tenant properties are stored in the app catalog site associated with that tenant. To set a property, you have to specify the absolute URL of the app catalog site. If you specify the URL of a site different than the app catalog, you will get an access denied error.

Examples

Set 123 as the value of the AnalyticsId tenant property. Also include a description and a comment for additional clarification of the usage of the property.

spo storageentity set -k AnalyticsId -v 123 -d 'Web analytics ID' -c 'Use on all sites' -u https://contoso.sharepoint.com/sites/appcatalog

More information