Skip to content

Commit 0d4c696

Browse files
committed
additional important hub site cmdlet details
1 parent 26b0eb4 commit 0d4c696

File tree

8 files changed

+32
-8
lines changed

8 files changed

+32
-8
lines changed

sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Add-SPOHubSiteAssociation [-Site] <SpoSitePipeBind> `
2121
## DESCRIPTION
2222
Use this cmdlet to associate a site with a hub site.
2323

24-
If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.
24+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
2525
2626
## EXAMPLES
2727

@@ -79,4 +79,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7979
8080
## NOTES
8181
82+
If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.
83+
84+
If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error.
85+
8286
## RELATED LINKS

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Set-SPOHubSite [-Identity] <SpoHubSitePipeBind>
2121
```
2222

2323
## DESCRIPTION
24-
Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** the cmdlet returns detailed information about the specific hub.
24+
Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** the cmdlet returns detailed information about the specific hub. You can find which hub a site is associated with by providing the site's identity with this cmdlet.
25+
26+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
2527
2628
If the hub site doesn’t exist, this cmdlet returns a “File not found” error.
2729

@@ -38,7 +40,7 @@ This example lists all hub sites in the tenant.
3840
### Example 2
3941

4042
```
41-
Get-SPOHubSite https://contoso.sharepoint.com/sites/Research
43+
Get-SPOHubSite https://contoso.sharepoint.com/sites/online-marketing
4244
4345
ID : 44252d09-62c4-4913-9eb0-a2a8b8d7f863
4446
Title : Marketing Hub
@@ -49,7 +51,7 @@ Description : Hub for the Marketing division
4951
Rights : nestorw@contoso.onmicrosoft.com
5052
```
5153

52-
This example provides property information about the research hub site.
54+
This example begins with the online-marketing site. The cmdlet finds the associated hub site, which is marketing. Then it lists all the details about the marketing hub site.
5355

5456
## PARAMETERS
5557

sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Grant-SPOHubSiteRights
99

1010
## SYNOPSIS
11-
Grants rights to users or security groups to access the hub site.
11+
Grants rights to users or mail-enabled security groups to access the hub site.
1212

1313
## SYNTAX
1414

@@ -18,7 +18,11 @@ Grant-SPOHubSiteRights [-Identity] <SpoHubSitePipeBind> -Principals
1818
```
1919

2020
## DESCRIPTION
21-
Applies permissions to a set of users or security groups. Use this cmdlet to scope visibility of who can associate their site with the hub site when using the SharePoint user interface. Hub sites are public by default. Once you set permissions, only those groups or users you specified can associate their site with the hub site.
21+
Applies permissions to a set of users or mail-enabled security groups. Use this cmdlet to scope visibility of who can associate their site with the hub site when using the SharePoint user interface. Hub sites are public by default. Once you set permissions, only those groups or users you specified can associate their site with the hub site.
22+
23+
To view which users or groups have permissions to a site, use the [Get-SPOHubSite](Get-SPOHubSite.md) cmdlet.
24+
25+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
2226
2327
## EXAMPLES
2428

sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Register-SPOHubSite [-Site] <SpoSitePipeBind> [<CommonParameters>]
2020
## DESCRIPTION
2121
Use this cmdlet to register an existing site collection as a hub site.
2222

23-
If the site doesn’t exist, this cmdlet returns a “File not found” error.
23+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
2424
2525
## EXAMPLES
2626

@@ -59,4 +59,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5959
6060
## NOTES
6161
62+
If the site doesn’t exist, this cmdlet returns a “File not found” error.
63+
64+
If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error.
65+
66+
If the site is already associated with another hub site, this cmdlet returns a "This site is currently associated with a HubSite" error. You'll need to run the [Remove-SPOHubSiteAssociation](Remove-SPOHubSiteAssociation.md) cmdlet first before you can make the site a hub site.
67+
6268
## RELATED LINKS

sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Remove-SPOHubSiteAssociation [-Site] <SpoSitePipeBind>
2020
## DESCRIPTION
2121
Use this cmdlet to remove an association between a site and a hub site.
2222

23+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
24+
2325
If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.
2426

2527
## EXAMPLES

sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Revoke-SPOHubSiteRights [-Identity] <SpoHubSitePipeBind> -Principals
2020
## DESCRIPTION
2121
Revokes rights for specified principals to the given hub site. The specified principals will no longer be able to associate sites with the hub. To find which principals have access to a hub site, use the [Get-SPOHubSite](Get-SPOHubSite.md) cmdlet.
2222

23+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
24+
2325
If the hub site doesn’t exist, this cmdlet returns a “File not found” error.
2426

2527
## EXAMPLES

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Set-SPOHubSite [-Identity] <SpoHubSitePipeBind>
2323
## DESCRIPTION
2424
Use this cmdlet to set properties such as name, logo, and description. These properties appear for the hub in the SharePoint user interface.
2525

26+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
27+
2628
If the hub site doesn’t exist, this cmdlet returns a “File not found” error.
2729

2830
## EXAMPLES

sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ Unregister-SPOHubSite [-Identity] <SpoHubSitePipeBind>
1919
```
2020

2121
## DESCRIPTION
22-
Disables the hub site feature on a site so that it is no longer a hub site.
22+
Disables the hub site feature on a site so that it is no longer a hub site. Associated sites may still appear associated for up to an hour. If you want to speed up the process, use the Remove-SPOHubSiteAssociation cmdlet to remove the associates sites first.
23+
24+
> [!IMPORTANT] This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
2325
2426
If the site doesn’t exist, this cmdlet returns a “File not found” error.
2527

0 commit comments

Comments
 (0)