.png)
Remove-ProvisioningRequest
Applies to: Exchange Online
Topic Last Modified: 2013-01-11
This cmdlet is available only in the cloud-based service.
Use the Remove-ProvisioningRequest cmdlet to stop processing a bulk provisioning request that's either pending or running.
For information about the parameter sets in the Syntax section below, see Syntax.
Remove-ProvisioningRequest [-Identity <ProvisioningRequestIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-WhatIf [<SwitchParameter>]]
This example cancels the provisioning request currently being processed by the bulk provisioning service.
Remove-ProvisioningRequest
The Remove-ProvisioningRequest cmdlet cancels a pending provisioning request or stops a provisioning request that's being processed by the bulk provisioning service running on Exchange. Canceling a provisioning request that's running won't affect the new user accounts that have been created already. Processing of any user account that's actively being created is completed before the provisioning process is stopped.
After a provisioning request is stopped, a status email message is sent to the recipients that were specified in the NotificationEmails parameter on the Start-ProvisioningRequest cmdlet. The message contains information about the number of rows in the CSV file that were processed and the number of new user accounts created before provisioning was stopped.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Recipients Permissions topic.
| Parameter | Required | Type | Description |
|---|---|---|---|
| Confirm | Optional | System.Management.Automation.SwitchParameter | The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
| DomainController | Optional | Microsoft.Exchange.Data.Fqdn | This parameter is reserved for internal Microsoft use. |
| Identity | Optional | Microsoft.Exchange.Management.ProvisioningTasks.ProvisioningRequestIdParameter | The Identity parameter specifies the ID of the active provisioning request. The value for this parameter is assigned by the bulk provisioning service. Use the Get-ProvisioningRequest cmdlet to determine the value of this parameter. |
| Organization | Optional | Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter | The Organization parameter is reserved for internal Microsoft use. |
| WhatIf | Optional | System.Management.Automation.SwitchParameter | The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.
