Skip to content

Commit 100d389

Browse files
authored
Merge pull request MicrosoftDocs#1114 from MicrosoftDocs/master
Master to ExMigration
2 parents 42c4533 + 9aefdb5 commit 100d389

File tree

1,067 files changed

+11059
-8649
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,067 files changed

+11059
-8649
lines changed

exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ $<VariableName> = Get-Content <text file>
8080
```
8181

8282
```
83-
$<VariableName> | foreach {Set-User -RemotePowerShellEnabled $false
83+
$<VariableName> | foreach {Set-User -RemotePowerShellEnabled $false}
8484
```
8585

8686
This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their email addresses. The text file must contain one email address on each line as follows:
@@ -131,4 +131,4 @@ To display only those users who have access to Exchange Online PowerShell, run t
131131

132132
```
133133
Get-User -ResultSize unlimited -Filter {RemotePowerShellEnabled -eq $true}
134-
```
134+
```

exchange/exchange-ps/exchange/mailboxes/Get-CalendarProcessing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Get-CalendarProcessing [-Identity] <MailboxIdParameter> [-DomainController <Fqdn
2323
```
2424

2525
## DESCRIPTION
26+
For details about the properties that are returned in the output of this cmdlet, see Set-CalendarProcessing (https://docs.microsoft.com/powershell/module/exchange/mailboxes/set-calendarprocessing).
27+
2628
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
2729

2830
## EXAMPLES

exchange/exchange-ps/exchange/move-and-migration/Complete-MigrationBatch.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ After a migration batch for a local or cross-forest move has successfully run an
3434

3535
When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet.
3636

37-
If a migration batch has a status of Completed with Errors, you can rerun the Complete-MigrationBatch cmdlet. The cmdlet will attempt to finalize the failed users.
37+
If a migration batch has a status of Completed with Errors, you can re-attempt to finalize the failed users. In Exchange Online, use the Start-MigrationBatch cmdlet to retry migration for failed users. In Exchange 2013 or Exchange 2016, use the Complete-MigrationBatch to retry these failed users.
3838

3939
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
4040

@@ -101,6 +101,8 @@ Accept wildcard characters: False
101101
```
102102
103103
### -NotificationEmails
104+
This parameter is applicable only to on-premises Exchange.
105+
104106
The NotificationEmails parameter specifies one or more email addresses that status reports are sent to after the migration batch is completed. You can specify multiple email addresses separated by commas.
105107
106108
If you don't use this parameter, the final status report is sent to the administrator who runs the Complete-MigrationBatch cmdlet.

exchange/exchange-ps/exchange/move-and-migration/New-MigrationBatch.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,19 @@ Accept wildcard characters: False
433433
```
434434
435435
### -CompleteAfter
436-
This parameter is reserved for internal Microsoft use.
436+
The CompleteAfter parameter specifies a delay before the batch is completed. The batch is started, but not completed until the date/time you specify with this parameter.
437+
438+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
439+
440+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
441+
442+
To specify a date/time value for this parameter, use either of the following options:
443+
444+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
445+
446+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
447+
448+
This parameter should only be used in the cloud-based service.
437449
438450
```yaml
439451
Type: DateTime
@@ -640,7 +652,11 @@ Accept wildcard characters: False
640652
```
641653
642654
### -ReportInterval
643-
This parameter is reserved for internal Microsoft use.
655+
The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails.
656+
657+
By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch.
658+
659+
This parameter should only be used in the cloud-based service.
644660
645661
```yaml
646662
Type: TimeSpan
@@ -697,7 +713,19 @@ Accept wildcard characters: False
697713
```
698714
699715
### -StartAfter
700-
This parameter is reserved for internal Microsoft use.
716+
The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The batch is started, but the data migration for users within the batch isn't started until the date/time you specify with this parameter.
717+
718+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
719+
720+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
721+
722+
To specify a date/time value for this parameter, use either of the following options:
723+
724+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
725+
726+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
727+
728+
This parameter should only be used in the cloud-based service.
701729
702730
```yaml
703731
Type: DateTime

exchange/exchange-ps/exchange/move-and-migration/New-MigrationEndpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ Accept wildcard characters: False
579579
### -Security
580580
This parameter is available only in the cloud-based service.
581581
582-
The Security parameter specifies the encryption method used by the IMAP server for an IMAP migration. Options are None, SSL (the default), or TLS. This parameter is required when you want to migrate data from an on-premises IMAP server to cloud-based mailboxes.
582+
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
583583
584584
```yaml
585585
Type: None | Ssl | Tls

exchange/exchange-ps/exchange/move-and-migration/Set-MigrationBatch.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,19 @@ Accept wildcard characters: False
145145
```
146146
147147
### -CompleteAfter
148-
This parameter is reserved for internal Microsoft use.
148+
The CompleteAfter parameter specifies a delay before the batch is completed. The batch is started, but not completed until the date/time you specify with this parameter.
149+
150+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
151+
152+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
153+
154+
To specify a date/time value for this parameter, use either of the following options:
155+
156+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
157+
158+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
159+
160+
This parameter should only be used in the cloud-based service.
149161
150162
```yaml
151163
Type: DateTime
@@ -255,7 +267,11 @@ Accept wildcard characters: False
255267
```
256268
257269
### -ReportInterval
258-
This parameter is reserved for internal Microsoft use.
270+
The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails.
271+
272+
By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch.
273+
274+
This parameter should only be used in the cloud-based service.
259275
260276
```yaml
261277
Type: TimeSpan
@@ -287,7 +303,19 @@ Accept wildcard characters: False
287303
```
288304
289305
### -StartAfter
290-
This parameter is reserved for internal Microsoft use.
306+
The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The batch is started, but the data migration for users within the batch isn't started until the date/time you specify with this parameter.
307+
308+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
309+
310+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
311+
312+
To specify a date/time value for this parameter, use either of the following options:
313+
314+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
315+
316+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
317+
318+
This parameter should only be used in the cloud-based service.
291319
292320
```yaml
293321
Type: DateTime

exchange/exchange-ps/exchange/move-and-migration/Set-MigrationEndpoint.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Accept wildcard characters: False
8787
### -Authentication
8888
This parameter is available only in the cloud-based service.
8989
90-
The Authentication parameter specifies the authentication method used by the on-premises mail server.
90+
The Authentication parameter specifies the authentication method used by the remote mail server.
9191
9292
```yaml
9393
Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured
@@ -295,7 +295,9 @@ Accept wildcard characters: False
295295
```
296296
297297
### -Security
298-
This parameter is reserved for internal Microsoft use.
298+
This parameter is available only in the cloud-based service.
299+
300+
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
299301
300302
```yaml
301303
Type: None | Ssl | Tls

exchange/exchange-ps/exchange/move-and-migration/Start-MigrationBatch.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Start-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Confirm] [-Doma
2525
## DESCRIPTION
2626
The Start-MigrationBatch cmdlet starts a pending migration batch that was created, but not started, with the New-MigrationBatch cmdlet.
2727

28+
The Start-MigrationBatch cmdlet also will resume a Stopped migration batch or retry failures within a Failed or Synced with Errors migration batch. In the cloud-based service, the Start-MigrationBatch cmdlet can also retry failures within a Completed with Errors migration batch.
29+
30+
In the cloud-based service, the Start-MigrationBatch cmdlet can be run at any time to retry failed users within the batch.
31+
2832
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
2933

3034
## EXAMPLES

exchange/exchange-ps/exchange/move-and-migration/Test-MigrationServerAvailability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ Accept wildcard characters: False
513513
### -Security
514514
This parameter is available only in the cloud-based service.
515515
516-
The Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. Use this parameter only when testing the connection to an IMAP server or in preparation for creating a migration endpoint for an IMAP migration.
516+
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
517517
518518
```yaml
519519
Type: None | Ssl | Tls

exchange/exchange-ps/exchange/organization/Set-OrganizationConfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1879,7 +1879,7 @@ Accept wildcard characters: False
18791879
### -IPListBlocked
18801880
This parameter is available only in the cloud-based service.
18811881
1882-
The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. These settings affect client connections that use Basic authentication where on-premises Active Directory Federation Services (ADFS) servers federate authentication with Azure Active Directory.
1882+
The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. These settings affect client connections that use Basic authentication where on-premises Active Directory Federation Services (ADFS) servers federate authentication with Azure Active Directory. Note that the new settings might take up to 4 hours to fully propagate across the service.
18831883
18841884
This parameter accepts IPv4 or IPv6 addresses in the following formats:
18851885

exchange/exchange-ps/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,11 +194,11 @@ Accept wildcard characters: False
194194
```
195195
196196
### -SharePointLocation
197-
The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites.
197+
The SharePointLocation parameter specifies the SharePoint Online and OneDrive for Business sites to include. You identify a site by its URL value.
198198
199199
To enter multiple values, use the following syntax: \<value1\>,\<value2\>,...\<valueX\>. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\<value1\>","\<value2\>",..."\<valueX\>".
200200
201-
SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold.
201+
Sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold.
202202
203203
```yaml
204204
Type: MultiValuedProperty

repo_docs/NEW_CMDLETS.md

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,62 @@
11
# Generate Your Own Markdown
2-
**SECTION IN PROGRESS**
32

43
1. Open PowerShell as Administrator.
5-
2. Import the module you want to document.
6-
- Skype for Business Online: https://technet.microsoft.com/en-us/library/dn362795(v=ocs.15).aspx
7-
- Microsoft Teams: https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/
8-
Hint: Might need to use Upgrade-Module and also Uninstall-Module depending on version and if you already have a version installed.
9-
3. Use PlatyPS to generate Markdown.
10-
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
11-
4. Find the new cmdlet and you will see the stubbed markdown.
12-
5. Add correct metadata, see other similar cmdlets for examples.
13-
6. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet. See others for details.
4+
1. Import the module you want to document.
5+
- Skype for Business Online: https://technet.microsoft.com/en-us/library/dn362795(v=ocs.15).aspx
6+
- Microsoft Teams: https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/
7+
8+
**HINT:** Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed.
9+
1. Use PlatyPS to generate Markdown.
10+
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
11+
12+
**TIP:** You can see available modules with the command `Get-Module --listavailable`.
13+
1. Find the new cmdlet and you will see the stubbed markdown.
14+
1. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet.
15+
See others for details.
1416
This is important since when the XML is generated to go back into the product the applicable is what is used for which content goes into which product.
15-
7. Add the cmdlet to TOC. TOC file is the name of the module.
16-
For example, for all Skype cmdlets the TOC file is skype.md.
17-
8. Submit a Pull Request into the repo in appropriate place with adding the new cmdlet. aka.ms/office-powershell
17+
18+
You will need to add the title and also applicable metadata for the cmdlet and also for each parameter.
1819

20+
**Example metadata for each parameter:** Notice the `applicable` and `title` tag is added with appropriate 'whitelisted' product name.
1921

22+
```
23+
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
24+
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
25+
online version:
26+
applicable: Microsoft StaffHub
27+
title: Get-StaffHubUsersForTenant
28+
schema: 2.0.0
29+
```
30+
31+
**Example metadata for each parameter:** Notice the `Applicable` tag is added with appropriate **whitelisted** product name.
32+
33+
```
34+
Type: String
35+
Parameter Sets: (All)
36+
Aliases:
37+
Applicable: Microsoft StaffHub
38+
Required: False
39+
Position: 1
40+
Default value: None
41+
Accept pipeline input: False
42+
Accept wildcard characters: False
43+
```
2044
21-
If you want to merge multiple versions into a single version then use the PlatyPS merge command.
2245
23-
Make sure to update the TOC file. Exact format required so that the template text doesn't show up.
46+
1. Add the cmdlet to Table of Contents (TOC) file. TOC file is the name of the module.
47+
For example, for all Teams cmdlets the TOC file is teams.md.
48+
You can fill in a description or remove the template text line.
49+
However, if you leave the template text line make sure it is exactly in the right format so that it will not render as a template text.
50+
1. Submit a Pull Request into the repo in appropriate place with adding the new cmdlet. aka.ms/office-powershell
2451
25-
Add metadata to the file so it shows in the correct reports. See these scripts to do it or you can do it manually too.
2652
2753
28-
References:
29-
https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
30-
https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
31-
https://github.com/PowerShell/platyPS
54+
If you want to merge multiple versions into a single version then use the PlatyPS merge command.
55+
56+
Note: If this is a brand new product you need to add metadata at the global level in order for it to show up in reporting.
57+
58+
## References
59+
* https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
60+
* https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
61+
* https://github.com/PowerShell/platyPS
62+
* https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-module?view=powershell-6

sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
109109
110110
## RELATED LINKS
111111
112-
[Introduction to the SharePoint Online management shell]()
112+
[Introduction to the SharePoint Online management shell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps)
113+
114+
[Set up the SharePoint Online Management Shell Windows PowerShell environment](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps)
115+
113116
114-
[Set up the SharePoint Online Management Shell Windows PowerShell environment]()

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Parameter Sets: (All)
6363
Aliases:
6464
Applicable: SharePoint Online
6565

66-
Required: True
66+
Required: False
6767
Position: Named
6868
Default value: None
6969
Accept pipeline input: False

0 commit comments

Comments
 (0)