Set-SCSPFTenant

Set-SCSPFTenant

Sets resources and data for a tenant.

Syntax

Parameter Set: Empty
Set-SCSPFTenant -Tenant <Tenant> [-AccountStatus <String> ] [-Stamps <Stamp[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

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




Detailed 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.

Parameters

-AccountStatus<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IssuerName<String>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Key<String>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Stamps<Stamp[]>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Tenant<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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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

Example 1: Set the account status of a tenant

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


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

Example 2: Associate a tenant with a collection of stamps

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

The third command associates the tenant with the 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

Related topics

Community Additions

ADD
Show: