Set-SCSPFTenant
Sets resources and data for a tenant.
Syntax
Empty (Default)
Set-SCSPFTenant
-Tenant <Tenant>
[-Stamps <Stamp[]>]
[-AccountStatus <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FromTenantIssuereParameterSetName
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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromTenantIssuereParameterSetName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Key
Specifies the public key that validates a signed token submitted by a tenant in claims-based authentication.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
FromTenantIssuereParameterSetName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Stamps
Specifies one or more stamps to associate with the tenant. To obtain a stamp, use the New-SCSPFStamp cmdlet.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.Stamp[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Microsoft.SystemCenter.Foundation.SPFData.Types.Tenant |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.