Functions/BloxOne/BloxOneCloud/Receive-B1Export.ps1
|
function Receive-B1Export { <# .SYNOPSIS Retrieves a BloxOneDDI Export/Backup .DESCRIPTION This function is used to retrieve a BloxOneDDI Export/Backup .PARAMETER data_ref The data_ref provided by the Get-B1BulkOperation or Get-B1Export function. This accepts pipeline input. .PARAMETER filePath The local file path where the export should be saved to. .EXAMPLE PS> Receive-B1Export -data_ref (Get-B1BulkOperation -Name "Backup of all CSP data").data_ref -filePath "C:\Backups" .EXAMPLE PS> $ExportName = "B1-Export-$((Get-Date).ToString('dd-MM-yy hh-mm-ss'))" PS> Start-B1Export -Name $ExportName -BackupAll PS> while (($ExportJob = Get-B1Export -Name $ExportName -Strict).overall_status -ne "Completed") { Write-Host "Waiting for export to complete.." Wait-Event -Timeout 5 } PS> $ExportJob | Receive-B1Export -filePath "/tmp/$($ExportName)" .FUNCTIONALITY BloxOneDDI .FUNCTIONALITY Backup #> [CmdletBinding()] param( [Parameter( ValueFromPipelineByPropertyName = $true, Mandatory=$true )] [string]$data_ref, [Parameter(Mandatory=$true)] [string]$filePath ) process { $B1Export = Invoke-CSP -Method "GET" -Uri "$(Get-B1CSPUrl)/bulk/v1/storage?data_ref=$data_ref&direction=download" if ($B1Export.result.url) { $JSON = Invoke-RestMethod -Uri $B1Export.result.url if ($filePath | Test-Path -PathType Container) { $filePathSafe = "$($filePath)/$($data_ref.Split([IO.Path]::GetInvalidFileNameChars()) -join '_' -replace ' ','_')" } else { $filePathSafe = $filePath } $JSON.data | ConvertTo-Json -Depth 15 | Out-File $filePathSafe -Force -Encoding utf8 if (Test-Path $filePathSafe) { Write-Host "Export downloaded and saved to: $($filePathSafe)" -ForegroundColor Green } } } } |