Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ After a migration batch for a local or cross-forest move has successfully run an

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

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

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).

Expand Down Expand Up @@ -101,6 +101,8 @@ Accept wildcard characters: False
```

### -NotificationEmails
This parameter is applicable only to on-premises Exchange.

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.

If you don't use this parameter, the final status report is sent to the administrator who runs the Complete-MigrationBatch cmdlet.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,19 @@ Accept wildcard characters: False
```

### -CompleteAfter
This parameter is reserved for internal Microsoft use.
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.

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".

In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).

To specify a date/time value for this parameter, use either of the following options:

- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".

- 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).

This parameter should only be used in the cloud-based service.

```yaml
Type: DateTime
Expand Down Expand Up @@ -640,7 +652,11 @@ Accept wildcard characters: False
```

### -ReportInterval
This parameter is reserved for internal Microsoft use.
The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails.

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.

This parameter should only be used in the cloud-based service.

```yaml
Type: TimeSpan
Expand Down Expand Up @@ -697,7 +713,19 @@ Accept wildcard characters: False
```

### -StartAfter
This parameter is reserved for internal Microsoft use.
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.

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".

In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).

To specify a date/time value for this parameter, use either of the following options:

- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".

- 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).

This parameter should only be used in the cloud-based service.

```yaml
Type: DateTime
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ Accept wildcard characters: False
### -Security
This parameter is available only in the cloud-based service.

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.
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.

```yaml
Type: None | Ssl | Tls
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,19 @@ Accept wildcard characters: False
```

### -CompleteAfter
This parameter is reserved for internal Microsoft use.
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.

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".

In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).

To specify a date/time value for this parameter, use either of the following options:

- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".

- 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).

This parameter should only be used in the cloud-based service.

```yaml
Type: DateTime
Expand Down Expand Up @@ -255,7 +267,11 @@ Accept wildcard characters: False
```

### -ReportInterval
This parameter is reserved for internal Microsoft use.
The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails.

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.

This parameter should only be used in the cloud-based service.

```yaml
Type: TimeSpan
Expand Down Expand Up @@ -287,7 +303,19 @@ Accept wildcard characters: False
```

### -StartAfter
This parameter is reserved for internal Microsoft use.
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.

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".

In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).

To specify a date/time value for this parameter, use either of the following options:

- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".

- 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).

This parameter should only be used in the cloud-based service.

```yaml
Type: DateTime
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Accept wildcard characters: False
### -Authentication
This parameter is available only in the cloud-based service.

The Authentication parameter specifies the authentication method used by the on-premises mail server.
The Authentication parameter specifies the authentication method used by the remote mail server.

```yaml
Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured
Expand Down Expand Up @@ -295,7 +295,9 @@ Accept wildcard characters: False
```

### -Security
This parameter is reserved for internal Microsoft use.
This parameter is available only in the cloud-based service.

For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.

```yaml
Type: None | Ssl | Tls
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Start-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Confirm] [-Doma
## DESCRIPTION
The Start-MigrationBatch cmdlet starts a pending migration batch that was created, but not started, with the New-MigrationBatch cmdlet.

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.

In the cloud-based service, the Start-MigrationBatch cmdlet can be run at any time to retry failed users within the batch.

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).

## EXAMPLES
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ Accept wildcard characters: False
### -Security
This parameter is available only in the cloud-based service.

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.
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.

```yaml
Type: None | Ssl | Tls
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1879,7 +1879,7 @@ Accept wildcard characters: False
### -IPListBlocked
This parameter is available only in the cloud-based service.

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

This parameter accepts IPv4 or IPv6 addresses in the following formats:

Expand Down
71 changes: 51 additions & 20 deletions repo_docs/NEW_CMDLETS.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,62 @@
# Generate Your Own Markdown
**SECTION IN PROGRESS**

