Add-AdfsDeviceRegistrationUpnSuffix
Add-AdfsDeviceRegistrationUpnSuffix
Adds a custom UPN suffix.
Syntax
Parameter Set: Default
Add-AdfsDeviceRegistrationUpnSuffix [-UpnSuffix] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-AdfsDeviceRegistrationUpnSuffix cmdlet adds a custom user principal name (UPN) suffix that you can use when you register a device with Active Directory Federation Services (AD FS).
In many environments, additional UPN suffixes for users are added after an Active Directory Federation Services (AD FS) deployment is complete. Run this cmdlet to support device registration for users of the new UPN suffix. The cmdlet configures a Secure Sockets Layer (SSL) binding that corresponds to the UPN suffix. The UPN suffix must have a corresponding registration name in the AD FS SSL certificate, for example enterpriseregistration.upn suffix. You can use a wild-card SSL certificate that covers all possible registration names.
Parameters
-UpnSuffix<String>
Specifies a UPN suffix. The cmdlet adds and configures the UPN suffix that you specify as a valid registration UPN suffix.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
- string
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Add a UPN suffix for registering a device
This command adds the UPN suffix Northamerica.Contoso.com to the list of suffixes that AD FS responds to for device registration requests after the initial deployment of the device registration service.
PS C:\> Add-AdfsDeviceRegistrationUpnSuffix -UpnSuffix "Northamerica.Contoso.com"
Related topics
Get-AdfsDeviceRegistrationUpnSuffix