PowerDataOps

1.0.0.109

src/Connection/Connect-XrmUser.ps1

<#
    .SYNOPSIS
    Authenticate user to Microsoft Dataverse.
 
    .DESCRIPTION
    Prepare Microsoft Dataverse connection with user credentials in order to consume Discovery Service.
 
    .PARAMETER UserName
    User login.
     
    .PARAMETER Password
    User password.
 
    .PARAMETER AuthType
    User authrentication type. (Office365, AD, Ifd)
    => Warning : Office365 authentication is deprecated!
     
    .PARAMETER Region
    DataCenter region (France, EMEA, UK, ...) where target instances are located.
#>
function Connect-XrmUser {
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $false)]
        [String]
        $UserName,

        [Parameter(Mandatory = $false)]
        [String]
        $Password,        

        [Parameter(Mandatory = $true)]
        # TODO : Check AD and IFD
        [ValidateSet("Office365", "AD", "Ifd")]
        [string]
        $AuthType,
        
        [Parameter(Mandatory = $false)]
        [String]
        [ArgumentCompleter( { Get-XrmRegions })]
        $Region
    )
    begin {   
        $StopWatch = [System.Diagnostics.Stopwatch]::StartNew(); 
        Trace-XrmFunction -Name $MyInvocation.MyCommand.Name -Stage Start -Parameters ($MyInvocation.MyCommand.Parameters);        
    }    
    process {   

        # Set Credential object required authentications
        $credentials = Set-XrmCredentials -Login $UserName -Password $Password;        
                
        # Initialize context
        $Global:XrmContext = New-XrmContext; 

        $xrmConnection = New-XrmConnection;   
        $xrmConnection.AuthType = $AuthType;
        $xrmConnection.UserName = $UserName;
        $xrmConnection.Password = $Password;
        $xrmConnection.Credentials = $credentials;
        $xrmConnection.Region = $Region;

        $Global:XrmContext.IsOnline = ($AuthType -eq "Office365");
        $Global:XrmContext.IsOnPremise = ($AuthType -ne "Office365");

        $Global:XrmContext.CurrentConnection = $xrmConnection;
        $Global:XrmContext.IsUserConnected = $true;
    }
    end {
        $StopWatch.Stop();
        Trace-XrmFunction -Name $MyInvocation.MyCommand.Name -Stage Stop -StopWatch $StopWatch;
    }    
}

Export-ModuleMember -Function Connect-XrmUser -Alias *;