AdfsClaimDescription

AdfsClaimDescription

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	Specifies a friendly name for the claim description.
ClaimType	Required	String	Specifies the claim type URN or URI of the claim.
IsAccepted	Write	Boolean	Indicates whether the claim is published in federation metadata as a claim that the Federation Service accepts.
IsOffered	Write	Boolean	Indicates whether the claim is published in federation metadata as a claim that the Federation Service offers.
IsRequired	Write	Boolean	Indicates whether the claim is published in federation metadata as a claim that the Federation Service requires.
Notes	Write	String	Specifies text that describes the purpose of the claim description.
ShortName	Write	String	Specifies a short name for the claim description.
Ensure	Write	String	Specifies whether the claim description should be present or absent. Default value is 'Present'.	Present, Absent

Description

The AdfsClaimDescription Dsc resource manages claim descriptions in the Federation Service.

Examples

Example 1

This configuration will add the claim description named Role for a custom claim that has the specified claim type.

Configuration AdfsClaimDescription_Config
{
    Import-DscResource -ModuleName AdfsDsc

    Node localhost
    {
        AdfsClaimDescription ClaimDescription
        {
            Name       = 'Role'
            ClaimType  = "https://contoso.com/role"
            IsAccepted = $true
            IsOffered  = $true
            IsRequired = $false
            Notes      = 'The role of the Contoso user'
            ShortName  = 'contosorole'
        }
    }
}