Skip to content

spo hubsite set

Updates properties of the specified hub site

Usage

m365 spo hubsite set [options]

Options

-i, --id <id>
ID of the hub site to update
-t, --title [title]
The new title for the hub site
-d, --description [description]
The new description for the hub site
-l, --logoUrl [logoUrl]
The URL of the new logo for the hub site
-h, --help [help]
Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Remarks

Important

To use this command you must be a Global or SharePoint administrator.

If the specified id doesn't refer to an existing hub site, you will get an Unknown Error error.

Examples

Update hub site's title

m365 spo hubsite set --id 255a50b2-527f-4413-8485-57f4c17a24d1 --title Sales

Update hub site's title and description

m365 spo hubsite set --id 255a50b2-527f-4413-8485-57f4c17a24d1 --title Sales --description "All things sales"

Response

{
  "Description": "Hello",
  "EnablePermissionsSync": false,
  "HideNameInNavigation": false,
  "ID": "af80c11f-0138-4d72-bb37-514542c3aabb",
  "LogoUrl": "https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png",
  "ParentHubSiteId": "/Guid(00000000-0000-0000-0000-000000000000)/",
  "Permissions": null,
  "RequiresJoinApproval": false,
  "SiteDesignId": "/Guid(184644fb-90ed-4841-a7ad-6930cf819060)/",
  "SiteId": "af80c11f-0138-4d72-bb37-514542c3aabb",
  "SiteUrl": "https://contoso.sharepoint.com/sites/intra",
  "Title": "Intranet"
}

Description          : Hello
EnablePermissionsSync: false
HideNameInNavigation : false
ID                   : af80c11f-0138-4d72-bb37-514542c3aabb
LogoUrl              : https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png
ParentHubSiteId      : /Guid(00000000-0000-0000-0000-000000000000)/
Permissions          : null
RequiresJoinApproval : false
SiteDesignId         : /Guid(184644fb-90ed-4841-a7ad-6930cf819060)/
SiteId               : af80c11f-0138-4d72-bb37-514542c3aabb
SiteUrl              : https://contoso.sharepoint.com/sites/intra
Title                : Intranet

Description,EnablePermissionsSync,HideNameInNavigation,ID,LogoUrl,ParentHubSiteId,Permissions,RequiresJoinApproval,SiteDesignId,SiteId,SiteUrl,Title
Hello,,,af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra/SiteAssets/teapoint.png,/Guid(00000000-0000-0000-0000-000000000000)/,,,/Guid(184644fb-90ed-4841-a7ad-6930cf819060)/,af80c11f-0138-4d72-bb37-514542c3aabb,https://contoso.sharepoint.com/sites/intra,Intranet

More information