Share via

Remove-SCSPFTenant

  • Reference
Module:
spfadmin

Removes one or more tenant objects.

Syntax

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.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tenant

Specifies the name of one or more tenant objects. To obtain a tenant, use the Get-SCSPFTenant cmdlet.

Type:Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant[]

Outputs

System.Object