AADAuthenticationMethodPolicyEmail

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
AllowExternalIdToUseEmailOtp	Write	String	Determines whether email OTP is usable by external users for authentication. Possible values are: default, enabled, disabled, unknownFutureValue. Tenants in the default state who did not use public preview will automatically have email OTP enabled beginning in October 2021.	default, enabled, disabled, unknownFutureValue
ExcludeTargets	Write	MSFT_AADAuthenticationMethodPolicyEmailExcludeTarget[]	Displayname of the groups of users that are excluded from a policy.
IncludeTargets	Write	MSFT_AADAuthenticationMethodPolicyEmailIncludeTarget[]	Displayname of the groups of users that are included from a policy.
State	Write	String	The state of the policy. Possible values are: enabled, disabled.	enabled, disabled
Id	Key	String	The unique identifier for an entity. Read-only.
Ensure	Write	String	Present ensures the policy exists, absent ensures it is removed.	Present, Absent
Credential	Write	PSCredential	Credentials of the Admin
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
TenantId	Write	String	Id of the Azure Active Directory tenant used for authentication.
ApplicationSecret	Write	PSCredential	Secret of the Azure Active Directory tenant used for authentication.
CertificateThumbprint	Write	String	Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	StringArray[]	Access token used for authentication.

MSFT_AADAuthenticationMethodPolicyEmailExcludeTarget

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Id	Write	String	The object identifier of an Azure AD group.
TargetType	Write	String	The type of the authentication method target. Possible values are: group and unknownFutureValue.	user, group, unknownFutureValue

MSFT_AADAuthenticationMethodPolicyEmailIncludeTarget

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Id	Write	String	The object identifier of an Azure AD group.
TargetType	Write	String	The type of the authentication method target. Possible values are: group and unknownFutureValue.	user, group, unknownFutureValue

Description

Azure AD Authentication Method Policy Email

Permissions

Microsoft Graph

To authenticate with the Microsoft Graph API, this resource required the following permissions:

Delegated permissions

• Read

  • Policy.ReadWrite.AuthenticationMethod, Policy.Read.All

• Update

  • Policy.ReadWrite.AuthenticationMethod, Policy.Read.All

Application permissions

• Read

  • Policy.ReadWrite.AuthenticationMethod, Policy.Read.All

• Update

  • Policy.ReadWrite.AuthenticationMethod, Policy.Read.All

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param(
        [Parameter()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )
    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        AADAuthenticationMethodPolicyEmail "AADAuthenticationMethodPolicyEmail-Email"
        {
            AllowExternalIdToUseEmailOtp = "enabled";
            ApplicationId         = $ApplicationId
            TenantId              = $TenantId
            CertificateThumbprint = $CertificateThumbprint
            Ensure                       = "Present";
            ExcludeTargets               = @(
                MSFT_AADAuthenticationMethodPolicyEmailExcludeTarget{
                    Id = 'Paralegals'
                    TargetType = 'group'
                }
            );
            Id                           = "Email";
            IncludeTargets               = @(
                MSFT_AADAuthenticationMethodPolicyEmailIncludeTarget{
                    Id = 'Finance Team'
                    TargetType = 'group'
                }
                MSFT_AADAuthenticationMethodPolicyEmailIncludeTarget{
                    Id = 'Legal Team'
                    TargetType = 'group'
                }
            );
            State                        = "enabled"; # Updated Property
        }
    }
}