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
Copy file name to clipboardExpand all lines: repo_docs/UPDATE_CMDLETS.md
+25-25Lines changed: 25 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -3,19 +3,19 @@ Manually adding new parameters to a cmdlet reference topic is doable, but there
3
3
4
4
-**Add the paramter and Type value to the SYNTAX block(s)**: Easy to do if there's only one, but what if there are multiple SYNTAX blocks (also known as parameter sets)? Does the new parameter go in one, some, or all of them? And what about the parameter Type value (String? `$true | $ false`? A finite list of values?)
5
5
6
-
-**Create a new section for each parameter**: It's easy to create the section and write the descrition, but again, what about the parameter Type value? And which parameter sets does it belong to?
6
+
-**Create a new section for each parameter**: It's easy to create the section and write the description, but again, what about the parameter Type value? And which parameter sets does it belong to?
7
7
8
8
The reality is: you almost always need the open-source [platyPS](https://github.com/PowerShell/platyPS) tool to automatically answer the unknowns about new parameters.
9
9
10
-
Currently, the best method with platyPS is to simply create a new version of the topic using the **New-MarkdownHelp** cmdlet, and copy whatever you need out of it. Theoretically, platyPS has an **Update-MarkdownHelp** cmdlet that automatically updates an existing local copy of the topic for you, which you can then upload in its entirety to the GitHub website to replace the exisitng topic. This approach currently has some issues in our enviornment:
10
+
Currently, the best method with platyPS is to simply create a new version of the topic using the **New-MarkdownHelp** cmdlet, and copy whatever you need out of it. Theoretically, platyPS has an **Update-MarkdownHelp** cmdlet that automatically updates an existing local copy of the topic for you, which you can then upload in its entirety to the GitHub website to replace the existing topic. This approach currently has some issues in our environment:
11
11
12
12
- It's difficult to get a local copy of an existing cmdlet topic from the GitHub website (unless you're interested in forking the repo and having a local cloned copy on your computer). You have to copy/paste everything from the Raw view of the topic on the web site, and the local copy text file you manually create needs to be UTF-8 formatted (instead of the Notepad default of ANSI).
13
13
14
14
- The updated topic will have missing or incorrect _unrelated_ parameter and other topic metadata information that you'll need to change by copy/pasting those values _back from_ the existing topic on GitHub into your local topic before you can even think about uploading the updated topic to GitHub (more than double the work required).
15
15
16
16
In short, it's simply easier and faster to generate a new local copy of the cmdlet topic, and copy/paste only what you need into the existing topic on GitHub.
17
17
18
-
Removing parameters from topics is a manual excercise, but we'll explain the process fully.
18
+
Removing parameters from topics is a manual exercise, but we'll explain the process fully.
19
19
20
20
## Use platyPS to add new cmdlets to existing topics
21
21
@@ -28,7 +28,7 @@ You probably know how to do this already, but the available workloads and connec
28
28
### Step 3: Load platyPS in the PowerShell environment
29
29
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:
30
30
31
-
```
31
+
```powershell
32
32
Import-Module platyPS
33
33
```
34
34
@@ -39,37 +39,37 @@ To recap: this step is required in Exchange, Skype for Business Online and other
39
39
40
40
If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell to connect, you can skip this step.
41
41
42
-
### Step 5: Use New-MarkdownHelp to dump the latest verion of the cmdlet to a file
42
+
### Step 5: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file
43
43
These instructions are the same (up to a point) as in [Create new cmdlet topics](NEW_CMDLETS.md):
This example create a topic file for the updated cmdlet named Get-CoolFeature in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO".
This example creates topic files for the updated 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.
65
65
66
66
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.
@@ -78,25 +78,25 @@ The resulting topics are plain text UTF-8 files that are formatted using [markdo
78
78
79
79
1. Find the new parameter(s) in the SYNTAX block and the parameter sections.
80
80
81
-
2. Add a parameter description. We highly enourage you to plagerize existing content and formatting from other cmdlet topics. Many parameters are common across a wide variety of cmdlets.
81
+
2. Add a parameter description. We highly encourage you to plagiarize existing content and formatting from other cmdlet topics. Many parameters are common across a wide variety of cmdlets.
82
82
83
83
3. Create/fill out the parameter metadata like other existing parameters in the topic.
84
84
85
85
Here's an example of the parameter metadata that's present in every parameter section:
86
86
87
-
```
88
-
Type: String
89
-
Parameter Sets: (All)
90
-
Aliases:
91
-
Applicable: Microsoft StaffHub
92
-
Required: False
93
-
Position: 1
94
-
Default value: None
95
-
Accept pipeline input: False
96
-
Accept wildcard characters: False
87
+
```yaml
88
+
Type: String
89
+
Parameter Sets: (All)
90
+
Aliases:
91
+
Applicable: Microsoft StaffHub
92
+
Required: False
93
+
Position: 1
94
+
Default value: None
95
+
Accept pipeline input: False
96
+
Accept wildcard characters: False
97
97
```
98
98
99
-
Most of the atrributes and values are generated automatically by platyPS. The ones that require manual intervention are:
99
+
Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are:
100
100
101
101
- **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values.
102
102
@@ -109,7 +109,7 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po
For Exchage, you also need to go one level deepter into an appropriate subfolder.
112
+
For Exchange, you also need to go one level deeper into an appropriate subfolder.
113
113
114
114
- Office Web Apps: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps)
115
115
@@ -141,9 +141,9 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po
141
141
7. On the next screen, click **Create pull request**.
142
142
143
143
## Remove existing parameters from existing topics
144
-
Removing parameters is a search and destroy mission in the existing topics on GitHub, using the basic [Editing Instrucstions](../README.md).
144
+
Removing parameters is a search and destroy mission in the existing topics on GitHub, using the basic [Editing Instructions](../README.md).
145
145
146
-
The most important thing to remember: a parameter isn't gone until it's truly not available to customers. If a parameter is still available, but it's going away "in the future", it doesn't work correctly anymore, or isn't supposed to be available, it needs to remain in the topic until the product code is actually changed to remove the parameter. Until then, you can use this type of languague for the parameter description:
146
+
The most important thing to remember: a parameter isn't gone until it's truly not available to customers. If a parameter is still available, but it's going away "in the future", it doesn't work correctly anymore, or isn't supposed to be available, it needs to remain in the topic until the product code is actually changed to remove the parameter. Until then, you can use this type of language for the parameter description:
147
147
148
148
- This parameter is reserved for internal Microsoft use.
Copy file name to clipboardExpand all lines: skype/skype-ps/skype/Grant-CsTeamsCallParkPolicy.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ schema: 2.0.0
11
11
12
12
The TeamsCallParkPolicy controls whether or not users are able to leverage the call park feature in Microsoft Teams. Call park allows enterprise voice customers to place a call on hold and then perform a number of actions on that call: transfer to another department, retrieve via the same phone, or retrieve via a different Teams phone. The Grant-CsTeamsCallParkPolicy cmdlet lets you assign a custom policy to a specific user.
13
13
14
-
NOTE: the call park feature currently only available in desktopand web clients. Call Park functionality is currently completely disabled in mobile clients. Supported with TeamsOnly mode
14
+
NOTE: the call park feature currently only available in desktop, web clients and mobile clients. Call Park functionality is currently on the roadmap for Teams IP Phones. Supported with TeamsOnly mode for users with the Phone Sytem license
When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device.
404
404
This information can then be applied to auto-logon scenarios.
405
405
406
+
Note: If a user has AllowSaveCredentials set to False in the CsMobility policy, the Skype for Business App for iOS may sign out automatically when bringing it from the background to the foreground. This is due to the password not being saved anywhere but in the iOS process memory. Once the process is killed by the iOS system, the password will no longer be available, so the user will need to enter it again. However, there is no impact if modern authenticaion is implemented.
- Exchange Online cmdlets could be imported using [this guide](https://docs.microsoft.com/en-us/powershell/exchange/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell)
20
+
- Exchange Online:
21
+
- cmdlets could be imported using [this guide](https://docs.microsoft.com/en-us/powershell/exchange/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell)
- alternatively, it could be installed by the tool, check Notes section below
25
+
7. Run the app, type `node index` and press Enter in order to get info for all modules
26
+
8. Run the app for a certain module, type `node index -m <TypeModuleNameHere>`, with one of the following options - teams, skype, sharepoint, whiteboard, exchange. For example, you should run `node index -m teams` to run the tool for Microsoft Teams
27
+
9. Run `node index -help` to get help information for all available commands
28
28
29
29
## Notes
30
-
1. The modules are installed from the PowerShell Gallery (PSGallery).
31
-
This gallery contains user submitted code.
32
-
If you would rather not install modules from the PSGallery then you can install the modules manually prior to running the tool.
33
-
If you need to add PSGallery as a trusted source, you can do so with the following command:
1. Some modules could be installed from the PowerShell Gallery (PSGallery). This gallery contains user submitted code. If you would rather not install modules from the PSGallery then you can install the modules manually prior to running the tool. If you need to add PSGallery as a trusted source, you can do so with the following command: `Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted`
31
+
2. Run the tool from PowerShell x64 as an Administrator user
0 commit comments