AdfsServerApplication

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	Specifies the name for the server application.
Identifier	Required	String	Specifies the identifier for the server application.
ApplicationGroupIdentifier	Required	String	Specifies the ID of an application group.
RedirectUri	Write	StringArray[]	Specifies an array of redirection URIs for the OAuth 2.0 client to register with AD FS. The redirection URI is specified by the OAuth 2.0 client when it requests authorization to access a resource in ADFS.
Description	Write	String	Specifies a description for the server application.
ADUserPrincipalName	Write	String	Specifies the Active Directory account that corresponds to the Server Application.
LogoutUri	Write	String	Specifies the logout URI for the OAuth 2.0 client to register with the AD FS. When AD FS initiates a logout it redirects the client's user-agent to this URI by rendering this URI in an iframe. The value of this parameter must be an absolute URI, may include a query component, and must not include a fragment component.
Ensure	Write	String	Specifies whether the ADFS server application should be present or absent. Default value is 'Present'.	Present, Absent

Description

The AdfsServerApplication DSC resource manages Server Applications within Active Directory Federation Services. Server Applications are a construct that represents a confidential application that runs on a server and needs to authenticate a user with ADFS.

Requirements

• Target machine must be running ADFS on Windows Server 2016 or above to use this resource.

Examples

Example 1

This configuration will add a server application to an application in Active Directory Federation Services (AD FS).

Configuration AdfsServerApplication_Config
{
    Import-DscResource -ModuleName AdfsDsc

    Node localhost
    {
        AdfsServerApplication ServerApp1
        {
            Name                       = 'ServerApp1'
            ApplicationGroupIdentifier = 'AppGroup1'
            Identifier                 = '6de768af-c656-424d-b79c-5024944c3b67'
            RedirectUri                = 'https://serverapp1.contoso.com'
            Description                = 'App1 Server App'
            ADUserPrincipalName        = 'CONTOSO\Svc.App1'
            LogoutUri                  = 'https://serverapp1.contoso.com/logout'
        }
    }
}