You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you need to install platyPS on an older version of Windows (for example, a server running a product that lacks support for WMF 5.x or its requirements), see the Install platyPS on older versions of Windows section at the end of this topic.
29
+
If you need to install platyPS on an older version of Windows (for example, a server running a product that lacks support for WMF 5.x or its requirements), see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this topic.
30
30
31
31
## Step 2: Connect to the PowerShell environment that has the cmdlet
32
32
You probably know how to do this already, but the available workloads and connection methods are:
@@ -43,7 +43,7 @@ You probably know how to do this already, but the available workloads and connec
43
43
44
44
- Exchange Online: [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell)
45
45
46
-
- Office 365 Security & Compliance Center Power: [Connect to Office 365 Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell)
46
+
- Office 365 Security & Compliance Center: [Connect to Office 365 Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell)
47
47
48
48
- Exchange Online Protection: [Connect to Exchange Online Protection PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-eop/connect-to-exchange-online-protection-powershell)
49
49
@@ -53,10 +53,10 @@ You probably know how to do this already, but the available workloads and connec
53
53
54
54
- You might need to connect to the service in an elevated Windows PowerShell prompt (required for Skype for Business Online and Teams, but not Exchange). The connection instructions topic should contain this and other connection requirements.
55
55
56
-
- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are avaialble to administrators by default, but some aren't (for example, the Mailbox Search and Mailbox Import Export roles).
56
+
- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are avaialble to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles).
57
57
58
58
## Step 3: Load platyPS in the PowerShell environment
59
-
After you've connected in PowerShell to the server or service \(either in a regular Windows PowerShell window or from a specific PowerShell console shortcut\), run the following command to make the platyPS cmdlets available in your session:
59
+
After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session:
60
60
61
61
```
62
62
Import-Module platyPS
@@ -107,7 +107,7 @@ Either way, take note of your module name. You'll need it in the next steps.
107
107
108
108
Check the details of your connection instructions, but your session information is stored in a variable. For example, in the Exchange connection instructions, the variable is `$Session`. You'll use this variable name in later steps.
109
109
110
-
If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps:
110
+
**If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps**:
111
111
112
112
1. Run the following command to find your session:
113
113
@@ -142,7 +142,7 @@ If you connected via a custom script or your remote PowerShell session variable
142
142
For example, using the sample output in the previous step:
143
143
144
144
```
145
-
$x = Get-PSSession 1
145
+
$Session = Get-PSSession 1
146
146
```
147
147
148
148
The variable name you choose doesn't matter, but you'll use it in later steps.
- **Dump specific cmdlets to files**: This is a bit harder to setup, but the output is much quicker, and there are no extra topic files created. The basic syntax is:
158
+
- **Dump specific cmdlets to files**: This is a bit harder to set up, but the output is much quicker, and there are no extra topic files created. The basic syntax is:
- \<ModuleName\> is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `Microsoft.Online.SharePoint.PowerShell`).
174
174
175
-
- \<PSSessionVariableName\> is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) *and is required only if the connection instructions used remote PowerShell (one or more **xxx-xxxSession** commands)*.
175
+
- \<PSSessionVariableName\> is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection instructions used remote PowerShell (one or more **xxx-xxxSession** commands)_.
176
176
177
-
Failure to use the _Session_ parameter and value in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recogonized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc.
177
+
Failure to use the _Session_ parameter in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recogonized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc.
178
178
179
-
- If the <Path> location doesn't exist, it's created for you.
179
+
- If the \<Path\> location doesn't exist, it's created for you.
180
180
181
181
#### Dump all cmdlets in the module/snap-in to files
182
182
This example creates topic files for all available cmdlets in the Skype for Business Online PowerShell session where the module is `tmp_byivwzpq.e1k` and the session variable is `$Session` in the folder C:\My Docs\SfBO.
@@ -192,7 +192,7 @@ This example create a topic file for the cmdlet named Get-CoolFeature in the Exc
This example creates topic files for the cmdlets Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO.
195
+
This example creates topic files for the Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature cmdlets from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO.
196
196
197
197
The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files.
198
198
@@ -234,7 +234,7 @@ Here's an example of the cmdlet metadata that's required at the top of every top
234
234
schema: 2.0.0
235
235
```
236
236
237
-
- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange, SharePoint) use multiple XML files. See other topics for available values.
237
+
- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific, and the location is specified somewhere in product code. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange, SharePoint) use multiple XML files. See other topics for available values. Don't guess; a wrong value here will affect the avaialbility of the help topic at the command line.
238
238
239
239
- **Module Name**: Not used in Exchange topics (remove it). For other products, this is the module name of the product.
240
240
@@ -249,7 +249,7 @@ Here's an example of the cmdlet metadata that's required at the top of every top
249
249
##### Parameter metadata
250
250
Here's an example of the parameter metadata that's present in every parameter section:
251
251
252
-
```
252
+
```yaml
253
253
Type: String
254
254
Parameter Sets: (All)
255
255
Aliases:
@@ -319,7 +319,7 @@ Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is t
In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it is exactly in the right format so it won't render as a template text.
322
+
In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it's in _exactly_ the right format so it won't render as a template text.
323
323
324
324
After you're done editing the TOC file:
325
325
@@ -329,7 +329,7 @@ After you're done editing the TOC file:
4. In Windows Explorer, copy the PackageManagement and PowerShellGet folders FROM \<TargetPath\> TO C:\Program Files\WindowsPowerShell\Modules\ (effectively replacing the folders you deleted in the previous step).
368
+
4. In Windows Explorer, copy the PackageManagement and PowerShellGet folders FROM \<TargetPath\> TO C:\Program Files\WindowsPowerShell\Modules\ (replacing the folders you deleted in Step 3 with the new ones you downloaded in Step 2).
0 commit comments