Skip to content

Commit 384c6fa

Browse files
davidchesnutdavidchesnut
committed
added hub docs
1 parent 04f33a0 commit 384c6fa

File tree

8 files changed

+651
-0
lines changed

8 files changed

+651
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOHubSite.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Connect-SPOHubSite
5+
schema: 2.0.0
6+
---
7+
8+
# Connect-SPOHubSite
9+
10+
## SYNOPSIS
11+
Connects a site to a hub site.
12+
13+
## SYNTAX
14+
15+
```
16+
Connect-SPOHubSite [-Site] <SpoSitePipeBind> `
17+
-HubSite <SpoHubSitePipeBind> `
18+
[<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
Use this cmdlet to connect a site to a hub site.
23+
24+
If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.
25+
26+
## EXAMPLES
27+
28+
### Example 1
29+
30+
```
31+
Connect-SPOHubSite https://contoso.sharepoint.com/sites/Research `
32+
-HubSite https://contoso.sharepoint.com/sites/Marketing
33+
```
34+
35+
This example connects the research site with the marketing hub.
36+
37+
## PARAMETERS
38+
39+
### -Site
40+
41+
URL of the site to join to the hub.
42+
43+
```yaml
44+
Type: SpoSitePipeBind
45+
Parameter Sets: (All)
46+
Aliases:
47+
Applicable: SharePoint Online
48+
49+
Required: True
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -HubSite
57+
58+
URL of the hub site.
59+
60+
```yaml
61+
Type: SpoSitePipeBind
62+
Parameter Sets: (All)
63+
Aliases:
64+
Applicable: SharePoint Online
65+
66+
Required: True
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### CommonParameters
74+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
75+
76+
## INPUTS
77+
78+
## OUTPUTS
79+
80+
## NOTES
81+
82+
## RELATED LINKS

‎sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOHubSite.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Disconnect-SPOHubSite
5+
schema: 2.0.0
6+
---
7+
8+
# Disconnect-SPOHubSite
9+
10+
## SYNOPSIS
11+
Disconnects a site from a hub site.
12+
13+
## SYNTAX
14+
15+
```
16+
Disconnect-SPOHubSite [-Site] <SpoSitePipeBind>
17+
[<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
Use this cmdlet to disconnect a site from a hub site. The site will no longer be associated with the hub site.
22+
23+
If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.
24+
25+
## EXAMPLES
26+
27+
### Example 1
28+
29+
```
30+
Disconnect-SPOHubSite https://contoso.sharepoint.com/sites/Research
31+
```
32+
33+
This example disconnects the research site from the marketing hub site.
34+
35+
## PARAMETERS
36+
37+
### -Site
38+
39+
URL of the site to disconnect from the hub.
40+
41+
```yaml
42+
Type: SpoSitePipeBind
43+
Parameter Sets: (All)
44+
Aliases:
45+
Applicable: SharePoint Online
46+
47+
Required: True
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### CommonParameters
55+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
56+
57+
## INPUTS
58+
59+
## OUTPUTS
60+
61+
## NOTES
62+
63+
## RELATED LINKS

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

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Get-SPOHubSite
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOHubSite
9+
10+
## SYNOPSIS
11+
Lists hub sites or hub site information.
12+
13+
## SYNTAX
14+
15+
```
16+
Set-SPOHubSite [-Identity] <SpoHubSitePipeBind>
17+
[-Title <string>]
18+
[-LogoUrl <string>]
19+
[-Description <string>]
20+
[<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** the cmdlet returns detailed information about the specific hub.
25+
26+
If the site doesn’t exist, this cmdlet returns a “File not found” error.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
32+
```
33+
Get-SPOHubSite
34+
```
35+
36+
This example lists all hub sites in the tenant.
37+
38+
### Example 2
39+
40+
```
41+
Get-SPOHubSite https://contoso.sharepoint.com/sites/Research
42+
43+
ID : 44252d09-62c4-4913-9eb0-a2a8b8d7f863
44+
Title : Marketing Hub
45+
SiteId : 44252d09-62c4-4913-9eb0-a2a8b8d7f863
46+
SiteUrl : https://contoso.sharepoint.com/sites/Marketing
47+
LogoUrl : https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png
48+
Description : Hub for the Marketing division
49+
Rights : [email protected]
50+
```
51+
52+
This example provides property information about the research hub site.
53+
54+
## PARAMETERS
55+
56+
### -Identity
57+
58+
URL of the hub site. If not specified, the cmdlet lists all site hubs in the tenant.
59+
60+
```yaml
61+
Type: SpoSitePipeBind
62+
Parameter Sets: (All)
63+
Aliases:
64+
Applicable: SharePoint Online
65+
66+
Required: True
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### CommonParameters
74+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
75+
76+
## INPUTS
77+
78+
## OUTPUTS
79+
80+
## NOTES
81+
82+
## RELATED LINKS

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

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Grant-SPOHubSiteRights
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-SPOHubSiteRights
9+
10+
## SYNOPSIS
11+
Grants rights to users or security groups to access the hub site.
12+
13+
## SYNTAX
14+
15+
```
16+
Grant-SPOHubSiteRights [-Identity] <SpoHubSitePipeBind> -Principals
17+
<string[]> -Rights {Join} [<CommonParameters>]
18+
```
19+
20+
## 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.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
27+
```
28+
Grant-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing
29+
-Principals [email protected]
30+
-Rights Join
31+
```
32+
33+
This example shows how to grant rights to Nestor (a user at the fictional Contoso site) to associate his sites with the marketing hub site.
34+
35+
## PARAMETERS
36+
37+
### -Identity
38+
39+
URL of the hub site.
40+
41+
```yaml
42+
Type: SpoSitePipeBind
43+
Parameter Sets: (All)
44+
Aliases:
45+
Applicable: SharePoint Online
46+
47+
Required: False
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -Principals
55+
56+
One or more principles to add permissions for.
57+
58+
```yaml
59+
Type: String[]
60+
Parameter Sets: (All)
61+
Aliases:
62+
Applicable: SharePoint Online
63+
64+
Required: True
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -Rights
72+
73+
Always set to the value **Join**. Any user or group with **Join** permissions can view and join the hub site.
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: (All)
78+
Aliases:
79+
Applicable: SharePoint Online
80+
81+
Required: True
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### CommonParameters
89+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
90+
91+
## INPUTS
92+
93+
## OUTPUTS
94+
95+
## NOTES
96+
97+
## RELATED LINKS

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Register-SPOHubSite
5+
schema: 2.0.0
6+
---
7+
8+
# Register-SPOHubSite
9+
10+
## SYNOPSIS
11+
Enables the hub site feature on a site to make it a hub site.
12+
13+
14+
## SYNTAX
15+
16+
```
17+
Register-SPOHubSite [-Site] <SpoSitePipeBind> [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
Use this cmdlet to register an existing site collection as a hub site. If the site doesn’t exist, the cmdlet returns a "File not found" error.
22+
23+
If the site doesn’t exist, this cmdlet returns a “File not found” error.
24+
25+
## EXAMPLES
26+
27+
### Example 1
28+
29+
```
30+
Register-SPOHubSite https://contoso.sharepoint.com/sites/Marketing
31+
```
32+
33+
This example registers the marketing site on Contoso as hub site.
34+
35+
## PARAMETERS
36+
37+
### -Site
38+
Specifies the URL of the site collection to which to enable the hub site features.
39+
40+
```yaml
41+
Type: SpoSitePipeBind
42+
Parameter Sets: (All)
43+
Aliases:
44+
Applicable: SharePoint Online
45+
46+
Required: False
47+
Position: Named
48+
Default value: None
49+
Accept pipeline input: False
50+
Accept wildcard characters: False
51+
```
52+
53+
### CommonParameters
54+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
55+
56+
## INPUTS
57+
58+
## OUTPUTS
59+
60+
## NOTES
61+
62+
## RELATED LINKS

0 commit comments

Comments
 (0)