Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOHubSite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
external help file:
applicable: SharePoint Online
title: Connect-SPOHubSite
schema: 2.0.0
---

# Connect-SPOHubSite

## SYNOPSIS
Connects a site to a hub site.

## SYNTAX

```
Connect-SPOHubSite [-Site] <SpoSitePipeBind> `
-HubSite <SpoHubSitePipeBind> `
[<CommonParameters>]
```

## DESCRIPTION
Use this cmdlet to connect a site to a hub site.

If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.

## EXAMPLES

### Example 1

```
Connect-SPOHubSite https://contoso.sharepoint.com/sites/Research `
-HubSite https://contoso.sharepoint.com/sites/Marketing
```

This example connects the research site with the marketing hub.

## PARAMETERS

### -Site

URL of the site to join to the hub.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -HubSite

URL of the hub site.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: True
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
external help file:
applicable: SharePoint Online
title: Disconnect-SPOHubSite
schema: 2.0.0
---

# Disconnect-SPOHubSite

## SYNOPSIS
Disconnects a site from a hub site.

## SYNTAX

```
Disconnect-SPOHubSite [-Site] <SpoSitePipeBind>
[<CommonParameters>]
```

## DESCRIPTION
Use this cmdlet to disconnect a site from a hub site. The site will no longer be associated with the hub site.

If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error.

## EXAMPLES

### Example 1

```
Disconnect-SPOHubSite https://contoso.sharepoint.com/sites/Research
```

This example disconnects the research site from the marketing hub site.

## PARAMETERS

### -Site

URL of the site to disconnect from the hub.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: True
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
82 changes: 82 additions & 0 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
external help file:
applicable: SharePoint Online
title: Get-SPOHubSite
schema: 2.0.0
---

# Get-SPOHubSite

## SYNOPSIS
Lists hub sites or hub site information.

## SYNTAX

```
Set-SPOHubSite [-Identity] <SpoHubSitePipeBind>
[-Title <string>]
[-LogoUrl <string>]
[-Description <string>]
[<CommonParameters>]
```

## DESCRIPTION
Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** the cmdlet returns detailed information about the specific hub.

If the site doesn’t exist, this cmdlet returns a “File not found” error.

## EXAMPLES

### Example 1

```
Get-SPOHubSite
```

This example lists all hub sites in the tenant.

### Example 2

```
Get-SPOHubSite https://contoso.sharepoint.com/sites/Research

ID : 44252d09-62c4-4913-9eb0-a2a8b8d7f863
Title : Marketing Hub
SiteId : 44252d09-62c4-4913-9eb0-a2a8b8d7f863
SiteUrl : https://contoso.sharepoint.com/sites/Marketing
LogoUrl : https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png
Description : Hub for the Marketing division
Rights : nestorw@contoso.onmicrosoft.com
```

This example provides property information about the research hub site.

## PARAMETERS

### -Identity

URL of the hub site. If not specified, the cmdlet lists all site hubs in the tenant.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: True
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
external help file:
applicable: SharePoint Online
title: Grant-SPOHubSiteRights
schema: 2.0.0
---

# Grant-SPOHubSiteRights

## SYNOPSIS
Grants rights to users or security groups to access the hub site.

## SYNTAX

```
Grant-SPOHubSiteRights [-Identity] <SpoHubSitePipeBind> -Principals
<string[]> -Rights {Join} [<CommonParameters>]
```

## DESCRIPTION
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.

## EXAMPLES

### Example 1

```
Grant-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing
-Principals nestorw@contoso.onmicrosoft.com
-Rights Join
```

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.

## PARAMETERS

### -Identity

URL of the hub site.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Principals

One or more principles to add permissions for.

```yaml
Type: String[]
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Rights

Always set to the value **Join**. Any user or group with **Join** permissions can view and join the hub site.

```yaml
Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online

Required: True
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
62 changes: 62 additions & 0 deletions sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
external help file:
applicable: SharePoint Online
title: Register-SPOHubSite
schema: 2.0.0
---

# Register-SPOHubSite

## SYNOPSIS
Enables the hub site feature on a site to make it a hub site.


## SYNTAX

```
Register-SPOHubSite [-Site] <SpoSitePipeBind> [<CommonParameters>]
```

## DESCRIPTION
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.

If the site doesn’t exist, this cmdlet returns a “File not found” error.

## EXAMPLES

### Example 1

```
Register-SPOHubSite https://contoso.sharepoint.com/sites/Marketing
```

This example registers the marketing site on Contoso as hub site.

## PARAMETERS

### -Site
Specifies the URL of the site collection to which to enable the hub site features.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

## OUTPUTS

## NOTES

## RELATED LINKS
Loading