From 384c6fae0fbdfafcfb4ce721c82c800010984877 Mon Sep 17 00:00:00 2001 From: David Chesnut Date: Tue, 13 Feb 2018 17:41:24 -0800 Subject: [PATCH] added hub docs --- .../sharepoint-online/Connect-SPOHubSite.md | 82 ++++++++++++ .../Disconnect-SPOHubSite.md | 63 +++++++++ .../sharepoint-online/Get-SPOHubSite.md | 82 ++++++++++++ .../Grant-SPOHubSiteRights.md | 97 ++++++++++++++ .../sharepoint-online/Register-SPOHubSite.md | 62 +++++++++ .../Revoke-SPOHubSiteRights.md | 81 ++++++++++++ .../Set-SPOHubSiteProperties.md | 120 ++++++++++++++++++ .../Unregister-SPOHubSite.md | 64 ++++++++++ 8 files changed, 651 insertions(+) create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOHubSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOHubSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSiteProperties.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOHubSite.md new file mode 100644 index 0000000000..62d4456dbc --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOHubSite.md @@ -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] ` +-HubSite ` +[] +``` + +## 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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOHubSite.md new file mode 100644 index 0000000000..499c8c1a05 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOHubSite.md @@ -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] +[] +``` + +## 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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md new file mode 100644 index 0000000000..4308da171b --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md @@ -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] +[-Title ] +[-LogoUrl ] +[-Description ] +[] +``` + +## 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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md new file mode 100644 index 0000000000..f41505945d --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md @@ -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] -Principals + -Rights {Join} [] +``` + +## 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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md new file mode 100644 index 0000000000..b7f31f890b --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md @@ -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] [] +``` + +## 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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md new file mode 100644 index 0000000000..c1077d68fd --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md @@ -0,0 +1,81 @@ +--- +external help file: +applicable: SharePoint Online +title: Revoke-SPOHubSiteRights +schema: 2.0.0 +--- + +# Revoke-SPOHubSiteRights + +## SYNOPSIS +Revokes rights for specified principals to a hub. + +## SYNTAX + +``` +Revoke-SPOHubSiteRights [-Identity] -Principals + [] +``` + +## DESCRIPTION +Revokes rights for specified principals to the given hub site. The specified principals will no longer be able to associate sites with the hub. + +If the site doesn’t exist, this cmdlet returns a “File not found” error. + +## EXAMPLES + +### Example 1 + +``` +Revoke-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing ` +-Principals "nestorw@contoso.onmicrosoft.com" +``` + +This example shows how to revoke rights so that Nestor can no longer join sites to the Marketing hub site. + +## PARAMETERS + +### -SiteUrl + +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 +``` + +### -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 +``` + +### 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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSiteProperties.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSiteProperties.md new file mode 100644 index 0000000000..3e07be687d --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSiteProperties.md @@ -0,0 +1,120 @@ +--- +external help file: +applicable: SharePoint Online +title: Set-SPOHubSiteProperties +schema: 2.0.0 +--- + +# Set-SPOHubSiteProperties + +## SYNOPSIS +Sets the hub site information such as name, logo, and description. + +## SYNTAX + +``` +Set-SPOHubSite [-Identity] +[-Title ] +[-LogoUrl ] +[-Description ] +[] +``` + +## DESCRIPTION +Use this cmdlet to set properties such as name, logo, and description. These properties appear for the hub in the SharePoint user interface. + +If the site doesn’t exist, this cmdlet returns a “File not found” error. + +## EXAMPLES + +### Example 1 + +``` +Set-SPOHubSite https://contoso.sharepoint.com/sites/Marketing ` +-Title "Marketing Hub" ` +-LogoUrl https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png ` +-Description "Hub for the Marketing division” +``` + +This example updates the name of the hub displayed in the SharePoint user interface. It also updates the logo used in the hub navigation, and specifies an optional description for the hub. + +## PARAMETERS + +### -Identity + +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 +``` + +### -Title + +The display name of the hub. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogoUrl + +The URL of a logo to use in the hub navigation. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +A description of the hub site. + +```yaml +Type: String +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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md new file mode 100644 index 0000000000..f7cdb38362 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md @@ -0,0 +1,64 @@ +--- +external help file: +applicable: SharePoint Online +title: Unregister-SPOHubSite +schema: 2.0.0 +--- + +# Unregister-SPOHubSite + +## SYNOPSIS +Disables the hub site feature on a site. + +## SYNTAX + +``` +Unregister-SPOHubSite [-Identity] +[-WhatIf] [-Confirm] +[] +``` + +## DESCRIPTION +Disables the hub site feature on a site so that it is no longer a hub. + +If the site or hub site doesn’t exist, this cmdlet returns a “File not found” error. + +## EXAMPLES + +### Example 1 + +``` +Unregister-SPOHubSite https://contoso.sharepoint.com/sites/Marketing +``` + +This example disables the hub feature on the marketing site. + +## PARAMETERS + +### -Site + +URL of the site to disable the hub site feature. + +```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