internal/functions/start-lcsdatabaseexport.ps1
|
<# .SYNOPSIS Start a database export from an environment .DESCRIPTION Start a database export from an environment from a LCS project .PARAMETER BearerToken The token you want to use when working against the LCS api .PARAMETER ProjectId The project id for the Dynamics 365 for Finance & Operations project inside LCS .PARAMETER SourceEnvironmentId The unique id of the environment that you want to use as the source for the database export The Id can be located inside the LCS portal .PARAMETER BackupName Name of the backup file when it is being exported from the environment The file shouldn't contain any extension at all, just the desired file name .PARAMETER LcsApiUri URI / URL to the LCS API you want to use Depending on whether your LCS project is located in europe or not, there is 2 valid URI's / URL's Valid options: "https://lcsapi.lcs.dynamics.com" "https://lcsapi.eu.lcs.dynamics.com" .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:\> Start-LcsDatabaseExport -ProjectId 123456789 -SourceEnvironmentId "958ae597-f089-4811-abbd-c1190917eaae" -BackupName "BackupViaApi" -BearerToken "JldjfafLJdfjlfsalfd..." -LcsApiUri "https://lcsapi.lcs.dynamics.com" This will start the database export from the Source environment. The LCS project is identified by the ProjectId 123456789, which can be obtained in the LCS portal. The source environment is identified by the SourceEnvironmentId "958ae597-f089-4811-abbd-c1190917eaae", which can be obtained in the LCS portal. The backup name is identified by the BackupName "BackupViaApi", which instructs the API to save the backup with that filename. The request will authenticate with the BearerToken "JldjfafLJdfjlfsalfd...". The http request will be going to the LcsApiUri "https://lcsapi.lcs.dynamics.com" (NON-EUROPE). .LINK Get-LcsDatabaseOperationStatus .NOTES Tags: Environment, Config, Configuration, LCS, Database backup, Api, Backup, Bacpac Author: Mötz Jensen (@Splaxi) #> function Start-LcsDatabaseExport { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [Cmdletbinding()] param( [Parameter(Mandatory = $true)] [int] $ProjectId, [Parameter(Mandatory = $true)] [Alias('Token')] [string] $BearerToken, [Parameter(Mandatory = $true)] [string] $SourceEnvironmentId, [Parameter(Mandatory = $true)] [string] $BackupName, [Parameter(Mandatory = $true)] [string] $LcsApiUri, [switch] $EnableException ) Invoke-TimeSignal -Start Write-PSFMessage -Level Verbose -Message "Json payload for LCS generated." -Target $jsonFile $client = New-Object -TypeName System.Net.Http.HttpClient $client.DefaultRequestHeaders.Clear() $client.DefaultRequestHeaders.UserAgent.ParseAdd("d365fo.tools via PowerShell") $deployUri = "$LcsApiUri/databasemovement/v1/export/project/$($ProjectId)/environment/$($SourceEnvironmentId)/backupName/$($BackupName)" $request = New-JsonRequest -Uri $deployUri -Token $BearerToken -HttpMethod "POST" try { Write-PSFMessage -Level Verbose -Message "Invoke LCS request: $($request.RequestUri)" -Target $request.RequestUri $result = Get-AsyncResult -task $client.SendAsync($request) Write-PSFMessage -Level Verbose -Message "Extracting the response received from LCS." $responseString = Get-AsyncResult -task $result.Content.ReadAsStringAsync() Write-PSFMessage -Level Verbose -Message "Parsing the response string into a json object." -Target $responseString try { $exportJob = ConvertFrom-Json -InputObject $responseString -ErrorAction SilentlyContinue } catch { Write-PSFMessage -Level Critical -Message "$responseString" } Write-PSFMessage -Level Verbose -Message "Extracting the response received from LCS." -Target $exportJob if (-not ($result.StatusCode -eq [System.Net.HttpStatusCode]::OK)) { if (($exportJob) -and ($exportJob.ErrorMessage)) { $errorText = "" if ($exportJob.OperationActivityId) { $errorText = "Error in request for database refresh of environment: '$( $exportJob.ErrorMessage)' (Activity Id: '$( $exportJob.OperationActivityId)')" } else { $errorText = "Error in request for database refresh of environment: '$( $exportJob.ErrorMessage)'" } } elseif ($exportJob.OperationActivityId) { $errorText = "API Call returned $($result.StatusCode): $($result.ReasonPhrase) (Activity Id: '$($exportJob.OperationActivityId)')" } else { $errorText = "API Call returned $($result.StatusCode): $($result.ReasonPhrase)" } Write-PSFMessage -Level Host -Message "Error performing database refresh of environment." -Target $($exportJob.ErrorMessage) Write-PSFMessage -Level Host -Message $errorText -Target $($result.ReasonPhrase) Stop-PSFFunction -Message "Stopping because of errors" -StepsUpward 1 } if (-not ($exportJob.IsSuccess)) { if ( $exportJob.ErrorMessage) { $errorText = "Error in request for database refresh of environment: '$( $exportJob.ErrorMessage)' (Activity Id: '$( $exportJob.OperationActivityId)')" } elseif ( $exportJob.OperationActivityId) { $errorText = "Error in request for database refresh of environment. Activity Id: '$($activity.OperationActivityId)'" } else { $errorText = "Unknown error in request for database refresh." } Write-PSFMessage -Level Host -Message "Unknown error requesting database refresh." -Target $exportJob Write-PSFMessage -Level Host -Message $errorText -Target $($result.ReasonPhrase) Stop-PSFFunction -Message "Stopping because of errors" -StepsUpward 1 } } catch { Write-PSFMessage -Level Host -Message "Something went wrong while working against the LCS API." -Exception $PSItem.Exception Stop-PSFFunction -Message "Stopping because of errors" -StepsUpward 1 return } Invoke-TimeSignal -End $exportJob } |