custom/generated/Get-JcSdkReportArtifactContent.ps1
|
<# .Synopsis Download a report by report ID and artifact ID .Description Download a report by report ID and artifact ID .Example Get-JcSdkReportArtifactContent -ArtifactId:(<string>) -ReportId:(<string>) .Example {{ Add code here }} .Inputs JumpCloud.SDK.DirectoryInsights.Models.IDirectoryInsightsApiIdentity .Outputs JumpCloud.SDK.DirectoryInsights.Models.IDictionaryOfany .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <IDirectoryInsightsApiIdentity>: [ArtifactId <String>]: Artifact ID [ReportId <String>]: Report ID [ReportType <String>]: Report Type .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/CUT-4981_v2EUSupport/SDKs/PowerShell/JumpCloud.SDK.DirectoryInsights/docs/exports/Get-JcSdkReportArtifactContent.md #> Function Get-JcSdkReportArtifactContent { [OutputType([JumpCloud.SDK.DirectoryInsights.Models.IDictionaryOfany])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] Param( [Parameter(Mandatory)] [JumpCloud.SDK.DirectoryInsights.Category('Uri')] [System.String] # Region for JumpCloud API host. # Use 'api' for US or 'api.eu' for EU. ${ApiHost}, [Parameter(ParameterSetName='Get', Mandatory)] [JumpCloud.SDK.DirectoryInsights.Category('Path')] [System.String] # Artifact ID ${ArtifactId}, [Parameter(ParameterSetName='Get', Mandatory)] [JumpCloud.SDK.DirectoryInsights.Category('Path')] [System.String] # Report ID ${ReportId}, [Parameter(ParameterSetName='GetViaIdentity', Mandatory, ValueFromPipeline)] [JumpCloud.SDK.DirectoryInsights.Category('Path')] [JumpCloud.SDK.DirectoryInsights.Models.IDirectoryInsightsApiIdentity] # Identity Parameter ${InputObject}, [Parameter(DontShow)] [JumpCloud.SDK.DirectoryInsights.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.DirectoryInsights.Category('Runtime')] [JumpCloud.SDK.DirectoryInsights.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.DirectoryInsights.Category('Runtime')] [JumpCloud.SDK.DirectoryInsights.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [JumpCloud.SDK.DirectoryInsights.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.DirectoryInsights.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [JumpCloud.SDK.DirectoryInsights.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) Begin { $Results = @() $PSBoundParameters.Add('HttpPipelineAppend', { param($req, $callback, $next) # call the next step in the Pipeline $ResponseTask = $next.SendAsync($req, $callback) $global:JCHttpRequest = $req $global:JCHttpRequestContent = If (-not [System.String]::IsNullOrEmpty($req.Content)) { $req.Content.ReadAsStringAsync() } $global:JCHttpResponse = $ResponseTask # $global:JCHttpResponseContent = If (-not [System.String]::IsNullOrEmpty($ResponseTask.Result.Content)) { $ResponseTask.Result.Content.ReadAsStringAsync() } Return $ResponseTask } ) } Process { $maxRetries = 4 $resultCounter = 0 :retryLoop do { $resultCounter++ $Result = JumpCloud.SDK.DirectoryInsights.internal\Get-JcSdkInternalReportArtifactContent @PSBoundParameters -errorAction SilentlyContinue -errorVariable sdkError If ($sdkError){ If ($resultCounter -eq $maxRetries){ throw $sdkError } If ($JCHttpResponse.Result.StatusCode -eq "503") { Write-Warning ("503: Service Unavailable - retrying in " + ($resultCounter * 5) + " seconds.") } else { throw $sdkError } } else { break retryLoop } Start-Sleep -Seconds ($resultCounter * 5) } while ($resultCounter -lt $maxRetries) Write-Debug ('HttpRequest: ' + $JCHttpRequest); Write-Debug ('HttpRequestContent: ' + $JCHttpRequestContent.Result); Write-Debug ('HttpResponse: ' + $JCHttpResponse.Result); # Write-Debug ('HttpResponseContent: ' + $JCHttpResponseContent.Result); If (-not [System.String]::IsNullOrEmpty($Result)) { $Results += $Result } } End { # Clean up global variables $GlobalVars = @('JCHttpRequest', 'JCHttpRequestContent', 'JCHttpResponse', 'JCHttpResponseContent') $GlobalVars | ForEach-Object { If ((Get-Variable -Scope:('Global')).Where( { $_.Name -eq $_ })) { Remove-Variable -Name:($_) -Scope:('Global') } } Return $Results } } |