Set-SCSPFTenant
Set-SCSPFTenant
Sets resources and data for a tenant.
Syntax
Parameter Set: Empty
Set-SCSPFTenant -Tenant <Tenant> [-AccountStatus <String> ] [-Offer <Offer> ] [-Stamps <Stamp[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: FromTenantIssuereParameterSetName
Set-SCSPFTenant -IssuerName <String> -Key <String> -Tenant <Tenant> [-AccountStatus <String> ] [-Offer <Offer> ] [-Stamps <Stamp[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-SCSPFTenant cmdlet associates a tenant in Service Provider Foundation with various data, including an offer, stamps, and 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>
Sets the status of a tenant. Specify 0 for Active, 1 for 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 not to be confused with a trusted issuer object, as it is metadata to verify a token submitted by the tenant.
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 |
-Offer<Offer>
Specifies an offer to associate with the tenant. To obtain an offer, use the Get-SCSPFOffer cmdlet.
Aliases |
none |
Required? |
false |
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 be 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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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: Set a tenant's account status.
This command sets the account status for a tenant to 1 (Suspended).
PS C:\> Set-SCSPFTenant -Tenant (Get-SCSPFTenant -Name "ADatum") –AccountStatus 1
2: Set a tenant to collection of stamps.
The first two commands get a tenant and a collection of stamps.
The third command associates the tenant with the stamps.
PS C:\> $tnnt = Get-SCSPFTenant -Name "Northwind"
PS C:\> $stmps = Get-SCSPFServer | Where-Object {
>> $_.Name –contains "silver">> }
PS C:\> Set-SCSPFTenant -Tenant $tnnt -Stamps $stmps