Syntax
Remove-Org [-Org] <Org[]> [-Force] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet removes the specified organization. The organization must be disabled and must not contain any child objects. To automatically disable the organization before removal, set the Force parameter. Note: This cmdlet is only availabe to Provider Administrators.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Org | Org[] | Specifies the organization that you want to remove. | true | true (ByValue) | |
| Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | false | |
| Force | SwitchParameter | Indicates that the organization will be removed even if it is enabled. Setting the Force parameter will automatically disable the organization if it is enabled. | false | false | |
| InformationAction | ActionPreference | false | false | ||
| InformationVariable | String | false | false | ||
| PipelineVariable | String | false | false | ||
| Server | CIServer[] | Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. | false | false | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
NoneNotes
Examples
-------------- Example 1 --------------
Get-Org "MyOrg" | Remove-Org
Removes the MyOrg organization.
-------------- Example 2 --------------
Get-Org "MyEnabledOrg" | Remove-Org -Force
Removes an enabled organization by automatically disabling it before deletion.
-------------- Example 3 --------------
Remove-Org -Org "MyOrg*"
Removes all disabled organizations that have names starting with "MyOrg".