Remove-SCSPFTenant

Applies To: System Center 2012 R2 Orchestrator

Remove-SCSPFTenant

Removes one or more tenant objects.

Syntax

Parameter Set: Default
Remove-SCSPFTenant -Tenant <Tenant[]> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-SCSPFTenant cmdlet removes one or more tenants from the Service Provider Foundation database.

Parameters

-Tenant<Tenant[]>

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

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before executing the command.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

1: Remove a tenant.

The first command gets the tenant object named Fabrikam and stores the object in the $tnnt variable.

The second command removes the tenant.

PS C:\> $tnnt = Get-SCSPFTenant -Name "Fabrikam"

PS C:\> Remove-SCSPFTenant –Tenant $tnnt

New-SCSPFTenant

Set-SCSPFTenant

Get-SCSPFTenant