@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/get-rendering.md

@@ -0,0 +1,248 @@
+# Get-Rendering
+
+Returns a RenderingDefinition for an item using the filtering parameters.
+
+## Syntax
+
+```powershell
+Get-Rendering -Item <Item> [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering -Item <Item> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering -Item <Item> -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering -Path <String> [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering -Path <String> -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering -Path <String> -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering [-Id <String>] [-Database <String>] [-DataSource <String>] [-Rendering <Item>] [-Index <Int32>] [-PlaceHolder <String>] [-Parameter <Hashtable>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering [-Id <String>] [-Database <String>] -Instance <RenderingDefinition> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Rendering [-Id <String>] [-Database <String>] -UniqueId <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+```
+
+## Detailed Description
+
+The Get-Rendering command returns a RenderingDefinition for an item using the filtering parameters.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  &lt;Item&gt;
+
+The item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+Id of the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DataSource  &lt;String&gt;
+
+Data source filter - supports wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Rendering  &lt;Item&gt;
+
+Item representing the sublayout/rendering. If matching the rendering will be returned.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Index  &lt;Int32&gt;
+
+Index at which the rendering exists in the layout. The rendering at that index will be returned.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PlaceHolder  &lt;String&gt;
+
+Place holder at which the rendering exists in the layout. Renderings at that place holder will be returned.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameter  &lt;Hashtable&gt;
+
+Additional rendering parameter values. If both name and value match - the rendering will be returned. Values support wildcards.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Specific instance of rendering that should be returned. The instance could earlier be obtained through e.g. use of Get-Rendering.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -UniqueId  &lt;String&gt;
+
+UniqueID of the rendering to be retrieved.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Device  &lt;DeviceItem&gt;
+
+Device for which the renderings will be retrieved.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FinalLayout  &lt;SwitchParameter&gt;
+
+Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Layouts.RenderingDefinition
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Get all renderings for "Default" device, located in the any placeholder that has name in it or any of its sub-placeholders.
+
+```powershell
+Get-Item master:\content\home | 
+    Get-Rendering -Placeholder "*main*" -Device (Get-LayoutDevice "Default")
+```
+
+### EXAMPLE 2
+
+The following example returns all renderings on the home page.
+
+```powershell
+$item = Get-Item -Path "master:" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+$defaultLayout = Get-LayoutDevice "Default"
+Get-Rendering -Item $item -Device $defaultLayout -FinalLayout
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-Rendering](add-rendering.md)
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+

package/dist/tools/powershell/documentation/get-renderingparameter.md

@@ -0,0 +1,84 @@
+# Get-RenderingParameter
+
+Gets the available rendering parameters found for a given rendering.
+
+## Syntax
+
+```powershell
+Get-RenderingParameter -Instance <RenderingDefinition> [-Name <String[]>]
+```
+
+## Detailed Description
+
+Gets the available rendering parameters found for a given rendering.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Rendering definition containing the rendering parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Name  &lt;String\[\]&gt;
+
+The names (or keys) identifying specific rendering parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Layouts.RenderingDefinition
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* IDictionary
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+The following gets all renderings for a given item and lists the available rendering parameters.
+
+```powershell
+$item = Get-Item -Path "master" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+
+foreach($itemRendering in Get-Rendering -Item $item -FinalLayout) {
+    Write-Host "Rendering UniqueId: $($itemRendering.UniqueId)"
+    Get-RenderingParameter -Rendering $itemRendering | Format-Table -Auto
+}
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+

package/dist/tools/powershell/documentation/get-role.md

