Get-CrmSiteMap

NAME Get-CrmSiteMap



SYNOPSIS

Retrieves CRM Organization's SiteMap information.





SYNTAX

Get-CrmSiteMap [-conn <CrmServiceClient>] [-SiteXml <SwitchParameter>] [<CommonParameters>]



Get-CrmSiteMap [-conn <CrmServiceClient>] [-Areas <SwitchParameter>] [<CommonParameters>]



Get-CrmSiteMap [-conn <CrmServiceClient>] [-GroupsOfArea <String>] [<CommonParameters>]



Get-CrmSiteMap [-conn <CrmServiceClient>] [-SubAreasOfArea <String>] [<CommonParameters>]





DESCRIPTION

The Get-CrmSiteMap cmdlet lets you retrieve CRM Organization's SiteMap information.





PARAMETERS

-conn <CrmServiceClient>

A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SiteXml [<SwitchParameter>]

Specify SiteXml switch to retrieve SiteMapXml xml data.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Areas [<SwitchParameter>]

Specify Areas switch to retrieve AreaIds list.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-GroupsOfArea <String>

Passing AreaId to GroupsOfArea parameter retrievs GroupIds of the specified Area.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SubAreasOfArea <String>

Passing AreaId to SubAreasOfArea parameter retrievs SubAreaIds of the specified Area.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS









NOTES









-------------------------- Example 1 --------------------------



Get-CrmSiteMap -conn $conn -SiteXml



This example retrieves CRM Organization's SiteMap data.







<SiteMap IntroducedVersion="7.0.0.0"><Area Id="SFA" ResourceId="Area_Sales"..



-------------------------- Example 2 --------------------------



Get-CrmSiteMap -conn $conn -Areas



This example retrieves AreaIds of CRM Organization's SiteMap.







SFA

CS

MA

Settings

HLP



-------------------------- Example 3 --------------------------



Get-CrmSiteMap -conn $conn -GroupsOfArea SFA









MyWork

Customers

SFA

Collateral

MA

Goals

Tools



-------------------------- Example 4 --------------------------



This example retrieves GroupIds of CRM Organization's SiteMap.



This example retrieves SubAreaIds of CRM Organization's SiteMap by omitting parameter names.

When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.







Get-CrmSiteMap -SubAreasOfArea SFA

nav_dashboards

nav_personalwall

nav_activities

nav_accts

nav_conts

nav_leads

nav_oppts

...





RELATED LINKS