Share via


Get-SPOStructuralNavigationCacheSiteState

Get the structural navigation caching state for a site collection.

Syntax

Default (Default)

Get-SPOStructuralNavigationCacheSiteState
    -SiteUrl <String>
    [<CommonParameters>]

Description

The Get-SPOStructuralNavigationCacheSiteState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a site collection. Learn more.

Examples

Example 1

PS C:\> Get-SPOStructuralNavigationCacheSiteState -SiteUrl "https://contoso.sharepoint.com/sites/product/"

This example checks if structural navigation caching is enabled for the entire site collection https://contoso.sharepoint.com/sites/product/. If caching is enabled, then it will return True. If caching is disabled, then it will return False.

Parameters

-SiteUrl

Applicable: SharePoint Online Specifies the absolute URL for the site collection's root web being checked for its caching state.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object

Notes

To see the examples, type: "get-help Get-SPOStructuralNavigationCacheSiteState -examples".

For more information, type: "get-help Get-SPOStructuralNavigationCacheSiteState -detailed".

For technical information, type: "get-help Get-SPOStructuralNavigationCacheSiteState -full".

For online help, type: "get-help Get-SPOStructuralNavigationCacheSiteState -online"