Add-AdfsDeviceRegistrationUpnSuffix
Adds a custom UPN suffix.
Syntax
Default (Default)
Add-AdfsDeviceRegistrationUpnSuffix
[-UpnSuffix] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Examples
Example 1: Add a UPN suffix for registering a device
PS C:\> Add-AdfsDeviceRegistrationUpnSuffix -UpnSuffix "Northamerica.Contoso.com"
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.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| 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 |
-UpnSuffix
Specifies a UPN suffix. The cmdlet adds and configures the UPN suffix that you specify as a valid registration UPN suffix.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| 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: | SwitchParameter |
| Default value: | False |
| 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
String
String objects are received by the UpnSuffix parameter.