1. Open PowerShell as Administrator.
2. Import the module you want to document.
- Skype for Business Online: https://technet.microsoft.com/en-us/library/dn362795(v=ocs.15).aspx
- Microsoft Teams: https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/
Hint: Might need to use Upgrade-Module and also Uninstall-Module depending on version and if you already have a version installed.
3. Use PlatyPS to generate Markdown.
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
4. Find the new cmdlet and you will see the stubbed markdown.
5. Add correct metadata, see other similar cmdlets for examples.
6. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet. See others for details.
1. Import the module you want to document.
- Skype for Business Online: https://technet.microsoft.com/en-us/library/dn362795(v=ocs.15).aspx
- Microsoft Teams: https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/

**HINT:** Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed.
1. Use PlatyPS to generate Markdown.
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.

**TIP:** You can see available modules with the command `Get-Module --listavailable`.
1. Find the new cmdlet and you will see the stubbed markdown.
1. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet.
See others for details.
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.
7. Add the cmdlet to TOC. TOC file is the name of the module.
For example, for all Skype cmdlets the TOC file is skype.md.
8. Submit a Pull Request into the repo in appropriate place with adding the new cmdlet. aka.ms/office-powershell

You will need to add the title and also applicable metadata for the cmdlet and also for each parameter.

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

```
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
online version:
applicable: Microsoft StaffHub
title: Get-StaffHubUsersForTenant
schema: 2.0.0
```

**Example metadata for each parameter:** Notice the `Applicable` tag is added with appropriate **whitelisted** product name.

```
Type: String
Parameter Sets: (All)
Aliases:
Applicable: Microsoft StaffHub
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

If you want to merge multiple versions into a single version then use the PlatyPS merge command.

Make sure to update the TOC file. Exact format required so that the template text doesn't show up.
1. Add the cmdlet to Table of Contents (TOC) file. TOC file is the name of the module.
For example, for all Teams cmdlets the TOC file is teams.md.
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 that it will not render as a template text.
1. Submit a Pull Request into the repo in appropriate place with adding the new cmdlet. aka.ms/office-powershell

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.


References:
https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
https://github.com/PowerShell/platyPS
If you want to merge multiple versions into a single version then use the PlatyPS merge command.

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.

## References
* https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
* https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
* https://github.com/PowerShell/platyPS
* https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-module?view=powershell-6
14 changes: 6 additions & 8 deletions skype/skype-ps/skype/Get-CsTenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@ Accept wildcard characters: False
Enables you to return data by using Active Directory attributes and without having to specify the full Active Directory distinguished name.
For example, to retrieve a tenant by using the tenant display name, use syntax similar to this:

`Get-CsTenant -Filter {DisplayName -eq "FabrikamTenant"}`
Get-CsTenant -Filter {DisplayName -eq "FabrikamTenant"}

To return all tenants that use a Fabrikam domain use this syntax:

`Get-CsTenant -Filter {Domains -like "*fabrikam*"}`
Get-CsTenant -Filter {Domains -like "*fabrikam*"}

The Filter parameter uses the same Windows PowerShell filtering syntax is used by the Where-Object cmdlet.
The Filter parameter uses the same Windows PowerShell filtering syntax is used by the `Where-Object` cmdlet.

You cannot use both the Identity parameter and the Filter parameter in the same command.

Expand All @@ -82,9 +82,9 @@ Accept wildcard characters: False
Unique identifier for the tenant.
For example:

`-Identity "bf19b7db-6960-41e5-a139-2aa373474354"`
-Identity "bf19b7db-6960-41e5-a139-2aa373474354"

If you do not include either the Identity or the Filter parameter then the Get-CsTenant cmdlet will return information about all your tenants.
If you do not include either the Identity or the Filter parameter then the `Get-CsTenant` cmdlet will return information about all your tenants.

```yaml
Type: Object
Expand Down Expand Up @@ -144,14 +144,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

### Microsoft.Rtc.Management.ADConnect.Schema.TenantObject or String
The Get-CsTenant cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.TenantObject object as well as string values representing the Identity of the tenant (for example "bf19b7db-6960-41e5-a139-2aa373474354").

The `Get-CsTenant` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.TenantObject object as well as string values representing the Identity of the tenant (for example "bf19b7db-6960-41e5-a139-2aa373474354").

## OUTPUTS

### Microsoft.Rtc.Management.ADConnect.Schema.TenantObject


## NOTES

## RELATED LINKS
Expand Down
Loading