Skip to content

Commit ff49450

Browse files
committed
Merge branch 'main' into CAF-chrisda
2 parents 981555a + 58a0683 commit ff49450

File tree

8 files changed

+64
-174
lines changed

8 files changed

+64
-174
lines changed

exchange/exchange-ps/exchange/New-Mailbox.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -809,6 +809,8 @@ This example assumes that you've already created a mail-enabled security group n
809809
### -Name
810810
The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
811811

812+
In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character).
813+
812814
```yaml
813815
Type: String
814816
Parameter Sets: (All)

exchange/exchange-ps/exchange/Set-Mailbox.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3980,6 +3980,8 @@ Accept wildcard characters: False
39803980
### -Name
39813981
The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
39823982

3983+
In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character).
3984+
39833985
```yaml
39843986
Type: String
39853987
Parameter Sets: (All)

exchange/exchange-ps/exchange/Update-StoreMailboxState.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,8 @@ To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Ty
144144
To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
145145

146146
## NOTES
147+
If a mailbox is moved to another database, the mailbox is immediately disabled. There's a 24-hour delay to allow for replication.
147148

148-
In a scenario where a mailbox is moved to another database, then the mailbox is immediately disabled, there is a 24-hour delay to allow for replication.
149-
150-
In this scenario Update-StoreMailboxState may not immediately update DisconnectState and DisconnectReason when running Get-MailboxStatistics. The mailbox statistics will update approximately 24 hours after the move.
149+
In this scenario, Update-StoreMailboxState might not immediately update the DisconnectState and DisconnectReason properties in the output of Get-MailboxStatistics. The values will update approximately 24 hours after the move.
151150

152151
## RELATED LINKS

images/open-a-pull-request-page.png

16.3 KB
Loading

images/propose-file-change.png

35.3 KB
Loading

images/upload_files.png

29.9 KB
Loading

repo_docs/NEW_CMDLETS.md

Lines changed: 37 additions & 123 deletions
Large diffs are not rendered by default.

repo_docs/UPDATE_CMDLETS.md

