Remove-SCSPFTenant
Removes one or more tenant objects.
Syntax
Default (Default)
Remove-SCSPFTenant
-Tenant <Tenant[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Remove-SCSPFTenant cmdlet removes one or more tenant objects from the Service Provider Foundation database.
Examples
Example 1: Remove a tenant object
PS C:\>$Tenant = Get-SCSPFTenant -Name "Contoso"
PS C:\> Remove-SCSPFTenant -Tenant $Tenant
The first command gets the tenant object named Contoso and stores the object in the $Tenant variable.
The second command removes the tenant.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Specifies the name of one or more tenant objects. To obtain a tenant, use the Get-SCSPFTenant cmdlet.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.