Share via

New-SCSPFTenant

Module:
spfadmin Module

Creates a new tenant for a hoster.

Syntax

Empty (Default) 

New-SCSPFTenant
    -Name <String>
    [-Stamps <Stamp[]>]
    [-SubscriptionId <Guid>]
    [-AccountStatus <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

FromTenantIssuereParameterSetName 

New-SCSPFTenant
    -Name <String>
    -Key <String>
    -IssuerName <String>
    [-Stamps <Stamp[]>]
    [-SubscriptionId <Guid>]
    [-AccountStatus <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

FromTenantCertParameterSetName 

New-SCSPFTenant
    -Name <String>
    -Certificate <String>
    -IssuerName <String>
    [-Stamps <Stamp[]>]
    [-SubscriptionId <Guid>]
    [-AccountStatus <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-SCSPFTenant cmdlet creates a new tenant in Service Provider Foundation. If you are a service provider, the tenants are your paying customers. If you are using Service Provider Foundation in a private cloud, the tenants are the business units in your organization.

Examples

Example 1: Create a new tenant

PS C:\>$Path = "C:\Temp\ADatum29D.cer"
PS C:\> $Certificate = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($Path)
PS C:\> $Key = [Convert]::ToBase64String($Certificate.RawData)
PS C:\> $SubscriptionId = [System.Guid]::NewGuid().ToString()
PS C:\> New-SCSPFTenant -IssuerName "Contoso" -Key $Key -Name "ADatum" -SubscriptionID $SubscriptionId

The first two commands create the $Certificate variable to contain the issued certificate for the tenant.

The third command creates the $Key variable to contain the public key for the certificate.

The fourth command creates the $SubscriptionId variable to contain the GUID for the subscription.

The fifth command creates the tenant with the name of the trusted issuer of the certificate, the public key, a specified name, and the GUID associated with the subscription.

Parameters

-AccountStatus

Specifies the status of a tenant. Specify 0 for Active, or 1 for 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

-Certificate

Specifies the path to the certificate file for the tenant.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

FromTenantCertParameterSetName
Position:Named
Mandatory:True
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 a trusted issuer object.

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
FromTenantCertParameterSetName
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

-Name

Specifies the name to give to the tenant.

Parameter properties

Type:System.String
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

-Stamps

Specifies the name of one or more stamp objects to associate with the new tenant. To obtain a stamp, use the Get-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

-SubscriptionId

Specifies the GUID for a subscription of a tenant. This value cannot be changed after the tenant is created.

Parameter properties

Type:System.Guid
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

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

Inputs

None

Outputs

System.Object