d365fo.integrations.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = '0.4.14' $Script:TimeSignals = @{} Set-PSFFeature -Name PSFramework.InheritEnableException -Value $true -ModuleName 'd365fo.integrations' # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName d365fo.integrations.Import.DoDotSource -Fallback $false if ($d365fo.integrations_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName d365fo.integrations.Import.IndividualFiles -Fallback $false if ($d365fo.integrations_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) if ($doDotSource) { . (Resolve-Path $Path) } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText((Resolve-Path $Path)))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\preimport.ps1" # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\postimport.ps1" # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'd365fo.integrations' -Language 'en-US' <# .SYNOPSIS Add content to a Web Request .DESCRIPTION Add the payload as content into the Web Request object .PARAMETER WebRequest The Web Request object that you want to add the content to .PARAMETER Payload The entire string contain the json object that you want to pass to the D365FO environment .EXAMPLE PS C:\> $request = New-WebRequest -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/ack/123456789" -Action "POST" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." PS C:\> Add-WebRequestContentFromFile -WebRequest $request -Payload '{"CorrelationId": "5acd8121-d4e1-4cf8-b31f-9713de3e3627", "PopReceipt": "AgAAAAMAAAAAAAAA3XpSEQ0b1QE=", "DownloadLocation": "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217", "IsDownLoadFileExist": True, "FileDownLoadErrorMessage": ""}' This will add the payload content to the Web Request. It will create a new Web Request object. It will use the '{"CorrelationId": "5acd8121-d4e1-4cf8-b31f-9713de3e3627", "PopReceipt": "AgAAAAMAAAAAAAAA3XpSEQ0b1QE=", "DownloadLocation": "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217", "IsDownLoadFileExist": True, "FileDownLoadErrorMessage": ""}' as the payload content to add to the web request. .LINK New-WebRequest .NOTES Tags: Request, DMF, Package, Packages Author: Mötz Jensen (@Splaxi) #> # function Add-WebRequestContent { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [System.Net.WebRequest] $WebRequest, [Parameter(Mandatory = $true)] [string] $Payload ) Write-PSFMessage -Level Verbose -Message "Parsing the payload and adding it to the web request." -Target $JobId try { $WebRequest.ContentLength = [System.Text.Encoding]::UTF8.GetByteCount($Payload) $stream = $WebRequest.GetRequestStream() $streamWriter = new-object System.IO.StreamWriter($stream) $streamWriter.Write([string]$Payload) $streamWriter.Flush() $streamWriter.Close() } catch { Write-PSFMessage -Level Critical -Message "Exception while creating WebRequest $RequestUrl" -Exception $_.Exception Stop-PSFFunction -Message "Stopping" -StepsUpward 1 } } <# .SYNOPSIS Add content from file to a Web Request .DESCRIPTION Read the content from a file and put it into the Web Request object .PARAMETER WebRequest The Web Request object that you want to add the content of the file to .PARAMETER Path Path to the file you want to add to the Web Request object .EXAMPLE PS C:\> $request = New-WebRequest -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/enqueue/123456789" -Action "POST" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." PS C:\> Add-WebRequestContentFromFile -WebRequest $request -Path "c:\temp\d365fo.tools\dmfpackage.zip" This will add the file content to the Web Request. It will create a new Web Request object. It will use the "c:\temp\d365fo.tools\dmfpackage.zip" path to read the file content. .LINK New-WebRequest .NOTES Tags: Request, DMF, Package, Packages Author: Mötz Jensen (@Splaxi) #> function Add-WebRequestContentFromFile { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [System.Net.WebRequest] $WebRequest, [Parameter(Mandatory = $true)] [string] $Path ) if (-not (Test-PathExists -Path $Path -Type Leaf)) { return } try { Write-PSFMessage -Level Debug -Message "Working on file: $Path" -Target $Path $fileStream = New-Object System.IO.FileStream($Path, [System.IO.FileMode]::Open) Write-PSFMessage -Level Debug -Message "Length $($fileStream.Length)" $WebRequest.ContentLength = $fileStream.Length $stream = $WebRequest.GetRequestStream() $fileStream.CopyTo($stream) $fileStream.Flush() $fileStream.Close() } catch { Write-PSFMessage -Level Critical -Message "Exception while adding the file content to the WebRequest" -Exception $_.Exception Stop-PSFFunction -Message "Stopping" -StepsUpward 1 } } <# .SYNOPSIS Get DMF Dequeue Package details .DESCRIPTION Get all the needed details about a DMF package, so you can download (dequeue) it from the Dynamics 365 for Finance & Operations environment .PARAMETER JobId The GUID from the recurring data job .PARAMETER AuthenticationToken The token value that should be used to authenticate against the URL / URI endpoint .PARAMETER Url URL / URI for the D365FO environment you want to access through DMF .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Get-DmfDequeuePackageDetails -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." This will fetch the available DMF package details. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the base D365FO environment url. It will use the "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." as the bearer token for the endpoint. .NOTES Tags: Download, DMF, Package, Packages Author: Mötz Jensen (@Splaxi) #> function Get-DmfDequeuePackageDetails { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")] [CmdletBinding()] [OutputType('System.String')] param ( [Parameter(Mandatory = $true)] [String] $JobId, [Parameter(Mandatory = $true)] [string] $AuthenticationToken, [Parameter(Mandatory = $true)] [string] $Url, [switch] $EnableException ) Write-PSFMessage -Level Verbose -Message "Building request for the DMF Package dequeue endpoint." -Target $JobId $requestUrl = "$Url/api/connector/dequeue/$JobId" $request = New-WebRequest -Url $requestUrl -Action "GET" -AuthenticationToken $AuthenticationToken try { Write-PSFMessage -Level Verbose -Message "Executing the DMF Package dequeue request against the DMF endpoint." $response = $request.GetResponse() Write-PSFMessage -Level Verbose -Message "Parsing the response received from the DMF Package dequeue request." $stream = $response.GetResponseStream() $streamReader = New-Object System.IO.StreamReader($stream) $res = $streamReader.ReadToEnd() $streamReader.Close() $res } catch { $messageString = "Something went wrong while dequeuing through the DMF Package endpoint for JobId: $JobId" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $JobId Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ -StepsUpward 1 return } } <# .SYNOPSIS Get the DMF Package file .DESCRIPTION Get / Download the DMF package file from the Dynamics 365 for Finance & Operations environment .PARAMETER DownloadLocation The URI / URL where the DMF package file is available .PARAMETER Path Path where you want to store the file on your local infrastructure .PARAMETER AuthenticationToken The token value that should be used to authenticate against the URL / URI endpoint .PARAMETER Retries Number of retries the module should use to download the file .EXAMPLE PS C:\> Get-DmfFile -Path "c:\temp\d365fo.tools\dmfpackage.zip" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." -DownloadLocation "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217" This will download the DMF Package from D365FO. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the location to save the file. It will use the "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." as the bearer token for the endpoint. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217" as the request URL / URI to download the DMF Package from. .NOTES Tags: Download, DMF, Package, Packages Author: Mötz Jensen (@Splaxi) #> function Get-DmfFile { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [Alias('Url')] [Alias('Uri')] [string] $DownloadLocation, [Parameter(Mandatory = $true)] [Alias('File')] [string] $Path, [Parameter(Mandatory = $true)] [string] $AuthenticationToken, [int] $Retries = $Script:DmfDownloadRetries ) process { if ($DownloadLocation.StartsWith("http://")) { $DownloadLocation = $DownloadLocation.Replace("http://", "https://").Replace(":80", "") } Write-PSFMessage -Level Verbose -Message "Download URI / URL for the DMF Package is: $DownloadLocation" -Target $DownloadLocation $retriesLocal = $Retries while ($retriesLocal -gt 0 ) { $attemptNo = ($Retries - $retriesLocal) + 1 Write-PSFMessage -Level Verbose -Message "($attemptNo) - Building request for downloading the DMF Package." -Target $DownloadLocation $request = New-WebRequest -Url $DownloadLocation -Action "GET" -AuthenticationToken $AuthenticationToken Get-FileFromWebRequest -WebRequest $request -Path $Path if (Test-PSFFunctionInterrupt) { Write-PSFMessage -Level Verbose -Message "($attemptNo) - Downloading the DMF Package failed." $retriesLocal = $retriesLocal - 1; if ($retriesLocal -lt 0) { Write-PSFMessage -Level Critical "Number of retries exhausted for JobId: $JobId" Stop-PSFFunction -Message "Stopping" -StepsUpward 1 return } } else { $retriesLocal = 0 } } } } <# .SYNOPSIS Get file from Web Request .DESCRIPTION Extract the file from the Web Request object .PARAMETER WebRequest The Web Request object that you want to add the content to .PARAMETER Path Path where you want to store the file on your local infrastructure .EXAMPLE PS C:\> $request = New-WebRequest -Action "GET" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217" PS C:\> Get-FileFromWebRequest -WebRequest $request -Path "c:\temp\d365fo.tools\dmfpackage.zip" This will extract the file the Web Request. It will create a new Web Request. It will pass the $request variable to the function. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the path where the file should be stored. .NOTES Tags: DMF, Download Author: Mötz Jensen (@Splaxi) #> function Get-FileFromWebRequest { param( [Parameter(Mandatory = $true)] [System.Net.WebRequest] $WebRequest, [Parameter(Mandatory = $true)] [Alias('File')] [string] $Path ) $response = $null try { Write-PSFMessage -Level Verbose -Message "Executing http request to download the DMF Package." -Target $($odataEndpoint.Uri.AbsoluteUri) $response = $WebRequest.GetResponse() } catch { Write-PSFMessage -Level Verbose -Message "Error getting response from $($webRequest.RequestURI.AbsoluteUri)" -Exception $_.Exception Stop-PSFFunction -Message "Stopping" -StepsUpward 1 -EnableException:$false return } if ($response.StatusCode -eq [System.Net.HttpStatusCode]::Ok) { Write-PSFMessage -Level Verbose -Message "Status code was 'OK' - Extracting the stream." $stream = $response.GetResponseStream() Write-PSFMessage -Level Debug -Message "Creating file stream for $Path." -Target $Path $fileStream = [System.IO.File]::Create($Path) $stream.CopyTo($fileStream) Write-PSFMessage -Level Debug -Message "Close file stream." # $fileStream.Flush() $fileStream.Close() } else { Write-PSFMessage -Level Verbose -Message "Status code not Ok, Description $($response.StatusDescription)" Stop-PSFFunction -Message "Stopping" -StepsUpward 1 -EnableException:$false return } } <# .SYNOPSIS Acknowledge a DMF package status .DESCRIPTION Send an acknowledgement to the DMF endpoint in the Dynamics 365 for Finance & Operations environment .PARAMETER JobId JobId of the DMF job you want to acknowledge .PARAMETER JsonMessage The json message that you want to pass to the DMF endpoint .PARAMETER AuthenticationToken The token value that should be used to authenticate against the URL / URI endpoint .PARAMETER Url URL / URI for the D365FO environment you want to access through DMF .EXAMPLE PS C:\> Invoke-DmfAcknowledge -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" -JsonMessage '{"CorrelationId": "5acd8121-d4e1-4cf8-b31f-9713de3e3627", "PopReceipt": "AgAAAAMAAAAAAAAA3XpSEQ0b1QE=", "DownloadLocation": "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217", "IsDownLoadFileExist": True, "FileDownLoadErrorMessage": ""}' -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." This will acknowledge a DMF package through the DMF endpoint of the D365FO environment. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use the '{"CorrelationId": "5acd8121-d4e1-4cf8-b31f-9713de3e3627", "PopReceipt": "AgAAAAMAAAAAAAAA3XpSEQ0b1QE=", "DownloadLocation": "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/download/%7Bb0b5401e-56ca-4dc8-b566-84389a001236%7D?correlation-id=5acd8121-d4e1-4cf8-b31f-9713de3e3627&blob=c5fbcc38-4f1e-4a81-af27-e6684d9fc217", "IsDownLoadFileExist": True, "FileDownLoadErrorMessage": ""}' as the json message that will be passed on to the DMF endpoint. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the base D365FO environment url. It will use the "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." as the bearer token for the endpoint. .NOTES Tags: DMF, Package, Acknowledge, Acknowledgement, Ack Author: Mötz Jensen (@Splaxi) #> function Invoke-DmfAcknowledge { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [String] $JobId, [Parameter(Mandatory = $true)] [string] $JsonMessage, [Parameter(Mandatory = $true)] [string] $AuthenticationToken, [Parameter(Mandatory = $true)] [string] $Url ) Write-PSFMessage -Level Verbose -Message "Building request for the ACK interface of the DMF package." -Target $JobId $requestUrl = "$Url/api/connector/ack/$JobId" $request = New-WebRequest -Url $requestUrl -Action "POST" -AuthenticationToken $AuthenticationToken -ContentType "application/json" Add-WebRequestContent -WebRequest $request -Payload $JsonMessage try { Write-PSFMessage -Level Verbose -Message "Executing the request against the ACK interface of the DMF endpoint." -Target $JsonMessage $response = $request.GetResponse() } catch { $messageString = "Something went wrong while contacting the ACK interface of the DMF endpoint for JobId: $JobId." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $JobId Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ -StepsUpward 1 return } Write-PSFMessage -Level Verbose -Message "Status code was: $($response.StatusCode)" -Target $response.StatusCode if ($response.StatusCode -ne [System.Net.HttpStatusCode]::Ok) { Write-PSFMessage -Level Verbose -Message "Status code not Ok, Description $($response.StatusDescription)" Stop-PSFFunction -Message "Stopping" -StepsUpward 1 -EnableException:$false return } } <# .SYNOPSIS Invoke enqueueing of a DMF Package .DESCRIPTION Enqueue a DMF package to the Dynamics 365 for Finance & Operations environment .PARAMETER Path Path of the file that you want to import into D365FO .PARAMETER JobId The GUID from the recurring data job .PARAMETER AuthenticationToken The token value that should be used to authenticate against the URL / URI endpoint .PARAMETER Url URL / URI for the D365FO environment you want to access through DMF .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Invoke-DmfEnqueuePackage -Path "c:\temp\d365fo.tools\dmfpackage.zip" -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." This will upload the dmfpackage to the D365FO DMF endpoint. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the location from where to load the file. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the base D365FO environment url. It will use the "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." as the bearer token for the endpoint. .NOTES Tags: Download, DMF, Package, Packages Author: Mötz Jensen (@Splaxi) #> function Invoke-DmfEnqueuePackage { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")] [CmdletBinding()] [OutputType('System.String')] param ( [Parameter(Mandatory = $true)] [Alias('File')] [string] $Path, [Parameter(Mandatory = $true)] [String] $JobId, [Parameter(Mandatory = $true)] [string] $AuthenticationToken, [Parameter(Mandatory = $true)] [string] $Url, [switch] $EnableException ) Write-PSFMessage -Level Verbose -Message "Building request for the DMF Package enqueue endpoint." -Target $JobId $requestUrl = "$Url/api/connector/enqueue/$JobId" $request = New-WebRequest -Url $requestUrl -Action "POST" -AuthenticationToken $AuthenticationToken -ContentType "application/zip" Add-WebRequestContentFromFile -WebRequest $request -Path $Path try { Write-PSFMessage -Level Verbose -Message "Executing the request against the DMF Package enqueue endpoint." $response = $request.GetResponse() Write-PSFMessage -Level Verbose -Message "Response completed ($($request.ContentLength))." } catch { $messageString = "Something went wrong while enqueueing through the DMF Package endpoint for the JobId: $JobId" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $JobId Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ -StepsUpward 1 return } Write-PSFMessage -Level Verbose -Message "Status code was: $($response.StatusCode)" -Target $response.StatusCode #Might need another status code to be correct if ($response.StatusCode -ne [System.Net.HttpStatusCode]::Ok) { Write-PSFMessage -Level Verbose -Message "Status code not Ok, Description $($response.StatusDescription)" Stop-PSFFunction -Message "Stopping" -StepsUpward 1 -EnableException:$false return } $stream = $response.GetResponseStream() $streamReader = New-Object System.IO.StreamReader($stream); $res = $streamReader.ReadToEnd() $streamReader.Close(); $res } <# .SYNOPSIS Handle time measurement .DESCRIPTION Handle time measurement from when a cmdlet / function starts and ends Will write the output to the verbose stream (Write-PSFMessage -Level Verbose) .PARAMETER Start Switch to instruct the cmdlet that a start time registration needs to take place .PARAMETER End Switch to instruct the cmdlet that a time registration has come to its end and it needs to do the calculation .EXAMPLE PS C:\> Invoke-TimeSignal -Start This will start the time measurement for any given cmdlet / function .EXAMPLE PS C:\> Invoke-TimeSignal -End This will end the time measurement for any given cmdlet / function. The output will go into the verbose stream. .NOTES Author: Mötz Jensen (@Splaxi) #> function Invoke-TimeSignal { [CmdletBinding(DefaultParameterSetName = 'Start')] param ( [Parameter(Mandatory = $true, ParameterSetName = 'Start', Position = 1 )] [switch] $Start, [Parameter(Mandatory = $True, ParameterSetName = 'End', Position = 2 )] [switch] $End ) $Time = (Get-Date) $Command = (Get-PSCallStack)[1].Command if ($Start) { if ($Script:TimeSignals.ContainsKey($Command)) { Write-PSFMessage -Level Debug -Message "The command '$Command' was already taking part in time measurement. The entry has been update with current date and time." $Script:TimeSignals[$Command] = $Time } else { $Script:TimeSignals.Add($Command, $Time) } } else { if ($Script:TimeSignals.ContainsKey($Command)) { $TimeSpan = New-TimeSpan -End $Time -Start (($Script:TimeSignals)[$Command]) Write-PSFMessage -Level Verbose -Message "Total time spent inside the function was $TimeSpan" -Target $TimeSpan -FunctionName $Command -Tag "TimeSignal" $null = $Script:TimeSignals.Remove($Command) } else { Write-PSFMessage -Level Debug -Message "The command '$Command' was never started to take part in time measurement." } } } <# .SYNOPSIS Create batch content .DESCRIPTION Create a valid batch content that can be used in a HTTP batch request .PARAMETER Url URL / URI that the batch content should be valid for Normally the final URL / URI for the OData endpoint that the content is to be imported into .PARAMETER AuthenticationToken The token value that should be used to authenticate against the URL / URI endpoint .PARAMETER Payload The entire string contain the json object that you want to import into the D365FO environment .PARAMETER Count The index number that the content should be stamped with, to be valid in the entire batch request content .EXAMPLE PS C:\> New-BatchContent -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com/data/ExchangeRates" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." -Payload '{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' -Count 1 This will create a new batch content string. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com/data/ExchangeRates" as the endpoint for the content. It will use the "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." as the bearer token for the endpoint. It will use '{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' as the payload that needs to be included in the batch content. Iw will use 1 as the counter in the batch content number sequence. .NOTES Tags: OData, Data Entity, Batchmode, Batch, Batch Content, Multiple Author: Mötz Jensen (@Splaxi) Author: Rasmus Andersen (@ITRasmus) #> function New-BatchContent { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] param( [Parameter(Mandatory = $true, Position = 1)] [string] $Url, [Parameter(Mandatory = $true, Position = 2)] [string] $AuthenticationToken, [Parameter(Mandatory = $true, Position = 3)] [string] $Payload, [Parameter(Mandatory = $true, Position = 4)] [string] $Count ) $dataBuilder = [System.Text.StringBuilder]::new() $null = $dataBuilder.AppendLine("Content-Type: application/http") $null = $dataBuilder.AppendLine("Content-Transfer-Encoding: binary") $null = $dataBuilder.AppendLine("Content-ID: $Count") $null = $dataBuilder.AppendLine("") #On purpose! $null = $dataBuilder.AppendLine("POST $Url HTTP/1.1") $null = $dataBuilder.AppendLine("OData-Version: 4.0") $null = $dataBuilder.AppendLine("OData-MaxVersion: 4.0") $null = $dataBuilder.AppendLine("Content-Type: application/json;odata.metadata=minimal") $null = $dataBuilder.AppendLine("Authorization: $AuthenticationToken") $null = $dataBuilder.AppendLine("") #On purpose! $null = $dataBuilder.AppendLine("$Payload") $dataBuilder.ToString() } <# .SYNOPSIS Get a new bearer token .DESCRIPTION Obtain a new bearer token to be used for the different HTTP request against the Dynamics 365 for Finance & Operations environment .PARAMETER Url URL / URI for web endpoint that you want the token to be valid for .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to authenticate against .EXAMPLE PS C:\> New-BearerToken -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -ClientId "dea8d7a9-1602-4429-b138-111111111111" -ClientSecret "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" -Tenant "e674da86-7ee5-40a7-b777-1111111111111" This will obtain a new and valid bearer token. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the resource url that you want the token to be valid for. It will use "dea8d7a9-1602-4429-b138-111111111111" as the ClientId. It will use "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" as ClientSecret It will use "e674da86-7ee5-40a7-b777-1111111111111" as the Azure Active Directory guid. .NOTES Tags: OAuth, OAuth 2.0, Token, Bearer, JWT Author: Mötz Jensen (@Splaxi) #> function New-BearerToken { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [Alias('Uri')] [string] $Url, [Parameter(Mandatory = $true)] [string] $ClientId, [Parameter(Mandatory = $true)] [string] $ClientSecret, [Parameter(Mandatory = $true)] [string] $Tenant ) Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for fetching the bearer token." -Target $Var $bearerParms = @{ Resource = $Url ClientId = $ClientId ClientSecret = $ClientSecret } $azureUri = $Script:AzureTenantOauthToken $bearerParms.AuthProviderUri = $azureUri -f $Tenant Write-PSFMessage -Level Verbose -Message "Fetching the bearer token." -Target ($bearerParms -join ", ") Invoke-ClientCredentialsGrant @bearerParms | Get-BearerToken Invoke-TimeSignal -End } <# .SYNOPSIS Create a webrequest .DESCRIPTION Create a webrequest with the needed details handled .PARAMETER Url URL / URI for web endpoint you want to work against .PARAMETER Action HTTP action instructing the cmdlet how to build the request .PARAMETER AuthenticationToken The token value that should be used to authenticate against the URL / URI endpoint .PARAMETER ContentType HTTP valid content type value that the cmdlet should use while building the request .EXAMPLE PS C:\> New-WebRequest -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/dequeue/123456789" -Action "GET" -AuthenticationToken "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." This will create a new webrequest. It will use the "https://usnconeboxax1aos.cloud.onebox.dynamics.com/api/connector/dequeue/123456789" as the webrequest endpoint address. It will use the "Get" as HTTP Action. It will use the "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi....." as the bearer token for the HTTP Authorization header. .NOTES Tags: Request, DMF, Package, Packages Author: Mötz Jensen (@Splaxi) #> function New-WebRequest { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] [OutputType([System.Net.WebRequest])] param( [Parameter(Mandatory = $true)] [string] $Url, [Parameter(Mandatory = $true)] [string] $Action, [Parameter(Mandatory = $true)] [string] $AuthenticationToken, [Parameter(Mandatory = $false)] [string] $ContentType ) Write-PSFMessage -Level Debug -Message "New Request $Url, $Action, $AuthenticationToken, $ContentType " $request = [System.Net.WebRequest]::Create($Url) $request.Headers["Authorization"] = $AuthenticationToken $request.Method = $Action if ($Action -eq 'POST') { $request.ContentType = $ContentType } $request } <# .SYNOPSIS The multiple paths .DESCRIPTION Easy way to test multiple paths for public functions and have the same error handling .PARAMETER Path Array of paths you want to test They have to be the same type, either file/leaf or folder/container .PARAMETER Type Type of path you want to test Either 'Leaf' or 'Container' .PARAMETER Create Instruct the cmdlet to create the directory if it doesn't exist .PARAMETER ShouldNotExist Instruct the cmdlet to return true if the file doesn't exists .PARAMETER DontBreak Instruct the cmdlet NOT to break execution whenever the test condition normally should .EXAMPLE PS C:\> Test-PathExists "c:\temp","c:\temp\dir" -Type Container This will test if the mentioned paths (folders) exists and the current context has enough permission. .NOTES Author: Mötz Jensen (@splaxi) #> function Test-PathExists { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")] [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $True, Position = 1 )] [string[]] $Path, [ValidateSet('Leaf', 'Container')] [Parameter(Mandatory = $True, Position = 2 )] [string] $Type, [switch] $Create, [switch] $ShouldNotExist, [switch] $DontBreak ) $res = $false $arrList = New-Object -TypeName "System.Collections.ArrayList" foreach ($item in $Path) { Write-PSFMessage -Level Verbose -Message "Testing the path: $item" -Target $item $temp = Test-Path -Path $item -Type $Type if ((-not $temp) -and ($Create) -and ($Type -eq "Container")) { Write-PSFMessage -Level Verbose -Message "Creating the path: $item" -Target $item $null = New-Item -Path $item -ItemType Directory -Force -ErrorAction Stop $temp = $true } elseif ($ShouldNotExist) { Write-PSFMessage -Level Verbose -Message "The should NOT exists: $item" -Target $item } elseif (-not $temp ) { Write-PSFMessage -Level Host -Message "The <c='em'>$item</c> path wasn't found. Please ensure the path <c='em'>exists</c> and you have enough <c='em'>permission</c> to access the path." } $null = $arrList.Add($temp) } if ($arrList.Contains($false) -and (-not $ShouldNotExist)) { if (-not $DontBreak) { Stop-PSFFunction -Message "Stopping because of missing paths." -StepsUpward 1 } } elseif ($arrList.Contains($true) -and $ShouldNotExist) { if (-not $DontBreak) { Stop-PSFFunction -Message "Stopping because file exists." -StepsUpward 1 } } else { $res = $true } $res } <# .SYNOPSIS Update the OData config variables .DESCRIPTION Update the active OData config variables that the module will use as default values .EXAMPLE PS C:\> Update-ODataVariables This will update the OData variables. .NOTES Author: Mötz Jensen (@Splaxi) #> function Update-ODataVariables { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")] [CmdletBinding()] [OutputType()] param ( ) $configName = (Get-PSFConfig -FullName "d365fo.integrations.active.odata.config.name").Value if (([string]::IsNullOrEmpty($configName))) { return } $configName = $configName.ToString().ToLower() Remove-Variable -Name "ODataSystemUrl" -Scope "Script" -Force -ErrorAction SilentlyContinue if (-not ($configName -eq "")) { $configHash = Get-D365ActiveODataConfig -OutputAsHashtable foreach ($item in $configHash.Keys) { if ($item -eq "name") { continue } $name = "OData" + (Get-Culture).TextInfo.ToTitleCase($item) $valueMessage = $configHash[$item] if ($item -like "*client*" -and $valueMessage.Length -gt 20) { $valueMessage = $valueMessage.Substring(0,18) + "[...REDACTED...]" } Write-PSFMessage -Level Verbose -Message "$name - $valueMessage" -Target $valueMessage Set-Variable -Name $name -Value $configHash[$item] -Scope Script } } } <# .SYNOPSIS Update module variables from the configuration store .DESCRIPTION Update all module variables that are based on the PSF configuration store .EXAMPLE PS C:\> Update-PsfConfigVariables This will update all module variables based on the configuration store. .NOTES Tags: Variable, Variables Author: Mötz Jensen (@Splaxi) #> function Update-PsfConfigVariables { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] [OutputType()] param () foreach ($config in Get-PSFConfig -FullName "d365fo.integrations.azure.*") { $item = $config.FullName.Replace("d365fo.integrations.", "") $name = (Get-Culture).TextInfo.ToTitleCase($item).Replace(".","") Write-PSFMessage -Level Verbose -Message "$name" -Target $($config.Value) Set-Variable -Name $name -Value $config.Value -Scope Script } foreach ($config in Get-PSFConfig -FullName "d365fo.integrations.dmf.*") { $item = $config.FullName.Replace("d365fo.integrations.", "") $name = (Get-Culture).TextInfo.ToTitleCase($item).Replace(".","") Write-PSFMessage -Level Verbose -Message "$name" -Target $($config.Value) Set-Variable -Name $name -Value $config.Value -Scope Script } } <# .SYNOPSIS Save an OData config .DESCRIPTION Adds an OData config to the configuration store .PARAMETER Name The logical name of the OData configuration you are about to register in the configuration store .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER Temporary Instruct the cmdlet to only temporarily add the OData configuration in the configuration store .PARAMETER Force Instruct the cmdlet to overwrite the OData configuration with the same name .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Add-D365ODataConfig -Name "UAT" -Tenant "e674da86-7ee5-40a7-b777-1111111111111" -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -ClientId "dea8d7a9-1602-4429-b138-111111111111" -ClientSecret "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" This will create an new OData configuration with the name "UAT". It will save "e674da86-7ee5-40a7-b777-1111111111111" as the Azure Active Directory guid. It will save "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the D365FO environment. It will save "dea8d7a9-1602-4429-b138-111111111111" as the ClientId. It will save "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" as ClientSecret. .NOTES Tags: Integrations, Integration, Bearer Token, Token, OData, Configuration Author: Mötz Jensen (@Splaxi) .LINK Clear-D365ActiveBroadcastMessageConfig .LINK Get-D365ActiveBroadcastMessageConfig .LINK Get-D365BroadcastMessageConfig .LINK Remove-D365BroadcastMessageConfig .LINK Send-D365BroadcastMessage .LINK Set-D365ActiveBroadcastMessageConfig #> function Add-D365ODataConfig { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $Name, [Alias('$AADGuid')] [string] $Tenant, [Alias('Uri')] [Alias('AuthenticationUrl')] [string] $Url, [string] $SystemUrl, [string] $ClientId, [string] $ClientSecret, [switch] $Temporary, [switch] $Force, [switch] $EnableException ) Write-PSFMessage -Level Verbose -Message "Testing if configuration with the name already exists or not." -Target $configurationValue if (((Get-PSFConfig -FullName "d365fo.integrations.odata.*.name").Value -contains $Name) -and (-not $Force)) { $messageString = "An OData configuration with <c='em'>$Name</c> as name <c='em'>already exists</c>. If you want to <c='em'>overwrite</c> the current configuration, please supply the <c='em'>-Force</c> parameter." Write-PSFMessage -Level Host -Message $messageString Stop-PSFFunction -Message "Stopping because an OData configuration already exists with that name." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) return } if ([System.String]::IsNullOrEmpty($SystemUrl) -and (-not [System.String]::IsNullOrEmpty($Url))) { Write-PSFMessage -Level Verbose -Message "You didn't fill in the SystemUrl parameter, which is needed. Expecting that you are working against D365FO and using the Url parameter value." -Target $Url $PSBoundParameters.Add("SystemUrl", $Url) $SystemUrl = $Url } if (![System.String]::IsNullOrEmpty($Url)) { if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } } if (![System.String]::IsNullOrEmpty($SystemUrl)) { if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } } $configName = $Name.ToLower() #The ':keys' label is used to have a continue inside the switch statement itself :keys foreach ($key in $PSBoundParameters.Keys) { $configurationValue = $PSBoundParameters.Item($key) $configurationName = $key.ToLower() $fullConfigName = "" Write-PSFMessage -Level Verbose -Message "Working on $key with $configurationValue" -Target $configurationValue switch ($key) { "Name" { $fullConfigName = "d365fo.integrations.odata.$configName.name" } { "Temporary", "Force" -contains $_ } { continue keys } Default { $fullConfigName = "d365fo.integrations.odata.$configName.$configurationName" } } Write-PSFMessage -Level Verbose -Message "Setting $fullConfigName to $configurationValue" -Target $configurationValue Set-PSFConfig -FullName $fullConfigName -Value $configurationValue if (-not $Temporary) { Register-PSFConfig -FullName $fullConfigName -Scope UserDefault } } } <# .SYNOPSIS Enable exceptions to be thrown .DESCRIPTION Change the default exception behavior of the module to support throwing exceptions Useful when the module is used in an automated fashion, like inside Azure DevOps pipelines and large PowerShell scripts .EXAMPLE PS C:\>Enable-D365ExceptionIntegrations This will for the rest of the current PowerShell session make sure that exceptions will be thrown. .NOTES Tags: Exception, Exceptions, Warning, Warnings Author: Mötz Jensen (@Splaxi) #> function Enable-D365ExceptionIntegrations { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")] [CmdletBinding()] param () Write-PSFMessage -Level Verbose -Message "Enabling exception across the entire module." -Target $configurationValue $PSDefaultParameterValues['*:EnableException'] = $true } <# .SYNOPSIS Export a DMF package from Dynamics 365 Finance & Operations .DESCRIPTION Exports a DMF package from the DMF endpoint of the Dynamics 365 Finance & Operations .PARAMETER Path Path where you want the cmdlet to save the exported file to .PARAMETER JobId JobId of the DMF job you want to export from .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through DMF .PARAMETER Url URL / URI for the D365FO environment you want to access through DMF .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Export-D365DmfPackage -Path "c:\temp\d365fo.tools\dmfpackage.zip" -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" This will export a package from the 123456789 job through the DMF endpoint. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the location to save the file. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> Export-D365DmfPackage -Path "c:\temp\d365fo.tools\dmfpackage.zip" -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" -Tenant "e674da86-7ee5-40a7-b777-1111111111111" -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -ClientId "dea8d7a9-1602-4429-b138-111111111111" -ClientSecret "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" This will export a package from the 123456789 job through the DMF endpoint. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the location to save the file. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use "e674da86-7ee5-40a7-b777-1111111111111" as the Azure Active Directory guid. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the base D365FO environment url. It will use "dea8d7a9-1602-4429-b138-111111111111" as the ClientId. It will use "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" as ClientSecret. .LINK Add-D365ODataConfig .LINK Get-D365ActiveODataConfig .LINK Set-D365ActiveODataConfig .NOTES Tags: Export, Download, DMF, Package, Packages, JobId Author: Mötz Jensen (@Splaxi) #> function Export-D365DmfPackage { [CmdletBinding()] [OutputType('System.String')] param ( [Parameter(Mandatory = $true)] [Alias('File')] [string] $Path, [Parameter(Mandatory = $true)] [String] $JobId, [Parameter(Mandatory = $false)] [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Parameter(Mandatory = $false)] [Alias('Uri')] [string] $Url = $Script:ODataUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException ) begin { $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms } process { Invoke-TimeSignal -Start $dmfParms = @{ JobId = $JobId Url = $Url AuthenticationToken = $bearer } $dmfDetails = Get-DmfDequeuePackageDetails @dmfParms -EnableException:$EnableException if (Test-PSFFunctionInterrupt) { return } if ([string]::IsNullOrWhiteSpace($dmfDetails)) { $messageString = "There was no file ready to be downloaded." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } $dmfDetailsJson = $dmfDetails | ConvertFrom-Json if ($VerbosePreference -ne [System.Management.Automation.ActionPreference]::SilentlyContinue) { Write-PSFMessage -Level Verbose -Message "$dmfDetails" -Target $dmfDetailsJson } $dmfDetailsJson | Get-DmfFile -Path $Path -AuthenticationToken $bearer if (Test-PSFFunctionInterrupt) { Stop-PSFFunction -Message "Downloading the DMF Package file failed." -Exception $([System.Exception]::new("Unable to download the DMF package file.")) return } Invoke-DmfAcknowledge -JsonMessage $dmfDetails @dmfParms if (Test-PSFFunctionInterrupt) { Stop-PSFFunction -Message "Acknowledgement of the DMF Package failed." -Exception $([System.Exception]::new("Unable to acknowledge the DMF package file.")) return } Get-Item -Path $Path | Select-PSFObject "Name as Filename", @{Name = "Size"; Expression = {[PSFSize]$_.Length}}, "LastWriteTime as LastModified", "Fullname as File" Invoke-TimeSignal -End } } <# .SYNOPSIS Get the active OData configuration .DESCRIPTION Get the active OData configuration from the configuration store .PARAMETER OutputAsHashtable Instruct the cmdlet to return a hashtable object .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Get-D365ActiveODataConfig This will get the active OData configuration. .NOTES Tags: OData, Environment, Config, Configuration, ClientId, ClientSecret Author: Mötz Jensen (@Splaxi) .LINK Add-D365BroadcastMessageConfig .LINK Clear-D365ActiveBroadcastMessageConfig .LINK Get-D365BroadcastMessageConfig .LINK Remove-D365BroadcastMessageConfig .LINK Send-D365BroadcastMessage .LINK Set-D365ActiveBroadcastMessageConfig #> function Get-D365ActiveODataConfig { [CmdletBinding()] [OutputType()] param ( [switch] $OutputAsHashtable, [switch] $EnableException ) $configName = (Get-PSFConfig -FullName "d365fo.integrations.active.odata.config.name").Value if ($configName -eq "") { $messageString = "It looks like there <c='em'>isn't configured</c> an active OData configuration." Write-PSFMessage -Level Host -Message $messageString Stop-PSFFunction -Message "Stopping because an active OData configuration wasn't found." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>',''))) return } Get-D365ODataConfig -Name $configName -OutputAsHashtable:$OutputAsHashtable } <# .SYNOPSIS Get Message Status from the DMF .DESCRIPTION Get the Message Status based on the MessageId from the DMF Endpoint of the Dynamics 365 for Finance & Operations environment .PARAMETER MessageId MessageId of the message that you want to query the status for .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through DMF .PARAMETER Url URL / URI for the D365FO environment you want to access through DMF .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER WaitForCompletion Instruct the cmdlet to wait until the Message Status is in a terminating state .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Get-D365DmfMessageStatus -MessageId "84a383c8-336d-45e4-9933-0c3e8bfb734a" This will get the message status through the DMF endpoint. It will use "84a383c8-336d-45e4-9933-0c3e8bfb734a" as the MessageId parameter passed to the DMF endpoint. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> Get-D365DmfMessageStatus -MessageId "84a383c8-336d-45e4-9933-0c3e8bfb734a" -Tenant "e674da86-7ee5-40a7-b777-1111111111111" -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -ClientId "dea8d7a9-1602-4429-b138-111111111111" -ClientSecret "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" This will import a package into the 123456789 job through the DMF endpoint. It will use "84a383c8-336d-45e4-9933-0c3e8bfb734a" as the MessageId parameter passed to the DMF endpoint. It will use "e674da86-7ee5-40a7-b777-1111111111111" as the Azure Active Directory guid. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the base D365FO environment url. It will use "dea8d7a9-1602-4429-b138-111111111111" as the ClientId. It will use "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" as ClientSecret. .LINK Add-D365ODataConfig .LINK Get-D365ActiveODataConfig .LINK Import-D365DmfPackage .LINK Set-D365ActiveODataConfig .NOTES Tags: Import, Upload, DMF, Package, Packages, Message, MessageId, Message Status Author: Mötz Jensen (@Splaxi) #> function Get-D365DmfMessageStatus { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string] $MessageId, [Parameter(Mandatory = $false)] [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Parameter(Mandatory = $false)] [Alias('URI')] [string] $Url = $Script:ODataUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $WaitForCompletion, [switch] $EnableException ) begin { $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $URL BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms } process { Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for the Message Status OData endpoint." $payload = "{'messageId':'$MessageId'}" [System.UriBuilder] $odataEndpoint = $URL $odataEndpoint.Path = "data/DataManagementDefinitionGroups/Microsoft.Dynamics.DataEntities.GetMessageStatus" try { do{ $res = $null if($WaitForCompletion) { Start-Sleep -Seconds 60 } Write-PSFMessage -Level Verbose -Message "Executing http request against the Message Status OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) $res = Invoke-RestMethod -Method Post -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' -Body $payload Write-PSFMessage -Level Verbose -Message "Message Status is: $($res.Value) - MessageId: $MessageId" -Target $res.Value } while ((($res.Value -ne "Processed") -and ($res.Value -ne "PreProcessingError") -and ($res.Value -ne "ProcessedWithErrors") -and ($res.Value -ne "PostProcessingFailed")) -and $WaitForCompletion) $res | Add-Member -NotePropertyName "MessageId" -NotePropertyValue $MessageId $res | Select-PSFObject "Value as MessageStatus", "MessageId", "@odata.context" } catch { $messageString = "Something went wrong while retrieving data from the Message Status OData endpoint for MessageId: $MessageId" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $MessageId Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>',''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } end { } } <# .SYNOPSIS Get OData configs .DESCRIPTION Get all OData configuration objects from the configuration store .PARAMETER Name The name of the OData configuration you are looking for Default value is "*" to display all OData configs .PARAMETER OutputAsHashtable Instruct the cmdlet to return a hashtable object .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Get-D365ODataConfig This will display all OData configurations on the machine. .EXAMPLE PS C:\> Get-D365ODataConfig -OutputAsHashtable This will display all OData configurations on the machine. Every object will be output as a hashtable, for you to utilize as parameters for other cmdlets. .EXAMPLE PS C:\> Get-D365ODataConfig -Name "UAT" This will display the OData configuration that is saved with the name "UAT" on the machine. .NOTES Tags: OData, Environment, Config, Configuration, ClientId, ClientSecret Author: Mötz Jensen (@Splaxi) .LINK Add-D365BroadcastMessageConfig .LINK Clear-D365ActiveBroadcastMessageConfig .LINK Get-D365ActiveBroadcastMessageConfig .LINK Remove-D365BroadcastMessageConfig .LINK Send-D365BroadcastMessage .LINK Set-D365ActiveBroadcastMessageConfig #> function Get-D365ODataConfig { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '')] [CmdletBinding()] [OutputType('PSCustomObject')] param ( [string] $Name = "*", [switch] $OutputAsHashtable, [switch] $EnableException ) Write-PSFMessage -Level Verbose -Message "Fetch all configurations based on $Name" -Target $Name $Name = $Name.ToLower() $configurations = Get-PSFConfig -FullName "d365fo.integrations.odata.$Name.name" if($($configurations.count) -lt 1) { $messageString = "No configurations found <c='em'>with</c> the name." Write-PSFMessage -Level Host -Message $messageString Stop-PSFFunction -Message "Stopping because no configuration found." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>',''))) return } foreach ($configName in $configurations.Value.ToLower()) { Write-PSFMessage -Level Verbose -Message "Working against the $configName configuration" -Target $configName $res = @{} $configName = $configName.ToLower() foreach ($config in Get-PSFConfig -FullName "d365fo.integrations.odata.$configName.*") { $propertyName = $config.FullName.ToString().Replace("d365fo.integrations.odata.$configName.", "") $res.$propertyName = $config.Value } if($OutputAsHashtable) { $res } else { [PSCustomObject]$res } } } <# .SYNOPSIS Get data from an Data Entity using OData .DESCRIPTION Get data from an Data Entity using the OData endpoint of the Dynamics 365 Finance & Operations .PARAMETER EntityName Name of the Data Entity you want to work against The parameter is Case Sensitive, because the OData endpoint in D365FO is Case Sensitive Remember that most Data Entities in a D365FO environment is named by its singular name, but most be retrieve using the plural name E.g. The version 3 of the customers Data Entity is named CustomerV3, but can only be retrieving using CustomersV3 Look at the Get-D365ODataPublicEntity cmdlet to help you obtain the correct name .PARAMETER EntitySetName Name of the Data Entity you want to work against The parameter is created specifically to be used when piping from Get-D365ODataPublicEntity .PARAMETER Top Number of records that you want returned from the OData endpoint Setting this will override anything in the OData parameter .PARAMETER Filter Filter statements to limit the records outputted from the OData endpoint Supports an array of filter statements, so you don't need to know the syntax of combining filter statements Setting this will override anything in the OData parameter .PARAMETER Select List of properties/columns that you want to return for the records outputted from the OData endpoint Setting this will override anything in the OData parameter .PARAMETER Expand List of navigation properties/related properties that you want to include for the records outputted from the OData endpoint Setting this will override anything in the OData parameter .PARAMETER ODataQuery Valid OData query string that you want to pass onto the D365 OData endpoint while retrieving data OData specific query options are: $filter $expand $select $orderby $top $skip Each option has different characteristics, which is well documented at: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html .PARAMETER CrossCompany Instruct the cmdlet / function to ensure the request against the OData endpoint will search across all companies .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .PARAMETER RawOutput Instructs the cmdlet to include the outer structure of the response received from OData endpoint The output will still be a PSCustomObject .PARAMETER OutputAsJson Instructs the cmdlet to convert the output to a Json string .EXAMPLE PS C:\> Get-D365ODataEntityData -EntityName CustomersV3 -ODataQuery '$top=1' This will get Customers from the OData endpoint. It will use the CustomerV3 entity, and its EntitySetName / CollectionName "CustomersV3". It will get the top 1 results from the list of customers. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> Get-D365ODataEntityData -EntityName CustomersV3 -ODataQuery '$top=10' -CrossCompany This will get Customers from the OData endpoint. It will use the CustomerV3 entity, and its EntitySetName / CollectionName "CustomersV3". It will get the top 10 results from the list of customers. It will make sure to search across all legal entities / companies inside the D365FO environment. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> Get-D365ODataEntityData -EntityName CustomersV3 -ODataQuery '$top=10&$filter=dataAreaId eq ''Comp1''' -CrossCompany This will get Customers from the OData endpoint. It will use the CustomerV3 entity, and its EntitySetName / CollectionName "CustomersV3". It will get the top 10 results from the list of customers. It will make sure to search across all legal entities / companies inside the D365FO environment. It will search the customers inside the "Comp1" legal entity / company. It will use the default OData configuration details that are stored in the configuration store. .LINK Add-D365ODataConfig .LINK Get-D365ActiveODataConfig .LINK Set-D365ActiveODataConfig .NOTES The OData standard is using the $ (dollar sign) for many functions and features, which in PowerShell is normally used for variables. Whenever you want to use the different query options, you need to take the $ sign and single quotes into consideration. Example of an execution where I want the top 1 result only, from a specific legal entity / company. This example is using single quotes, to help PowerShell not trying to convert the $ into a variable. Because the OData standard is using single quotes as text qualifiers, we need to escape them with multiple single quotes. -ODataQuery '$top=1&$filter=dataAreaId eq ''Comp1''' Tags: OData, Data, Entity, Query Author: Mötz Jensen (@Splaxi) #> function Get-D365ODataEntityData { [CmdletBinding(DefaultParameterSetName = "Default")] [OutputType()] param ( [Parameter(Mandatory = $true, ParameterSetName = "Specific")] [Alias('Name')] [string] $EntityName, [Parameter(Mandatory = $true, ParameterSetName = "Default", ValueFromPipelineByPropertyName = $true)] [Alias('CollectionName')] [string] $EntitySetName, [int] $Top, [string[]] $Filter, [string[]] $Select, [string[]] $Expand, [string] $ODataQuery, [switch] $CrossCompany, [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Alias('Uri')] [Alias('AuthenticationUrl')] [string] $Url = $Script:ODataUrl, [string] $SystemUrl = $Script:ODataSystemUrl, [string] $ClientId = $Script:ODataClientId, [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException, [switch] $RawOutput, [switch] $OutputAsJson ) begin { if ([System.String]::IsNullOrEmpty($SystemUrl)) { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter was empty, using the Url parameter as the OData endpoint base address." -Target $SystemUrl $SystemUrl = $Url } if ([System.String]::IsNullOrEmpty($Url) -or [System.String]::IsNullOrEmpty($SystemUrl)) { $messageString = "It seems that you didn't supply a valid value for the Url parameter. You need specify the Url parameter or add a configuration with the <c='em'>Add-D365ODataConfig</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $Url BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms $odataAppend = "&" $sbODataQuery = [System.Text.StringBuilder]::new() if ($Top -gt 0) { [void]$sbODataQuery.AppendFormat("`$top={0}", $top) } if (-not [System.String]::IsNullOrEmpty($Filter)) { if ($sbODataQuery.Length -gt 0) { $odataFilterAppend = $odataAppend } [void]$sbODataQuery.AppendFormat("{0}`$filter={1}", $odataFilterAppend, $($Filter -join " and ")) } if (-not [System.String]::IsNullOrEmpty($Select)) { if ($sbODataQuery.Length -gt 0) { $odataSelectAppend = $odataAppend } [void]$sbODataQuery.AppendFormat("{0}`$select={1}", $odataSelectAppend, $($Select -join ",")) } if (-not [System.String]::IsNullOrEmpty($Expand)) { if ($sbODataQuery.Length -gt 0) { $odataExpandAppend = $odataAppend } [void]$sbODataQuery.AppendFormat("{0}`$expand={1}", $odataExpandAppend, $($Expand -join ",")) } if ($sbODataQuery.Length -gt 0) { $ODataQuery = $sbODataQuery.ToString() } } process { if (Test-PSFFunctionInterrupt) { return } Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for the OData endpoint for entity: $entity." -Target $entity #A simple hack to select either names as the name going forward $entity = "$EntityName$EntitySetName" [System.UriBuilder] $odataEndpoint = $SystemUrl if ($odataEndpoint.Path -eq "/") { $odataEndpoint.Path = "data/$entity" } else { $odataEndpoint.Path += "/data/$entity" } if (-not ([string]::IsNullOrEmpty($ODataQuery))) { $odataEndpoint.Query = "$ODataQuery" } if ($CrossCompany) { $odataEndpoint.Query = $($odataEndpoint.Query + "&cross-company=true").Replace("?", "") } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) $res = Invoke-RestMethod -Method Get -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' if (-not $RawOutput) { $res = $res.Value } if ($OutputAsJson) { $res | ConvertTo-Json -Depth 10 } else { $res } } catch { $messageString = "Something went wrong while retrieving data from the OData endpoint for the entity: $entity" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entity Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# .SYNOPSIS Get data from an Data Entity using OData, providing a key .DESCRIPTION Get data from an Data Entity, by providing a key, using the OData endpoint of the Dynamics 365 Finance & Operations .PARAMETER EntityName Name of the Data Entity you want to work against The parameter is Case Sensitive, because the OData endpoint in D365FO is Case Sensitive Remember that most Data Entities in a D365FO environment is named by its singular name, but most be retrieve using the plural name E.g. The version 3 of the customers Data Entity is named CustomerV3, but can only be retrieving using CustomersV3 Look at the Get-D365ODataPublicEntity cmdlet to help you obtain the correct name .PARAMETER Key A string value that contains all needed fields and value to be a valid OData key The key needs to be a valid http encoded value and each datatype needs to handled appropriately .PARAMETER ODataQuery Valid OData query string that you want to pass onto the D365 OData endpoint while retrieving data OData specific query options are: $filter $expand $select $orderby $top $skip Each option has different characteristics, which is well documented at: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html .PARAMETER CrossCompany Instruct the cmdlet / function to ensure the request against the OData endpoint will search across all companies .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .PARAMETER OutputAsJson Instructs the cmdlet to convert the output to a Json string .EXAMPLE PS C:\> Get-D365ODataEntityDataByKey -EntityName CustomersV3 -Key "dataAreaId='DAT',CustomerAccount='123456789'" This will get the specific Customer from the OData endpoint. It will use the "CustomerV3" entity, and its EntitySetName / CollectionName "CustomersV3". It will use the "dataAreaId='DAT',CustomerAccount='123456789'" as key to identify the unique Customer record. It will NOT look across companies. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> Get-D365ODataEntityDataByKey -EntityName CustomersV3 -Key "dataAreaId='DAT',CustomerAccount='123456789'" This will get the specific Customer from the OData endpoint. It will use the "CustomerV3" entity, and its EntitySetName / CollectionName "CustomersV3". It will use the "dataAreaId='DAT',CustomerAccount='123456789'" as key to identify the unique Customer record. It will make sure to search across all legal entities / companies inside the D365FO environment. It will use the default OData configuration details that are stored in the configuration store. .LINK Add-D365ODataConfig .LINK Get-D365ActiveODataConfig .LINK Set-D365ActiveODataConfig .NOTES The OData standard is using the $ (dollar sign) for many functions and features, which in PowerShell is normally used for variables. Whenever you want to use the different query options, you need to take the $ sign and single quotes into consideration. Example of an execution where I want the top 1 result only, from a specific legal entity / company. This example is using single quotes, to help PowerShell not trying to convert the $ into a variable. Because the OData standard is using single quotes as text qualifiers, we need to escape them with multiple single quotes. -ODataQuery '$top=1&$filter=dataAreaId eq ''Comp1''' Tags: OData, Data, Entity, Query Author: Mötz Jensen (@Splaxi) #> function Get-D365ODataEntityDataByKey { [CmdletBinding(DefaultParameterSetName = "Default")] [OutputType()] param ( [Parameter(Mandatory = $true, ParameterSetName = "Specific")] [Alias('Name')] [string] $EntityName, [Parameter(Mandatory = $true, ParameterSetName = "Specific")] [string] $Key, [string] $ODataQuery, [switch] $CrossCompany, [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Alias('Uri')] [Alias('AuthenticationUrl')] [string] $Url = $Script:ODataUrl, [string] $SystemUrl = $Script:ODataSystemUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException, [switch] $OutputAsJson ) begin { if ([System.String]::IsNullOrEmpty($SystemUrl)) { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter was empty, using the Url parameter as the OData endpoint base address." -Target $SystemUrl $SystemUrl = $Url } if ([System.String]::IsNullOrEmpty($Url) -or [System.String]::IsNullOrEmpty($SystemUrl)) { $messageString = "It seems that you didn't supply a valid value for the Url parameter. You need specify the Url parameter or add a configuration with the <c='em'>Add-D365ODataConfig</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $Url BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms } process { if (Test-PSFFunctionInterrupt) { return } Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for the OData endpoint for entity: $entity." -Target $entity [System.UriBuilder] $odataEndpoint = $SystemUrl if ($odataEndpoint.Path -eq "/") { $odataEndpoint.Path = "data/$EntityName($Key)" } else { $odataEndpoint.Path += "/data/$EntityName($Key)" } if (-not ([string]::IsNullOrEmpty($ODataQuery))) { $odataEndpoint.Query = "$ODataQuery" } if ($CrossCompany) { $odataEndpoint.Query = $($odataEndpoint.Query + "&cross-company=true").Replace("?", "") } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) $res = Invoke-RestMethod -Method Get -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' if ($OutputAsJson) { $res | ConvertTo-Json -Depth 10 } else { $res } } catch [System.Net.WebException] { $webException = $_.Exception if (($webException.Status -eq [System.Net.WebExceptionStatus]::ProtocolError) -and (-not($null -eq $webException.Response))) { $resp = [System.Net.HttpWebResponse]$webException.Response if ($resp.StatusCode -eq [System.Net.HttpStatusCode]::NotFound) { $messageString = "It seems that the OData endpoint was unable to locate the desired entity: $EntityName, based on the key: <c='em'>$key</c>. Please make sure that the key is <c='em'>valid</c> or try using the <c='em'>-CrossCompany</c> parameter." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of HTTP error 404." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } else { $messageString = "Something went wrong while retrieving data from the OData endpoint for the entity: $EntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } } } catch { $messageString = "Something went wrong while retrieving data from the OData endpoint for the entity: $EntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# .SYNOPSIS Get key field(s) from Data Entity .DESCRIPTION Get the key field(s) from a Data Entity and its meta data .PARAMETER Name Name of the Data Entity .PARAMETER Properties The properties value from the meta data object .EXAMPLE PS C:\> Get-D365ODataPublicEntity -EntityName CustomersV3 | Get-D365ODataEntityKey | Format-List This will extract all the relevant key fields from the Data Entity. The "CustomersV3" value is used to get the desired Data Entity. The output from Get-D365ODataPublicEntity is piped into Get-D365ODataEntityKey. All key fields will be extracted and displayed. The output will be formatted as a list. .LINK Get-D365ODataPublicEntity .NOTES Tags: OData, Data, Entity, MetaData, Meta, Key, Keys Author: Mötz Jensen (@Splaxi) #> function Get-D365ODataEntityKey { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string] $Name, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [PSCustomObject] $Properties ) process { $filteredRes = $Properties | Where-Object IsKey -eq $true $formattedRes = $filteredRes | Select-PSFObject "Name as FieldName", DataType [PSCustomObject]@{ Name = $Name Keys = $formattedRes } } } <# .SYNOPSIS Get mandatory field(s) from Data Entity .DESCRIPTION Get the mandatory field(s) from a Data Entity and its meta data .PARAMETER Name Name of the Data Entity .PARAMETER Properties The properties value from the meta data object .EXAMPLE PS C:\> Get-D365ODataPublicEntity -EntityName CustomersV3 | Get-D365ODataEntityMandatoryField | Format-List This will extract all the relevant mandatory fields from the Data Entity. The "CustomersV3" value is used to get the desired Data Entity. The output from Get-D365ODataPublicEntity is piped into Get-D365ODataEntityMandatoryFields. All mandatory fields will be extracted and displayed. The output will be formatted as a list. .LINK Get-D365ODataPublicEntity .NOTES Tags: OData, Data, Entity, MetaData, Meta, Mandatory Author: Mötz Jensen (@Splaxi) #> function Get-D365ODataEntityMandatoryField { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string] $Name, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [PSCustomObject] $Properties ) process { $filteredRes = $Properties | Where-Object IsMandatory -eq $true $formattedRes = $filteredRes | Select-PSFObject "Name as FieldName", DataType [PSCustomObject]@{ Name = $Name Keys = $formattedRes } } } <# .SYNOPSIS Get public OData Data Entity and their metadata .DESCRIPTION Get a list with all the public available OData Data Entities,and their metadata, that are exposed through the OData endpoint of the Dynamics 365 Finance & Operations environment The cmdlet will search across the singular names for the Data Entities and across the collection names (plural) .PARAMETER EntityName Name of the Data Entity you are searching for The parameter is Case Insensitive, to make it easier for the user to locate the correct Data Entity .PARAMETER EntityNameContains Name of the Data Entity you are searching for, but instructing the cmdlet to use search logic Using this parameter enables you to supply only a portion of the name for the entity you are looking for, and still a valid result back The parameter is Case Insensitive, to make it easier for the user to locate the correct Data Entity .PARAMETER ODataQuery Valid OData query string that you want to pass onto the D365 OData endpoint while retrieving data Important note: If you are using -EntityName or -EntityNameContains along with the -ODataQuery, you need to understand that the "$filter" query is already started. Then you need to start with -ODataQuery ' and XYZ eq XYZ', e.g. -ODataQuery ' and IsReadOnly eq false' If you are using the -ODataQuery alone, you need to start the OData Query string correctly. -ODataQuery '$filter=IsReadOnly eq false' OData specific query options are: $filter $expand $select $orderby $top $skip Each option has different characteristics, which is well documented at: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .PARAMETER RawOutput Instructs the cmdlet to include the outer structure of the response received from OData endpoint The output will still be a PSCustomObject .PARAMETER OutNamesOnly Instructs the cmdlet to only display the DataEntityName and the EntityName from the response received from OData endpoint DataEntityName is the (logical) name of the entity from a code perspective. EntityName is the public OData endpoint name of the entity. .PARAMETER OutputAsJson Instructs the cmdlet to convert the output to a Json string .EXAMPLE PS C:\> Get-D365ODataPublicEntity -EntityName customersv3 This will get Data Entities from the OData endpoint. This will search for the Data Entities that are named "customersv3". .EXAMPLE PS C:\> (Get-D365ODataPublicEntity -EntityName customersv3).Value This will get Data Entities from the OData endpoint. This will search for the Data Entities that are named "customersv3". This will output the content of the "Value" property directly and list all found Data Entities and their metadata. .EXAMPLE PS C:\> Get-D365ODataPublicEntity -EntityNameContains customers This will get Data Entities from the OData endpoint. It will use the search string "customers" to search for any entity in their singular & plural name contains that search term. .EXAMPLE PS C:\> Get-D365ODataPublicEntity -EntityNameContains customer -ODataQuery ' and IsReadOnly eq true' This will get Data Entities from the OData endpoint. It will use the search string "customer" to search for any entity in their singular & plural name contains that search term. It will utilize the OData Query capabilities to filter for Data Entities that are "IsReadOnly = $true". .EXAMPLE PS C:\> Get-D365ODataPublicEntity -EntityName CustomersV3 | Get-D365ODataEntityKey | Format-List This will extract all the relevant key fields from the Data Entity. The "CustomersV3" value is used to get the desired Data Entity. The output from Get-D365ODataPublicEntity is piped into Get-D365ODataEntityKey. All key fields will be extracted and displayed. The output will be formatted as a list. .LINK Get-D365ODataEntityKey .NOTES The OData standard is using the $ (dollar sign) for many functions and features, which in PowerShell is normally used for variables. Whenever you want to use the different query options, you need to take the $ sign and single quotes into consideration. Example of an execution where I want the top 1 result only, from a specific legal entity / company. This example is using single quotes, to help PowerShell not trying to convert the $ into a variable. Because the OData standard is using single quotes as text qualifiers, we need to escape them with multiple single quotes. -ODataQuery '$top=1&$filter=dataAreaId eq ''Comp1''' Tags: OData, Data, Entity, Query Author: Mötz Jensen (@Splaxi) #> function Get-D365ODataPublicEntity { [CmdletBinding(DefaultParameterSetName = "Default")] [OutputType()] param ( [Parameter(Mandatory = $false, ParameterSetName = "Default")] [string] $EntityName, [Parameter(Mandatory = $true, ParameterSetName = "NameContains")] [string] $EntityNameContains, [Parameter(Mandatory = $false, ParameterSetName = "Default")] [Parameter(Mandatory = $false, ParameterSetName = "NameContains")] [Parameter(Mandatory = $true, ParameterSetName = "Query")] [string] $ODataQuery, [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Alias('Uri')] [Alias('AuthenticationUrl')] [string] $Url = $Script:ODataUrl, [string] $SystemUrl = $Script:ODataSystemUrl, [string] $ClientId = $Script:ODataClientId, [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException, [switch] $RawOutput, [switch] $OutNamesOnly, [switch] $OutputAsJson ) begin { if ([System.String]::IsNullOrEmpty($SystemUrl)) { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter was empty, using the Url parameter as the OData endpoint base address." -Target $SystemUrl $SystemUrl = $Url } if ([System.String]::IsNullOrEmpty($Url) -or [System.String]::IsNullOrEmpty($SystemUrl)) { $messageString = "It seems that you didn't supply a valid value for the Url parameter. You need specify the Url parameter or add a configuration with the <c='em'>Add-D365ODataConfig</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $Url BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms [System.UriBuilder] $odataEndpoint = $SystemUrl if ($odataEndpoint.Path -eq "/") { $odataEndpoint.Path = "metadata/PublicEntities" } else { $odataEndpoint.Path += "/metadata/PublicEntities" } } process { if (Test-PSFFunctionInterrupt) { return } Invoke-TimeSignal -Start $odataEndpoint.Query = "" if (-not ([string]::IsNullOrEmpty($EntityName))) { Write-PSFMessage -Level Verbose -Message "Building request for the Metadata OData endpoint for entity named: $EntityName." -Target $EntityName $searchEntityName = $EntityName $odataEndpoint.Query = "`$filter=(tolower(Name) eq tolower('$EntityName') or tolower(EntitySetName) eq tolower('$EntityName'))" } elseif (-not ([string]::IsNullOrEmpty($EntityNameContains))) { Write-PSFMessage -Level Verbose -Message "Building request for the Metadata OData endpoint for entity that contains: $EntityNameContains." -Target $EntityNameContains $searchEntityName = $EntityNameContains $odataEndpoint.Query = "`$filter=(contains(tolower(Name), tolower('$EntityNameContains')) or contains(tolower(EntitySetName), tolower('$EntityNameContains')))" } if (-not ([string]::IsNullOrEmpty($ODataQuery))) { $odataEndpoint.Query = $($odataEndpoint.Query + "$ODataQuery").Replace("?", "") } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the Metadata OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) $res = Invoke-RestMethod -Method Get -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' if (-not ($RawOutput)) { $res = $res.Value | Sort-Object -Property Name if ($OutNamesOnly) { $res = $res | Select-PSFObject "Name as DataEntityName", "EntitySetName as EntityName" } } if ($OutputAsJson) { $res | ConvertTo-Json -Depth 10 } else { $res } } catch { $messageString = "Something went wrong while searching the Metadata OData endpoint for the entity: $searchEntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# .SYNOPSIS Import a DMF package into Dynamics 365 Finance & Operations .DESCRIPTION Imports a DMF package into the DMF endpoint of the Dynamics 365 Finance & Operations .PARAMETER Path Path of the file that you want to import into D365FO .PARAMETER JobId JobId of the DMF job you want to import into .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through DMF .PARAMETER Url URL / URI for the D365FO environment you want to access through DMF .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Import-D365DmfPackage -Path "c:\temp\d365fo.tools\dmfpackage.zip" -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" This will import a package into the 123456789 job through the DMF endpoint. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the location to read the file from. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> Import-D365DmfPackage -Path "c:\temp\d365fo.tools\dmfpackage.zip" -JobId "db5e719a-8db3-4fe5-9c78-7be479ce85a2" -Tenant "e674da86-7ee5-40a7-b777-1111111111111" -Url "https://usnconeboxax1aos.cloud.onebox.dynamics.com" -ClientId "dea8d7a9-1602-4429-b138-111111111111" -ClientSecret "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" This will import a package into the 123456789 job through the DMF endpoint. It will use "c:\temp\d365fo.tools\dmfpackage.zip" as the location to read the file from. It will use "db5e719a-8db3-4fe5-9c78-7be479ce85a2" as the jobid parameter passed to the DMF endpoint. It will use "e674da86-7ee5-40a7-b777-1111111111111" as the Azure Active Directory guid. It will use "https://usnconeboxax1aos.cloud.onebox.dynamics.com" as the base D365FO environment url. It will use "dea8d7a9-1602-4429-b138-111111111111" as the ClientId. It will use "Vja/VmdxaLOPR+alkjfsadffelkjlfw234522" as ClientSecret. .LINK Add-D365ODataConfig .LINK Get-D365ActiveODataConfig .LINK Get-D365DmfMessageStatus .LINK Set-D365ActiveODataConfig .NOTES Tags: Import, Upload, DMF, Package, Packages, JobId Author: Mötz Jensen (@Splaxi) #> function Import-D365DmfPackage { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [Alias('File')] [string] $Path, [Parameter(Mandatory = $true)] [String] $JobId, [Parameter(Mandatory = $false)] [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Parameter(Mandatory = $false)] [Alias('URI')] [string] $Url = $Script:ODataUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException ) begin { $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms } process { Invoke-TimeSignal -Start $dmfParms = @{ JobId = $JobId Url = $Url AuthenticationToken = $bearer Path = $Path } $dmfDetails = Invoke-DmfEnqueuePackage @dmfParms -EnableException:$EnableException if ([string]::IsNullOrWhiteSpace($dmfDetails)) { Write-PSFMessage -Level Verbose -Message "Output object is null" -Target $Var } [PSCustomObject]@{ MessageId = $dmfDetails.Replace('"', '') } Invoke-TimeSignal -End } } <# .SYNOPSIS Import a Data Entity into Dynamics 365 Finance & Operations .DESCRIPTION Imports a Data Entity, defined as a json payload, using the OData endpoint of the Dynamics 365 Finance & Operations platform .PARAMETER EntityName Name of the Data Entity you want to work against The parameter is Case Sensitive, because the OData endpoint in D365FO is Case Sensitive Remember that most Data Entities in a D365FO environment is named by its singular name, but most be retrieve using the plural name E.g. The version 3 of the customers Data Entity is named CustomerV3, but can only be retrieving using CustomersV3 Look at the Get-D365ODataPublicEntity cmdlet to help you obtain the correct name .PARAMETER Payload The entire string contain the json object that you want to import into the D365FO environment Remember that json is text based and can use either single quotes (') or double quotes (") as the text qualifier, so you might need to escape the different quotes in your payload before passing it in .PARAMETER CrossCompany Instruct the cmdlet / function to ensure the request against the OData endpoint will work across all companies .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Import-D365ODataEntity -EntityName "ExchangeRates" -Payload '{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' This will import a Data Entity into Dynamics 365 Finance & Operations using the OData endpoint. The EntityName used for the import is ExchangeRates. The Payload is a valid json string, containing all the needed properties. .EXAMPLE PS C:\> $Payload = '{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' PS C:\> Import-D365ODataEntity -EntityName "ExchangeRates" -Payload $Payload This will import a Data Entity into Dynamics 365 Finance & Operations using the OData endpoint. First the desired json data is put into the $Payload variable. The EntityName used for the import is ExchangeRates. The $Payload variable is passed to the cmdlet. .NOTES Tags: OData, Data, Entity, Import, Upload Author: Mötz Jensen (@Splaxi) #> function Import-D365ODataEntity { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [string] $EntityName, [Parameter(Mandatory = $true)] [Alias('Json')] [string] $Payload, [switch] $CrossCompany, [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Alias('Uri')] [Alias('AuthenticationUrl')] [string] $Url = $Script:ODataUrl, [string] $SystemUrl = $Script:ODataSystemUrl, [string] $ClientId = $Script:ODataClientId, [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException ) begin { if ([System.String]::IsNullOrEmpty($SystemUrl)) { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter was empty, using the Url parameter as the OData endpoint base address." -Target $SystemUrl $SystemUrl = $Url } if ([System.String]::IsNullOrEmpty($Url) -or [System.String]::IsNullOrEmpty($SystemUrl)) { $messageString = "It seems that you didn't supply a valid value for the Url parameter. You need specify the Url parameter or add a configuration with the <c='em'>Add-D365ODataConfig</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $Url BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms } process { if (Test-PSFFunctionInterrupt) { return } Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for the OData endpoint for entity named: $EntityName." -Target $EntityName [System.UriBuilder] $odataEndpoint = $SystemUrl if ($odataEndpoint.Path -eq "/") { $odataEndpoint.Path = "data/$EntityName($Key)" } else { $odataEndpoint.Path += "/data/$EntityName($Key)" } if ($CrossCompany) { $odataEndpoint.Query = "cross-company=true" } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) Invoke-RestMethod -Method POST -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' -Body $Payload } catch { $messageString = "Something went wrong while importing data through the OData endpoint for the entity: $EntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# .SYNOPSIS Import a set of Data Entities into Dynamics 365 Finance & Operations .DESCRIPTION Imports a set of Data Entities, defined as a json payloads, using the OData endpoint of the Dynamics 365 Finance & Operations The entire payload will be batched into a single request against the OData endpoint .PARAMETER EntityName Name of the Data Entity you want to work against The parameter is Case Sensitive, because the OData endpoint in D365FO is Case Sensitive Remember that most Data Entities in a D365FO environment is named by its singular name, but most be retrieve using the plural name E.g. The version 3 of the customers Data Entity is named CustomerV3, but can only be retrieving using CustomersV3 Look at the Get-D365ODataPublicEntity cmdlet to help you obtain the correct name .PARAMETER Payload The entire string contain the json objects that you want to import into the D365FO environment Payload supports multiple json objects, that needs to be batched together .PARAMETER CrossCompany Instruct the cmdlet / function to ensure the request against the OData endpoint will work across all companies .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER RawOutput Instructs the cmdlet to output the raw json string directly .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Import-D365ODataEntityBatchMode -EntityName "ExchangeRates" -Payload '{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}','{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-04T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' This will import a set of Data Entities into Dynamics 365 Finance & Operations using the OData endpoint. The EntityName used for the import is ExchangeRates. The Payload is an array containing valid json strings, each containing all the needed properties. .EXAMPLE PS C:\> $Payload = '{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}','{"@odata.type" :"Microsoft.Dynamics.DataEntities.ExchangeRate", "RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-04T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' PS C:\> Import-D365ODataEntityBatchMode -EntityName "ExchangeRates" -Payload $Payload This will import a set of Data Entities into Dynamics 365 Finance & Operations using the OData endpoint. First the desired json data is put into the $Payload variable. The EntityName used for the import is ExchangeRates. The $Payload variable is passed to the cmdlet. .NOTES Tags: OData, Data, Entity, Import, Upload Author: Mötz Jensen (@Splaxi) #> function Import-D365ODataEntityBatchMode { [CmdletBinding()] [OutputType('System.String')] param ( [Parameter(Mandatory = $true)] [string] $EntityName, [Parameter(Mandatory = $true)] [Alias('Json')] [string[]] $Payload, [Parameter(Mandatory = $false)] [switch] $CrossCompany, [Parameter(Mandatory = $false)] [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Parameter(Mandatory = $false)] [Alias('URI')] [string] $URL = $Script:ODataUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $RawOutput, [switch] $EnableException ) begin { $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $URL BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms $dataBuilder = [System.Text.StringBuilder]::new() } process { Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building batch request for the OData endpoint for entity named: $EntityName." -Target $EntityName $idbatch = $(New-Guid).ToString() $idchangeset = $(New-Guid).ToString() $batchPayload = "--batch_$idbatch" $changesetPayload = "--changeset_$idchangeset" $request = [System.Net.WebRequest]::Create("$URL/data/`$batch") $request.Headers["Authorization"] = $headers.Authorization $request.Method = "POST" $request.ContentType = "multipart/mixed; boundary=batch_$idBatch" $dataBuilder.Clear() $null = $dataBuilder.AppendLine("--$batchPayLoad ") #Space is important! $null = $dataBuilder.AppendLine("Content-Type: multipart/mixed; boundary=changeset_$idchangeset {0}" -f [System.Environment]::NewLine) $null = $dataBuilder.AppendLine("$changeSetPayLoad ") #Space is important! $localEntity = $EntityName $payLoadEnumerator = $PayLoad.GetEnumerator() $counter = 0 while ($payLoadEnumerator.MoveNext()) { Write-PSFMessage -Level Verbose -Message "Parsing the payload for the batch request." $counter ++ $localPayload = $payLoadEnumerator.Current.Trim() $null = $dataBuilder.Append((New-BatchContent -Url "$URL/data/$localEntity" -AuthenticationToken $bearer -Payload $LocalPayload -Count $counter)) if ($PayLoad.Count -eq $counter) { $null = $dataBuilder.AppendLine("$changesetPayload--") } else { $null = $dataBuilder.AppendLine("$changesetPayload") } } $null = $dataBuilder.Append("$batchPayload--") $data = $dataBuilder.ToString() Write-PSFMessage -Level Debug -Message "Parsing data to debug log next." Write-PSFMessage -Level Debug -Message $data Add-WebRequestContent -WebRequest $request -Payload $data try { Write-PSFMessage -Level Verbose -Message "Executing batch http request against the OData endpoint." $response = $request.GetResponse() } catch { $messageString = "Something went wrong while importing batch data through the OData endpoint for the entity: $EntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } #Might need to be something else than OK and Created if ($response.StatusCode -ne [System.Net.HttpStatusCode]::Ok -and $response.StatusCode -ne [System.Net.HttpStatusCode]::Created) { Write-PSFMessage -Level Verbose -Message "Status code not 'Ok' and not 'Created', Description $($response.StatusDescription)" Stop-PSFFunction -Message "Stopping" -Exception $([System.Exception]::new("Returned status code indicates that the request was unsuccessful.")) return } $stream = $response.GetResponseStream() $streamReader = New-Object System.IO.StreamReader($stream) $res = $streamReader.ReadToEnd() $streamReader.Close(); if ($RawOutput) { $res } else { } Invoke-TimeSignal -End } } <# .SYNOPSIS Invoke a REST Endpoint in Dynamics 365 Finance & Operations .DESCRIPTION Invokce any REST Endpoint available in a Dynamics 365 Finance & Operations environment It can be REST endpoints that are available out of the box or custom REST endpoints based on X++ classesrations platform .PARAMETER ServiceName The "name" of the REST endpoint that you want to invoke The REST endpoints consists of the following elementes: ServiceGroupName/ServiceName/MethodName E.g. "UserSessionService/AifUserSessionService/GetUserSessionInfo" .PARAMETER Payload The entire string contain the json object that you want to pass to the REST endpoint If the payload parameter is NOT null, it will trigger a HTTP POST action against the URL. But if the payload is null, it will trigger a HTTP GET action against the URL. Remember that json is text based and can use either single quotes (') or double quotes (") as the text qualifier, so you might need to escape the different quotes in your payload before passing it in .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through REST endpoint .PARAMETER Url URL / URI for the D365FO environment you want to access through REST endpoint .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Invoke-D365RestEndpoint -ServiceName "UserSessionService/AifUserSessionService/GetUserSessionInfo" -Payload "{"RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}" This will invoke the REST endpoint in the Dynamics 365 Finance & Operations environment. The ServiceName used for the import is "UserSessionService/AifUserSessionService/GetUserSessionInfo". The Payload is a valid json string, containing all the needed properties. .EXAMPLE PS C:\> $Payload = '{"RateTypeName": "TEST", "FromCurrency": "DKK", "ToCurrency": "EUR", "StartDate": "2019-01-03T00:00:00Z", "Rate": 745.10, "ConversionFactor": "Hundred", "RateTypeDescription": "TEST"}' PS C:\> Invoke-D365RestEndpoint -ServiceName "UserSessionService/AifUserSessionService/GetUserSessionInfo" -Payload $Payload This will invoke the REST endpoint in the Dynamics 365 Finance & Operations environment. First the desired json data is put into the $Payload variable. The ServiceName used for the import is "UserSessionService/AifUserSessionService/GetUserSessionInfo". The $Payload variable is passed to the cmdlet. .NOTES Tags: REST, Endpoint, Custom Service, Services Author: Mötz Jensen (@Splaxi) #> function Invoke-D365RestEndpoint { [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [string] $ServiceName, [Alias('Json')] [string] $Payload, [Parameter(Mandatory = $false)] [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Parameter(Mandatory = $false)] [Alias('URI')] [string] $URL = $Script:ODataUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException ) begin { $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $URL BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms } process { Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for the REST endpoint for the service: $ServiceName." -Target $ServiceName [System.UriBuilder] $restEndpoint = $URL $restEndpoint.Path = "api/services/$ServiceName" $params = @{ } $params.Uri = $restEndpoint.Uri.AbsoluteUri $params.Headers = $headers $params.ContentType = "application/json" if ($null -ne $Payload) { $params.Method = "POST" $params.Body = $Payload } else { $params.Method = "GET" } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the REST endpoint." -Target $($restEndpoint.Uri.AbsoluteUri) Invoke-RestMethod @params } catch { $messageString = "Something went wrong while importing data through the REST endpoint for the entity: $ServiceName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $ServiceName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# .SYNOPSIS Remove a Data Entity from Dynamics 365 Finance & Operations .DESCRIPTION Removes a Data Entity, defined by the EntityKey, using the OData endpoint of the Dynamics 365 Finance & Operations .PARAMETER EntityName Name of the Data Entity you want to work against The parameter is Case Sensitive, because the OData endpoint in D365FO is Case Sensitive Remember that most Data Entities in a D365FO environment is named by its singular name, but most be retrieve using the plural name E.g. The version 3 of the customers Data Entity is named CustomerV3, but can only be retrieving using CustomersV3 Look at the Get-D365ODataPublicEntity cmdlet to help you obtain the correct name .PARAMETER Key The key that will select the desired Data Entity uniquely across the OData endpoint The key would most likely be made up from multiple values, but can also be a single value .PARAMETER CrossCompany Instruct the cmdlet / function to ensure the request against the OData endpoint will work across all companies .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Remove-D365ODataEntity -EntityName ExchangeRates -Key "RateTypeName='TEST',FromCurrency='DKK',ToCurrency='EUR',StartDate=2019-01-13T12:00:00Z" This will remove a Data Entity from the D365FO environment through OData. It will use the ExchangeRate entity, and its EntitySetName / CollectionName "ExchangeRates". It will use the "RateTypeName='TEST',FromCurrency='DKK',ToCurrency='EUR',StartDate=2019-01-13T12:00:00Z" as the unique key for the entity. It will use the default OData configuration details that are stored in the configuration store. .NOTES Tags: OData, Data, Entity, Import, Upload Author: Mötz Jensen (@Splaxi) #> function Remove-D365ODataEntity { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [string] $EntityName, [Parameter(Mandatory = $true)] [string] $Key, [Parameter(Mandatory = $false)] [switch] $CrossCompany, [Parameter(Mandatory = $false)] [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Parameter(Mandatory = $false)] [Alias('URI')] [string] $URL = $Script:ODataUrl, [string] $SystemUrl = $Script:ODataSystemUrl, [Parameter(Mandatory = $false)] [string] $ClientId = $Script:ODataClientId, [Parameter(Mandatory = $false)] [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException ) begin { if ([System.String]::IsNullOrEmpty($SystemUrl)) { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter was empty, using the Url parameter as the OData endpoint base address." -Target $SystemUrl $SystemUrl = $Url } if ([System.String]::IsNullOrEmpty($Url) -or [System.String]::IsNullOrEmpty($SystemUrl)) { $messageString = "It seems that you didn't supply a valid value for the Url parameter. You need specify the Url parameter or add a configuration with the <c='em'>Add-D365ODataConfig</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $Url BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms } process { Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for removing data entity through the OData endpoint for entity named: $EntityName." -Target $EntityName [System.UriBuilder] $odataEndpoint = $SystemUrl if ($odataEndpoint.Path -eq "/") { $odataEndpoint.Path = "data/$EntityName($Key)" } else { $odataEndpoint.Path += "/data/$EntityName($Key)" } if ($CrossCompany) { $odataEndpoint.Query = $($odataEndpoint.Query + "&cross-company=true").Replace("?", "") } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) $null = Invoke-RestMethod -Method DELETE -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' } catch { $messageString = $((ConvertFrom-Json $_).Error.InnerError | ConvertTo-Json -Depth 10) Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($messageString)) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# .SYNOPSIS Set the active OData configuration .DESCRIPTION Updates the current active OData configuration with a new one .PARAMETER Name Name of the OData configuration you want to load into the active OData configuration .PARAMETER Temporary Instruct the cmdlet to only temporarily override the persisted settings in the configuration store .EXAMPLE PS C:\> Set-D365ActiveODataConfig -Name "UAT" This will set the OData configuration named "UAT" as the active configuration. .NOTES Tags: Environment, Config, Configuration, ClientId, ClientSecret Author: Mötz Jensen (@Splaxi) #> function Set-D365ActiveODataConfig { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true, Position = 1)] [string] $Name, [switch] $Temporary ) if($Name -match '\*') { $messageString = "The name cannot contain <c='em'>wildcard character</c>." Write-PSFMessage -Level Host -Message $messageString Stop-PSFFunction -Message "Stopping because the name contains wildcard character." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>',''))) return } if (-not ((Get-PSFConfig -FullName "d365fo.integrations.odata.*.name").Value -contains $Name)) { $messageString = "An OData configuration with that name <c='em'>doesn't exists</c>." Write-PSFMessage -Level Host -Message $messageString Stop-PSFFunction -Message "Stopping because an OData message configuration with that name doesn't exists." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>',''))) return } Set-PSFConfig -FullName "d365fo.integrations.active.odata.config.name" -Value $Name if (-not $Temporary) { Register-PSFConfig -FullName "d365fo.integrations.active.odata.config.name" -Scope UserDefault } Update-ODataVariables } <# .SYNOPSIS Update a Data Entity in Dynamics 365 Finance & Operations .DESCRIPTION Updates a Data Entity, defined as a json payload, using the OData endpoint of the Dynamics 365 Finance & Operations platform .PARAMETER EntityName Name of the Data Entity you want to work against The parameter is Case Sensitive, because the OData endpoint in D365FO is Case Sensitive Remember that most Data Entities in a D365FO environment is named by its singular name, but most be retrieve using the plural name E.g. The version 3 of the customers Data Entity is named CustomerV3, but can only be retrieving using CustomersV3 Look at the Get-D365ODataPublicEntity cmdlet to help you obtain the correct name .PARAMETER Key The key that will select the desired Data Entity uniquely across the OData endpoint The key would most likely be made up from multiple values, but can also be a single value .PARAMETER Payload The entire string contain the json object that you want to import into the D365FO environment Remember that json is text based and can use either single quotes (') or double quotes (") as the text qualifier, so you might need to escape the different quotes in your payload before passing it in .PARAMETER CrossCompany Instruct the cmdlet / function to ensure the request against the OData endpoint will search across all companies .PARAMETER Tenant Azure Active Directory (AAD) tenant id (Guid) that the D365FO environment is connected to, that you want to access through OData .PARAMETER Url URL / URI for the D365FO environment you want to access through OData If you are working against a D365FO instance, it will be the URL / URI for the instance itself If you are working against a D365 Talent / HR instance, this will have to be "http://hr.talent.dynamics.com" .PARAMETER SystemUrl URL / URI for the D365FO instance where the OData endpoint is available If you are working against a D365FO instance, it will be the URL / URI for the instance itself, which is the same as the Url parameter value If you are working against a D365 Talent / HR instance, this will to be full instance URL / URI like "https://aos-rts-sf-b1b468164ee-prod-northeurope.hr.talent.dynamics.com/namespaces/0ab49d18-6325-4597-97b3-c7f2321aa80c" .PARAMETER ClientId The ClientId obtained from the Azure Portal when you created a Registered Application .PARAMETER ClientSecret The ClientSecret obtained from the Azure Portal when you created a Registered Application .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions This is less user friendly, but allows catching exceptions in calling scripts .EXAMPLE PS C:\> Update-D365ODataEntity -EntityName "CustomersV3" -Key "dataAreaId='DAT',CustomerAccount='123456789'" -Payload '{"NameAlias": "CustomerA"}' -CrossCompany This will update a Data Entity in Dynamics 365 Finance & Operations using the OData endpoint. The EntityName used for the update is "CustomersV3". It will use the "dataAreaId='DAT',CustomerAccount='123456789'" as key to identify the unique Customer record. The Payload is a valid json string, containing the needed properties that we want to update. It will make sure to search across all legal entities / companies inside the D365FO environment. It will use the default OData configuration details that are stored in the configuration store. .EXAMPLE PS C:\> $Payload = '{"NameAlias": "CustomerA"}' PS C:\> Update-D365ODataEntity -EntityName "accounts" -Key "dataAreaId='DAT',CustomerAccount='123456789'" -Payload $Payload This will update a Data Entity in Dynamics 365 Finance & Operations using the OData endpoint. First the desired json data is put into the $Payload variable. The EntityName used for the update is "CustomersV3". It will use the "dataAreaId='DAT',CustomerAccount='123456789'" as key to identify the unique Customer record. The $Payload variable is passed to the cmdlet. It will NOT look across companies. It will use the default OData configuration details that are stored in the configuration store. .NOTES Tags: OData, Data, Entity, Update, Upload Author: Mötz Jensen (@Splaxi) .LINK Add-D365ODataConfig .LINK Get-D365ActiveODataConfig .LINK Set-D365ActiveODataConfig #> function Update-D365ODataEntity { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] [OutputType()] param ( [Parameter(Mandatory = $true)] [string] $EntityName, [Parameter(Mandatory = $true)] [string] $Key, [Parameter(Mandatory = $true)] [Alias('Json')] [string] $Payload, [switch] $CrossCompany, [Alias('$AADGuid')] [string] $Tenant = $Script:ODataTenant, [Alias('Uri')] [Alias('AuthenticationUrl')] [string] $Url = $Script:ODataUrl, [string] $SystemUrl = $Script:ODataSystemUrl, [string] $ClientId = $Script:ODataClientId, [string] $ClientSecret = $Script:ODataClientSecret, [switch] $EnableException ) begin { if ([System.String]::IsNullOrEmpty($SystemUrl)) { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter was empty, using the Url parameter as the OData endpoint base address." -Target $SystemUrl $SystemUrl = $Url } if ([System.String]::IsNullOrEmpty($Url) -or [System.String]::IsNullOrEmpty($SystemUrl)) { $messageString = "It seems that you didn't supply a valid value for the Url parameter. You need specify the Url parameter or add a configuration with the <c='em'>Add-D365ODataConfig</c> cmdlet." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $entityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } if ($Url.Substring($Url.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The Url parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $Url = $Url.Substring(0, $Url.Length - 1) } if ($SystemUrl.Substring($SystemUrl.Length - 1) -eq "/") { Write-PSFMessage -Level Verbose -Message "The SystemUrl parameter had a tailing slash, which shouldn't be there. Removing the tailling slash." -Target $Url $SystemUrl = $SystemUrl.Substring(0, $SystemUrl.Length - 1) } $bearerParms = @{ Url = $Url ClientId = $ClientId ClientSecret = $ClientSecret Tenant = $Tenant } $bearer = New-BearerToken @bearerParms $headerParms = @{ URL = $Url BearerToken = $bearer } $headers = New-AuthorizationHeaderBearerToken @headerParms } process { if (Test-PSFFunctionInterrupt) { return } Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Building request for the OData endpoint for entity named: $EntityName." -Target $EntityName [System.UriBuilder] $odataEndpoint = $SystemUrl if ($odataEndpoint.Path -eq "/") { $odataEndpoint.Path = "data/$EntityName($Key)" } else { $odataEndpoint.Path += "/data/$EntityName($Key)" } if ($CrossCompany) { $odataEndpoint.Query = "cross-company=true" } try { Write-PSFMessage -Level Verbose -Message "Executing http request against the OData endpoint." -Target $($odataEndpoint.Uri.AbsoluteUri) Invoke-RestMethod -Method Patch -Uri $odataEndpoint.Uri.AbsoluteUri -Headers $headers -ContentType 'application/json' -Body $Payload } catch [System.Net.WebException] { $webException = $_.Exception if(($webException.Status -eq [System.Net.WebExceptionStatus]::ProtocolError) -and (-not($null -eq $webException.Response))) { $resp = [System.Net.HttpWebResponse]$webException.Response if($resp.StatusCode -eq [System.Net.HttpStatusCode]::NotFound){ $messageString = "It seems that the OData endpoint was unable to locate the desired entity: $EntityName, based on the key: <c='em'>$key</c>. Please make sure that the key is <c='em'>valid</c> or try using the <c='em'>-CrossCompany</c> parameter." Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of HTTP error 404." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } else { $messageString = "Something went wrong while updating the data entity through the OData endpoint for the entity: $EntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } } } catch { $messageString = "Something went wrong while updating the data entity through the OData endpoint for the entity: $EntityName" Write-PSFMessage -Level Host -Message $messageString -Exception $PSItem.Exception -Target $EntityName Stop-PSFFunction -Message "Stopping because of errors." -Exception $([System.Exception]::new($($messageString -replace '<[^>]+>', ''))) -ErrorRecord $_ return } Invoke-TimeSignal -End } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'd365fo.integrations' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'd365fo.integrations' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'd365fo.integrations' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." Set-PSFConfig -FullName "d365fo.integrations.azure.tenant.oauth.token" -Value "https://login.microsoftonline.com/{0}/oauth2/token" -Initialize -Description "URI / URL for the Azure Active Directory OAuth 2.0 endpoint for tokens, prepped for the tenant value to be inserted." Set-PSFConfig -FullName "d365fo.integrations.dmf.download.retries" -Value 5 -Initialize -Description "Retry counter for how many times the module should try to download a given file from the DMF Package endpoint." <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'd365fo.integrations.ScriptBlockName' -Scriptblock { } #> <# # Example: Register-PSFTeppScriptblock -Name "d365fo.integrations.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name d365fo.integrations.alcohol #> New-PSFLicense -Product 'd365fo.integrations' -Manufacturer 'Motz' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2019-05-16") -Text @" Copyright (c) 2019 Motz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ Update-ODataVariables Update-PsfConfigVariables #endregion Load compiled code |