Lines changed: 21 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ The steps are the same as [Create new cmdlet topics](NEW_CMDLETS.md#step-1-insta
2929
You probably know how to do this already, but the available workloads and connection methods are also described in [Create new cmdlet topics](NEW_CMDLETS.md#step-2-connect-to-the-powershell-environment-that-has-the-cmdlet).
3030

3131
> [!NOTE]
32-
> In v3.0.0 or later of the EXO V3 module, you need to connect to Exchange Online in remote PowerShell mode using the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command. If you omit the _UseRPSSession_ switch and connect in REST API mode, the **Type** value of most parameters will be the incorrect and unhelpful `Object` or `Object[]` values. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module).
32+
> Remote PowerShell connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell in favor of REST API connections. For more information, see the following articles:
33+
>
34+
> - [REST API connections in the EXO V3 module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#rest-api-connections-in-the-exo-v3-module).
35+
> - [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692).
36+
> - [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432).
37+
>
38+
> REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. The true parameter type values are visible in product code.
3339
3440
### Step 3: Load platyPS in the PowerShell environment
3541

@@ -39,53 +45,41 @@ After you've connected in PowerShell to the server or service (either in a regul
3945
Import-Module platyPS
4046
```
4147

42-
### Step 4: Store your PSSession in a variable
43-
44-
This step is the same as in [Create new cmdlet topics](NEW_CMDLETS.md#step-5-store-your-pssession-in-a-variable).
45-
46-
To recap: this step is required in Exchange and other products that use remote PowerShell.
47-
48-
> [!NOTE]
49-
> As described earlier, you need to connect to Exchange Online in remote PowerShell mode using the _UseRPSSession_ switch in the **Connect-ExchangeOnline** command. Although the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet is a reasonable replacement for Get-PSSession in REST API mode, the output doesn't work with the _Session_ parameter in **New-MarkdownHelp**. For more information about the EXO V3 module, see [Updates for version 3.0.0 (the EXO V3 module)](/powershell/exchange/exchange-online-powershell-v2#updates-for-version-300-the-exo-v3-module).
50-
51-
If you're using Microsoft Teams or another product that doesn't use remote PowerShell, you can skip this step.
52-
53-
### Step 5: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file
48+
### Step 4: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file
5449

5550
These instructions are the same (up to a point) as in [Create new cmdlet topics](NEW_CMDLETS.md):
5651

5752
The basic syntax is:
5853

5954
```powershell
60-
New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> [-Session <PSSessionVariableName>]
55+
New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path">
6156
```
6257

6358
or
6459

6560
```powershell
6661
$x = "<Cmdlet1>","<Cmdlet2>",..."<CmdletN>"
67-
New-MarkdownHelp -Command $x -OutputFolder "<Path"> [-Session <PSSessionVariableName>]
62+
63+
New-MarkdownHelp -Command $x -OutputFolder "<Path">
6864
```
6965

70-
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".
66+
This example create a topic file for the updated cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session in the folder "C:\My Docs\ExO".
7167

7268
```powershell
73-
New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session
69+
New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO"
7470
```
7571

76-
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.
72+
This example creates topic files for the updated cmdlets **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** from the Exchange Online session in the folder C:\My Docs\ExO.
7773

7874
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.
7975

8076
```powershell
8177
$Delta = "Get-CoolFeature","New-CoolFeature","Remove-CoolFeature","Set-CoolFeature"
82-
```
8378
84-
```powershell
85-
New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO" -Session $Session
79+
New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO"
8680
```
8781

88-
### Step 6: Document the new parameters
82+
### Step 5: Document the new parameters
8983

9084
The resulting topics are plain text UTF-8 files that are formatted using [markdown](https://guides.github.com/features/mastering-markdown/). Office writers use [Visual Studio Code](https://code.visualstudio.com/) to edit topic files, but you can use Notepad or your favorite text editor.
9185

@@ -112,13 +106,13 @@ The resulting topics are plain text UTF-8 files that are formatted using [markdo
112106
113107
Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are:
114108
109+
- **Type**: In any environment, the values `Object` or `Object[]` are wrong. As previously described, REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. Other values like `String`, `Boolean`, and `DateTime` are detected correctly. The true parameter type values are visible in product code.
110+
115111
- **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.
116112

117113
- **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS **or any other PowerShell utility** (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is.
118114

119-
### Step 7: Copy your changes into the existing topic on GitHub
120-
121-
At this point, the steps are basically identical to [Short URL: aka.ms/office-powershell](../README.md):
115+
### Step 6: Copy your changes into the existing topic on GitHub
122116

123117
1. Go to the cmdlet topics location in the appropriate GiHub repository:
124118

@@ -129,35 +123,14 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po
129123
- Teams: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/teams/teams-ps/teams>
130124
- Whiteboard: <https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/whiteboard/whiteboard-ps/whiteboard>
131125

132-
2. Find the topic and click **Edit**
126+
2. Find the existing topic and click **Edit**.
133127

134128
3. Copy/paste your updates (and only your updates) from your new, local copy of the topic into the existing topic (click the **Preview** tab to see what they'll look like).
135129

136130
> [!IMPORTANT]
137131
> The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help. Any deviation will throw errors in the Pull Request. The schema can be found here: <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>.
138132

139-
4. After you're done modifying files, go to the **Propose file change** section at the bottom of the page:
140-
141-
- A brief title is required. By default, the title is the name of the file, but you can change it.
142-
- Optionally, you can enter more details in the **Add an optional extended description** box.
143-
144-
When you're ready, click the green **Propose file change** button.
145-
146-
![Propose file change section.](../images/propose-file-change.png)
147-
148-
5. On the **Comparing changes** page that appears, click the green **Create pull request** button.
149-
150-
![Comparing changes page.](../images/comparing-changes-page.png)
151-
152-
6. On the **Open a pull request** page that appears, click the green **Create pull request** button.
153-
154-
![Open a pull request page.](../images/open-a-pull-request-page.png)
155-
156-
> [!NOTE]
157-
>
158-
> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.
159-
>
160-
> The point is: click any green buttons that are presented to you until there are no more.
133+
4. At this point, the steps are identical to [Short URL: aka.ms/office-powershell](../README.md) (You're starting at Step 4).
161134

162135
## Remove existing parameters from existing topics
163136

0 commit comments

Comments
 (0)