Get-SPManagedPath

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Returns all managed paths that match the given criteria.

Syntax

Get-SPManagedPath
   [[-Identity] <SPPrefixPipeBind>]
   [-HostHeader]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Get-SPManagedPath
   [[-Identity] <SPPrefixPipeBind>]
   -WebApplication <SPWebApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web application, site collection or for all host-named site collections. If an Identity parameter is not provided, all managed paths for the given scope are returned.

Host-named sites (no matter the Web application in which they are contained) share a single set of managed paths. Use the HostHeader parameter to return host-named site collections-scoped managed paths.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

--------------EXAMPLE 1-----------------

Get-SPManagedPath -WebApplication https://sitename

This example returns all managed paths for the specified Web application.

--------------EXAMPLE 2-----------------

Get-SPManagedPath -identity "Sites" -HostHeader

This example gets the Sites managed path from the host-named site collections-scoped managed paths.

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-HostHeader

If provided, the managed paths returned are for the host-named sites in the farm.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the URL or GUID of the managed path to return.

The type must be a valid URL, in the https://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).

Type:	SPPrefixPipeBind
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WebApplication

Specifies the URL or GUID of the Web application from which to get the managed path.

The type must be a valid URL, in the form https://server_name, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).

Type:	SPWebApplicationPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Share via