Changed key from id to upn

microsoft · Oct 4, 2024 · 62dcb23 · 62dcb23
1 parent 854869d
commit 62dcb23
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 22 deletions.
diff --git a/...DSC/DSCResources/MSFT_AADAuthenticationRequirement/MSFT_AADAuthenticationRequirement.psm1 b/...DSC/DSCResources/MSFT_AADAuthenticationRequirement/MSFT_AADAuthenticationRequirement.psm1
@@ -11,7 +11,7 @@ function Get-TargetResource
 
         [Parameter(Mandatory = $true)]
         [System.String]
-        $Id,
+        $UserPrincipalName,
 
         [Parameter()]
         [System.Management.Automation.PSCredential]
@@ -62,20 +62,20 @@ function Get-TargetResource
         $nullResult = $PSBoundParameters
 
         $getValue = $null
-        $url = $Global:MSCloudLoginConnectionProfile.MicrosoftGraph.ResourceUrl + "beta/users/$Id/authentication/requirements"
+        $url = $Global:MSCloudLoginConnectionProfile.MicrosoftGraph.ResourceUrl + "beta/users/$UserPrincipalName/authentication/requirements"
         $getValue = Invoke-MgGraphRequest -Method Get -Uri $url
 
         if ($null -eq $getValue)
         {
-            Write-Verbose -Message "Could not find an Azure AD Authentication Requirement for user with id {$Id}"
+            Write-Verbose -Message "Could not find an Azure AD Authentication Requirement for user with UPN {$UserPrincipalName}"
             return $nullResult
         }
 
