New-SCSPFTenant
New-SCSPFTenant
Creates a new tenant for a hoster.
Syntax
Parameter Set: Empty
New-SCSPFTenant -Name <String> [-AccountStatus <String> ] [-Offer <Offer> ] [-Stamps <Stamp[]> ] [-SubscriptionId <Guid> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: FromTenantCertParameterSetName
New-SCSPFTenant -Certificate <String> -IssuerName <String> -Name <String> [-AccountStatus <String> ] [-Offer <Offer> ] [-Stamps <Stamp[]> ] [-SubscriptionId <Guid> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: FromTenantIssuereParameterSetName
New-SCSPFTenant -IssuerName <String> -Key <String> -Name <String> [-AccountStatus <String> ] [-Offer <Offer> ] [-Stamps <Stamp[]> ] [-SubscriptionId <Guid> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The New-SCSPFTenant cmdlet creates a new tenant in Service Provider Foundation. If you are a service provider, these are your paying customers. If you are using Service Provider Foundation in private cloud, these are the business units of your organization.
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 |
-Certificate<String>
Specifies the path to the certificate file for the tenant.
Aliases |
none |
Required? |
true |
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 |
-Name<String>
Specifies the name to give to the tenant.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Offer<Offer>
Specifies the name of one or more offer objects to associate with the new 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 the name of one or more stamp objects to associate with the new tenant. To obtain a stamp, use the Get-SCSPFStamp cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SubscriptionId<Guid>
Specifies the subscription identifier (as a GUID) for a tenant. This value cannot be changed after the tenant is created.
Aliases |
none |
Required? |
false |
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: Onboard a tenant.
The first two commands create the $cert variable that contains the tenant's issued certificate.
The third command creates the $key variable that contains the certificate's public key.
The fourth command creates the $subID variable that contains a GUID for the subscription ID.
The fifth command creates the tenant with the name of the trusted issuer of the certificate, the public key, a specified name, and the subscription ID.
PS C:\> $path = "C:\Temp\ADatum29D.cer"
PS C:\> $cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($path)
PS C:\> $key = [Convert]::ToBase64String($cert.RawData)
PS C:\> $subID = [System.Guid]::NewGuid().ToString()
PS C:\> New-SCSPFTenant -IssuerName "Woodgrove" -Key $key -Name "ADatum" –SubscriptionID $subID