Remove-CrmOrganization
Deletes the specified organization from the Dynamics 365 deployment.
Syntax
Remove-CrmOrganization
[-Name] <String>
[-DetachDatabase]
[-Timeout <Int32>]
[-Diag]
[-Credential <PSCredential>]
[-DwsServerUrl <String>]
[-WhatIf]
[-Confirm]
Description
The Remove-CrmOrganization cmdlet deletes the specified organization from the Dynamics 365 deployment. The administrator must provide the unique name of the organization to delete. The organization must be disabled before it can be deleted.
Examples
Example 1
PS C:\> Disable-CrmOrganization -Name Contoso
PS C:\> Remove-CrmOrganization -Name Contoso
First disables the specified organization, then deletes it.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DetachDatabase
If specified, this detaches the database from the Microsoft SQL Server, however it doesn’t delete the physical database on the server.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Diag
Turns on stack traces for error reports returned from Dynamics 365 service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DwsServerUrl
The URL of the Deployment Web Service. This should be in the format: https://, for example, https://contoso.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the unique name of the organization to delete.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Timeout
For internal use only.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
System.String
System.Int32 System.Management.Automation.SwitchParameter System.Management.Automation.PSCredential
Outputs
System.Object