Start-MailboxAssistant

Author: chrisda

exchange/exchange-ps/exchange/Start-MailboxAssistant.md

@@ -0,0 +1,170 @@
+---
+external help file: Microsoft.Exchange.RolesAndAccess-Help.xml
+online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxassistant
+applicable: Exchange Server 2019
+title: Start-MailboxAssistant
+schema: 2.0.0
+author: chrisda
+ms.author: chrisda
+ms.reviewer:
+---
+# Start-MailboxAssistant
+
+## SYNOPSIS
+This cmdlet is available only in on-premises Exchange 2019.
+
+Use the Start-MailboxAssistant cmdlet to ???.
+
+For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
+
+## SYNTAX
+
+```
+Start-MailboxAssistant [-Identity] <UserIdParameter> -AssistantName <String>
+ [-Confirm]
+ [-DomainController <Fqdn>]
+ [-Parameters <String>]
+ [-SoftDeletedMailbox]
+ [-WhatIf]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
+
+## EXAMPLES
+
+### Example 1
+```powershell
+{{ Add example code here }}
+```
+
+{{ Add example description here }}
+
+## PARAMETERS
+
+### -Identity
+{{ Fill Identity Description }}
+
+```yaml
+Type: UserIdParameter
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Server 2019
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -AssistantName
+{{ Fill AssistantName Description }}
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Server 2019
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
+
+- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
+- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+Applicable: Exchange Server 2019
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DomainController
+The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
+
+```yaml
+Type: Fqdn
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Server 2019
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Parameters
+{{ Fill Parameters Description }}
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Server 2019
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SoftDeletedMailbox
+{{ Fill SoftDeletedMailbox Description }}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Server 2019
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+Applicable: Exchange Server 2019
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS

exchange/exchange-ps/exchange/exchange.md

@@ -1068,6 +1068,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
 
 ### [Set-SearchDocumentFormat](Set-SearchDocumentFormat.md)
 
+### [Start-MailboxAssistant](Start-MailboxAssistant.md)
+
 ### [Test-AssistantHealth](Test-AssistantHealth.md)
 
 ### [Test-ExchangeSearch](Test-ExchangeSearch.md)

exchange/mapping/serviceMapping.json

@@ -519,6 +519,7 @@
   "Set-MailboxDatabase": "mailbox-databases-and-servers",
   "Set-MailboxServer": "mailbox-databases-and-servers",
   "Set-SearchDocumentFormat": "mailbox-databases-and-servers",
+  "Start-MailboxAssistant": "mailbox-databases-and-servers",
   "Test-AssistantHealth": "mailbox-databases-and-servers",
   "Test-ExchangeSearch": "mailbox-databases-and-servers",
   "Test-MRSHealth": "mailbox-databases-and-servers",