-        Write-Verbose -Message "An Azure AD Authentication Method Policy Requirement for a user with Id {$Id} was found."
+        Write-Verbose -Message "An Azure AD Authentication Method Policy Requirement for a user with UPN {$UserPrincipalName} was found."
 
         $results = @{
             PerUserMfaState       = $getValue.perUserMfaState
-            Id                    = $Id
+            UserPrincipalName     = $UserPrincipalName
             Credential            = $Credential
             ApplicationId         = $ApplicationId
             TenantId              = $TenantId
@@ -111,7 +111,7 @@ function Set-TargetResource
 
         [Parameter(Mandatory = $true)]
         [System.String]
-        $Id,
+        $UserPrincipalName,
 
         [Parameter()]
         [System.Management.Automation.PSCredential]
@@ -155,13 +155,14 @@ function Set-TargetResource
     #endregion
 
     $currentInstance = Get-TargetResource @PSBoundParameters
-    $url = $Global:MSCloudLoginConnectionProfile.MicrosoftGraph.ResourceUrl + "beta/users/$Id/authentication/requirements"
+    $url = $Global:MSCloudLoginConnectionProfile.MicrosoftGraph.ResourceUrl + "beta/users/$UserPrincipalName/authentication/requirements"
 
     $params = @{}
     if ($PerUserMfaState -eq 'enabled' -and $currentInstance.PerUserMfaState -eq 'disabled')
     {
         $params = @{
             "perUserMfaState" = "enabled"
+        }
     }
     elseif ($PerUserMfaState -eq 'disabled' -and $currentInstance.PerUserMfaState -eq 'enabled')
     {
@@ -188,7 +189,7 @@ function Test-TargetResource
 
         [Parameter(Mandatory = $true)]
         [System.String]
-        $Id,
+        $UserPrincipalName,
 
         [Parameter()]
         [System.Management.Automation.PSCredential]
@@ -231,7 +232,7 @@ function Test-TargetResource
     Add-M365DSCTelemetryEvent -Data $data
     #endregion
 
-    Write-Verbose -Message "Testing configuration of the Azure AD Authentication Requirement for a user with Id {$Id}"
+    Write-Verbose -Message "Testing configuration of the Azure AD Authentication Requirement for a user with UPN {$UserPrincipalName}"
 
     $CurrentValues = Get-TargetResource @PSBoundParameters
     $ValuesToCheck = ([Hashtable]$PSBoundParameters).clone()
@@ -336,7 +337,7 @@ function Export-TargetResource
 
             Write-Host "    |---[$i/$($getValue.Count)] $displayedKey" -NoNewline
             $params = @{
-                Id                    = $config.Id
+                UserPrincipalName     = $config.UserPrincipalName
                 Credential            = $Credential
                 ApplicationId         = $ApplicationId
                 TenantId              = $TenantId

diff --git a/...CResources/MSFT_AADAuthenticationRequirement/MSFT_AADAuthenticationRequirement.schema.mof b/...CResources/MSFT_AADAuthenticationRequirement/MSFT_AADAuthenticationRequirement.schema.mof
@@ -2,7 +2,7 @@
 class MSFT_AADAuthenticationRequirement : OMI_BaseResource
 {
     [Write, Description("The state of the MFA enablement for the user. Possible values are: enabled, disabled."), ValueMap{"enabled","disabled"}, Values{"enabled","disabled"}] String PerUserMfaState;
-    [Key, Description("The unique identifier for an entity. Read-only.")] String Id;
+    [Key, Description("The unique identifier for an entity. Read-only.")] String UserPrincipalName;
 
     [Write, Description("Credentials of the Admin"), EmbeddedInstance("MSFT_Credential")] string Credential;
     [Write, Description("Id of the Azure Active Directory application to authenticate with.")] String ApplicationId;

diff --git a/Modules/Microsoft365DSC/Examples/Resources/AADAuthenticationRequirement/2-Update.ps1 b/Modules/Microsoft365DSC/Examples/Resources/AADAuthenticationRequirement/2-Update.ps1
@@ -22,13 +22,13 @@ Configuration Example
 
     Node localhost
     {
-        AADAuthenticationRequirement "AADAuthenticationRequirement-98ceffcc-7c54-4227-8844-835af5a023ce"
+        AADAuthenticationRequirement "AADAuthenticationRequirement-[email protected]"
         {
             ApplicationId         = $ApplicationId
             TenantId              = $TenantId
             CertificateThumbprint = $CertificateThumbprint
-            Id                   = "98ceffcc-7c54-4227-8844-835af5a023ce"
-            PerUserMfaState      = "disabled"
+            PerUserMfaState       = "disabled";
+            UserPrincipalName     = "TestMailbox109@$OrganizationName";
         }
     }
 }
diff --git a/Modules/Microsoft365DSC/Modules/M365DSCUtil.psm1 b/Modules/Microsoft365DSC/Modules/M365DSCUtil.psm1
@@ -3825,6 +3825,10 @@ function Get-M365DSCExportContentForResource
     {
         $primaryKey = $Results.DomainName
     }
+    elseif ($Keys.Contains('UserPrincipalName'))
+    {
+        $primaryKey = $Results.UserPrincipalName
+    }
 
     if ([String]::IsNullOrEmpty($primaryKey) -and `
         -not $Keys.Contains('IsSingleInstance'))

diff --git a/Tests/Unit/Microsoft365DSC/Microsoft365DSC.AADAuthenticationRequirement.Tests.ps1 b/Tests/Unit/Microsoft365DSC/Microsoft365DSC.AADAuthenticationRequirement.Tests.ps1
@@ -45,14 +45,14 @@ Describe -Name $Global:DscHelper.DescribeHeader -Fixture {
         Context -Name "The instance exists and values are already in the desired state" -Fixture {
             BeforeAll {
                 $testParams = @{
-                    Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                    UserPrincipalName   = "[email protected]"
                     PerUserMfaState     = 'Enabled'
                     Credential          = $Credential;
                 }
 
                 Mock -CommandName Invoke-MgGraphRequest -MockWith {
                     return @{
-                        Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                        UserPrincipalName   = "[email protected]"
                         PerUserMfaState     = 'Enabled'
                         Credential          = $Credential;
                     }
@@ -67,14 +67,14 @@ Describe -Name $Global:DscHelper.DescribeHeader -Fixture {
         Context -Name "The instance exists and values are NOT in the desired state - Enable" -Fixture {
             BeforeAll {
                 $testParams = @{
-                    Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                    UserPrincipalName   = "[email protected]"
                     PerUserMfaState     = 'Enabled'
                     Credential          = $Credential;
                 }
 
                 Mock -CommandName Invoke-MgGraphRequest -MockWith {
                     return @{
-                        Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                        UserPrincipalName   = "[email protected]"
                         PerUserMfaState     = 'Disabled'
                         Credential          = $Credential;
                     }
@@ -98,14 +98,14 @@ Describe -Name $Global:DscHelper.DescribeHeader -Fixture {
         Context -Name "The instance exists and values are NOT in the desired state - Disable" -Fixture {
             BeforeAll {
                 $testParams = @{
-                    Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                    UserPrincipalName   = "[email protected]"
                     PerUserMfaState     = 'Disabled'
                     Credential          = $Credential;
                 }
 
                 Mock -CommandName Invoke-MgGraphRequest -MockWith {
                     return @{
-                        Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                        UserPrincipalName   = "[email protected]"
                         PerUserMfaState     = 'Enabled'
                         Credential          = $Credential;
                     }
@@ -136,15 +136,15 @@ Describe -Name $Global:DscHelper.DescribeHeader -Fixture {
 
                 Mock -CommandName Invoke-MgGraphRequest -MockWith {
                     return @{
-                        Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                        UserPrincipalName   = "[email protected]"
                         PerUserMfaState     = 'Enabled'
                         Credential          = $Credential;
                     }
                 }
 
                 Mock -CommandName Get-MgUser -MockWith {
                     return @{
-                        Id                  = "98ceffcc-7c54-4227-8844-835af5a023ce"
+                        UserPrincipalName   = "[email protected]"
                         Credential          = $Credential;
                     }
                 }