Share via

Set-SCSPFTenant

  • Reference
Module:
spfadmin

Sets resources and data for a tenant.

Syntax

Set-SCSPFTenant
   -Tenant <Tenant>
   [-Stamps <Stamp[]>]
   [-AccountStatus <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SCSPFTenant
   -Tenant <Tenant>
   -Key <String>
   -IssuerName <String>
   [-Stamps <Stamp[]>]
   [-AccountStatus <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-SCSPFTenant cmdlet associates a tenant in Service Provider Foundation with an offer, stamps, or values for claims-based authentication.

If you want to add an association of a stamp to a tenant without changing the stamps currently associated with the tenant, use the Set-SCSPFStamp cmdlet.

Examples

Example 1: Set the account status of a tenant

PS C:\>Set-SCSPFTenant -Tenant (Get-SCSPFTenant -Name "ADatum") -AccountStatus "1"

This command sets the account status of a tenant to 1 for suspended.

Example 2: Associate a tenant with a collection of stamps

PS C:\>$Tenant = Get-SCSPFTenant -Name "Contoso"
PS C:\> $Stamps = Get-SCSPFServer | Where-Object {>> $_.Name -contains "silver">> }
PS C:\> Set-SCSPFTenant -Tenant $Tenant -Stamps $Stamps

The first command gets a tenant. The second command gets a collection of stamps.

The third command associates the tenant with the stamps.

Parameters

-AccountStatus

Specifies the status of a tenant. Specify 0 to set the status to active or specify 1 to set the status to suspended.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-IssuerName

Specifies the name of the party that issued the certificate for the tenant. This parameter is metadata to verify a token submitted by the tenant; do not confuse this parameter with an object from a trusted issuer.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Key

Specifies the public key that validates a signed token submitted by a tenant in claims-based authentication.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Stamps

Specifies one or more stamps to associate with the tenant. To obtain a stamp, use the New-SCSPFStamp cmdlet.

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

-Tenant

Specifies the tenant object to set to new values by the other parameters in this cmdlet. 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:False
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

None

Outputs

System.Object