@@ -0,0 +1,134 @@
+# Get-Role
+
+Returns one or more Sitecore roles using the specified criteria.
+
+## Syntax
+
+Get-Role \[-Identity\] <AccountIdentity>
+
+Get-Role -Filter <String>
+
+## Detailed Description
+
+The Get-Role command returns one or more Sitecore roles using the specified criteria.
+
+The Identity parameter specifies the Sitecore role to get. You can specify a role by its local name or fully qualified name. You can also specify role object variable, such as $<role>.
+
+To search for and retrieve more than one role, use the Filter parameter.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore role by providing one of the following values.
+
+```powershell
+Local Name
+    Example: developer
+Fully Qualified Name
+    Example: sitecore\developer
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Filter  <String>
+
+Specifies a simple pattern to match Sitecore roles.
+
+Examples: The following examples show how to use the filter syntax.
+
+To get all the roles, use the asterisk wildcard: Get-Role -Filter \*
+
+To get all the roles in a domain use the following command: Get-Role -Filter "sitecore\*"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.String
+
+  Represents the identity of a role.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Security.Accounts.Role
+
+  Returns one or more roles.
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-Role -Identity sitecore\developer
+
+Name                                     Domain       IsEveryone
+----                                     ------       ----------
+sitecore\developer                       sitecore     False
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> "sitecore\developer","sitecore\author" | Get-Role
+
+Name                                     Domain       IsEveryone
+----                                     ------       ----------
+sitecore\author                          sitecore     False
+sitecore\developer                       sitecore     False
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-Role -Filter sitecore\d*
+
+Name                                     Domain       IsEveryone
+----                                     ------       ----------
+sitecore\Designer                        sitecore     False
+sitecore\Developer                       sitecore     False
+```
+
+### EXAMPLE 4
+
+Expand the MemberOf property to see a list of roles that the specified role is a member.
+
+```powershell
+PS master:\> Get-Role -Identity sitecore\developer | Select-Object -ExpandProperty MemberOf
+
+Name                                     Domain       IsEveryone
+----                                     ------       ----------
+sitecore\Sitecore Client Configuring     sitecore     False
+sitecore\Sitecore Client Developing      sitecore     False
+sitecore\Designer                        sitecore     False
+sitecore\Author                          sitecore     False
+sitecore\Sitecore Client Maintaining     sitecore     False
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-RoleMember](get-rolemember.md)
+

package/dist/tools/powershell/documentation/get-rolemember.md

@@ -0,0 +1,131 @@
+# Get-RoleMember
+
+Returns the Sitecore users in the specified role.
+
+## Syntax
+
+Get-RoleMember \[-Identity\] <AccountIdentity> \[-Recurse\]
+
+Get-RoleMember \[-Identity\] <AccountIdentity> \[-UsersOnly\] \[-Recurse\]
+
+Get-RoleMember \[-Identity\] <AccountIdentity> \[-RolesOnly\] \[-Recurse\]
+
+## Detailed Description
+
+The Get-RoleMember command returns the Sitecore users in the specified role.
+
+The Identity parameter specifies the Sitecore role to get. You can specify a role by its local name or fully qualified name.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore role by providing one of the following values.
+
+```powershell
+Local Name
+    Example: developer
+Fully Qualified Name
+    Example: sitecore\developer
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Recurse  <SwitchParameter>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -UsersOnly  <SwitchParameter>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -RolesOnly  <SwitchParameter>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.String
+
+  Represents the identity of a role.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Security.Accounts.User
+
+  Returns one or more users.
+
+Sitecore.Security.Accounts.Role Returns one or more roles.
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Get-RoleMember -Identity developer
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+sitecore\michael         sitecore     False           False
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> Get-RoleMember -Identity author
+
+Name                     Domain       IsAdministrator IsAuthenticated
+----                     ------       --------------- ---------------
+sitecore\michael         sitecore     False           False
+
+Domain      : sitecore
+IsEveryone  : False
+IsGlobal    : False
+AccountType : Role
+Description : Role
+DisplayName : sitecore\Developer
+LocalName   : sitecore\Developer
+Name        : sitecore\Developer
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-Role](get-role.md)
+* [Remove-RoleMember](remove-rolemember.md)
+* [Add-RoleMember](add-rolemember.md)
+