AppSource/Invoke-IngestionAPI.ps1
|
<#
.Synopsis Invoke a HTTP GET to receive a collection of objects from the Ingestion API This function handles paging and always returns the full array .Description Returns an array of PSCustomObjects with properties from the Objects received .Parameter authContext Authentication Context from New-BcAuthContext .Parameter path Ingestion API path as described on Swagger doc (https://ingestionapi-swagger.azureedge.net/) .Parameter headers Optional. Hashtable with additional headers for the request .Parameter query Optional. Query parameters for the invoke .Parameter silent Include this switch if you do not want the method to display URLs etc. .Example @(Invoke-IngestionApiGetCollection -authContext $authContext -path "/products") GET https://api.partner.microsoft.com/v1.0/ingestion/products resourceType : AzureDynamics365BusinessCentral name : C5 2012 Data Migration externalIDs : {@{type=AzureOfferId; value=c5-2012-data-migration}} isModularPublishing : True id : bc09759f-4d41-4d56-a57a-2f7e4cfad4a2 resourceType : AzureDynamics365BusinessCentral name : ELSTER VAT Localization for Germany externalIDs : {@{type=AzureOfferId; value=elster-vat-file-de}} isModularPublishing : True id : 29cb661d-ea77-4415-ac43-b0f7a90cd9b5 resourceType : AzureDynamics365BusinessCentral name : PayPal Payments Standard externalIDs : {@{type=AzureOfferId; value=fb310c16-0b22-4569-a5f0-8f9a01571cee}} isModularPublishing : True id : 193aec22-a99f-4024-8aba-c01ec540c0b7 ... #> function Invoke-IngestionApiGetCollection { Param( [Parameter(Mandatory=$true)] [HashTable] $authContext, [Parameter(Mandatory=$true)] [string] $path, [Parameter(Mandatory=$false)] [HashTable] $headers = @{}, [Parameter(Mandatory=$false)] [string] $query = '', [switch] $silent ) $telemetryScope = InitTelemetryScope -name $MyInvocation.InvocationName -parameterValues $PSBoundParameters -includeParameters @() try { $authContext = Renew-BcAuthContext -bcAuthContext $authContext $headers += @{ "Authorization" = "Bearer $($authcontext.AccessToken)" "Content-Type" = "application/json" } $uriBuilder = [UriBuilder]::new("https://api.partner.microsoft.com/v1.0/ingestion$path") $uriBuilder.Query = $query while ($uriBuilder) { if (!$silent) { Write-Host "GET $($uriBuilder.Uri.ToString())" } $ps = Invoke-RestMethod -UseBasicParsing -Uri $uriBuilder.Uri.ToString() -Headers $headers if ($ps.PSObject.Properties.Name -eq 'nextlink') { $uriBuilder = [UriBuilder]::new("https://api.partner.microsoft.com/$($ps.nextlink)") } else { $uriBuilder = $null } if ($ps.value) { $ps.value } } } catch { TrackException -telemetryScope $telemetryScope -errorRecord $_ throw } finally { TrackTrace -telemetryScope $telemetryScope } } <# .Synopsis Invoke a HTTP GET to receive a single object from the Ingestion API .Description Returns a PSCustomObject with properties from the Object received .Parameter authContext Authentication Context from New-BcAuthContext .Parameter path Ingestion API path as described on Swagger doc (https://ingestionapi-swagger.azureedge.net/) .Parameter headers Optional. Hashtable with additional headers for the request .Parameter query Optional. Query parameters for the invoke .Parameter silent Include this switch if you do not want the method to display URLs etc. .Example Invoke-IngestionApiGet -authContext $authContext -path "/products/5fbe0803-a545-4504-b41a-d9d158112360" GET https://api.partner.microsoft.com/v1.0/ingestion/products/5fbe0803-a545-4504-b41a-d9d158112360 resourceType : AzureDynamics365BusinessCentral name : BingMaps.AppSource externalIDs : {@{type=AzureOfferId; value=bingmapsintegration}} isModularPublishing : True id : 5fbe0803-a545-4504-b41a-d9d158112360 #> function Invoke-IngestionApiGet { Param( [Parameter(Mandatory=$true)] [HashTable] $authContext, [Parameter(Mandatory=$true)] [string] $path, [Parameter(Mandatory=$false)] [HashTable] $headers = @{}, [Parameter(Mandatory=$false)] [string] $query = '', [switch] $silent ) $telemetryScope = InitTelemetryScope -name $MyInvocation.InvocationName -parameterValues $PSBoundParameters -includeParameters @() try { if (!$silent) { Write-Host "GET https://api.partner.microsoft.com/v1.0/ingestion$path" } $authContext = Renew-BcAuthContext -bcAuthContext $authContext $headers += @{ "Authorization" = "Bearer $($authcontext.AccessToken)" "Content-Type" = "application/json" } $uriBuilder = [UriBuilder]::new("https://api.partner.microsoft.com/v1.0/ingestion$path") $uriBuilder.Query = $query Invoke-RestMethod -UseBasicParsing -Uri $uriBuilder.Uri.ToString() -Headers $headers } catch { TrackException -telemetryScope $telemetryScope -errorRecord $_ throw } finally { TrackTrace -telemetryScope $telemetryScope } } <# .Synopsis Invoke a HTTP POST to create a new object or run an action in the Ingestion API .Description Returns a PSCustomObject with properties from the newly created Object received .Parameter authContext Authentication Context from New-BcAuthContext .Parameter path Ingestion API path as described on Swagger doc (https://ingestionapi-swagger.azureedge.net/) .Parameter body Optional. HashTable with properties for the request .Parameter headers Optional. Hashtable with additional headers for the request .Parameter query Optional. Query parameters for the invoke .Parameter silent Include this switch if you do not want the method to display URLs etc. .Example Invoke-IngestionApiPost -authContext $authContext -path "/products/5fbe0803-a545-4504-b41a-d9d158112360/submissions/123456789/promote" .Example $packageUpload = Invoke-IngestionApiPost -authContext $authContext -path "/products/$productId/packages" -Body $body #> function Invoke-IngestionApiPost { Param( [Parameter(Mandatory=$true)] [HashTable] $authContext, [Parameter(Mandatory=$true)] [string] $path, [Parameter(Mandatory=$false)] [HashTable] $body = @{}, [Parameter(Mandatory=$false)] [HashTable] $headers = @{}, [Parameter(Mandatory=$false)] [string] $query = '', [switch] $silent ) $telemetryScope = InitTelemetryScope -name $MyInvocation.InvocationName -parameterValues $PSBoundParameters -includeParameters @() try { if (!$silent) { Write-Host "POST https://api.partner.microsoft.com/v1.0/ingestion$path" } $authContext = Renew-BcAuthContext -bcAuthContext $authContext $headers += @{ "Authorization" = "Bearer $($authcontext.AccessToken)" "Content-Type" = "application/json" } if (!$silent) { $body | ConvertTo-Json | Out-Host } $uriBuilder = [UriBuilder]::new("https://api.partner.microsoft.com/v1.0/ingestion$path") $uriBuilder.Query = $query Invoke-RestMethod -UseBasicParsing -Method Post -Uri $uriBuilder.Uri.ToString() -Headers $headers -Body ($body | ConvertTo-Json) } catch { TrackException -telemetryScope $telemetryScope -errorRecord $_ throw } finally { TrackTrace -telemetryScope $telemetryScope } } <# .Synopsis Invoke a HTTP PUT to modify a single object through the Ingestion API .Description Returns a PSCustomObject with properties from the modified Object .Parameter authContext Authentication Context from New-BcAuthContext .Parameter path Ingestion API path as described on Swagger doc (https://ingestionapi-swagger.azureedge.net/) .Parameter body Optional. HashTable with properties for the request (incl. an '@odata.etag' property) .Parameter headers Optional. Hashtable with additional headers for the request .Parameter query Optional. Query parameters for the invoke .Parameter silent Include this switch if you do not want the method to display URLs etc. .Example $packageUpload.state = "Uploaded" $packageUploaded = Invoke-IngestionApiPut -authContext $authContext -path "/products/$productId/packages/$($packageUpload.id)" -Body ($packageUpload | ConvertTo-HashTable) #> function Invoke-IngestionApiPut { Param( [Parameter(Mandatory=$true)] [HashTable] $authContext, [Parameter(Mandatory=$true)] [string] $path, [Parameter(Mandatory=$true)] [HashTable] $body, [Parameter(Mandatory=$false)] [HashTable] $headers = @{}, [Parameter(Mandatory=$false)] [string] $query, [switch] $silent ) $telemetryScope = InitTelemetryScope -name $MyInvocation.InvocationName -parameterValues $PSBoundParameters -includeParameters @() try { if (!$silent) { Write-Host "PUT https://api.partner.microsoft.com/v1.0/ingestion$path" $body | ConvertTo-Json | Out-Host } $authContext = Renew-BcAuthContext -bcAuthContext $authContext $headers += @{ "Authorization" = "Bearer $($authcontext.AccessToken)" "Content-Type" = "application/json" "If-Match" = $body.'@odata.etag' } $uriBuilder = [UriBuilder]::new("https://api.partner.microsoft.com/v1.0/ingestion$path") $uriBuilder.Query = $query Invoke-RestMethod -UseBasicParsing -Method Put -Uri $uriBuilder.Uri.ToString() -Headers $headers -Body ($body | ConvertTo-Json) } catch { TrackException -telemetryScope $telemetryScope -errorRecord $_ throw } finally { TrackTrace -telemetryScope $telemetryScope } } <# .Synopsis Invoke a HTTP DELETE to delete a single object through the Ingestion API Primary used to cancel an in progress validation .Description Returns a PSCustomObject with properties from the removed Object .Parameter authContext Authentication Context from New-BcAuthContext .Parameter path Ingestion API path as described on Swagger doc (https://ingestionapi-swagger.azureedge.net/) .Parameter headers Optional. Hashtable with additional headers for the request .Parameter query Optional. Query parameters for the invoke .Parameter silent Include this switch if you do not want the method to display URLs etc. .Example Invoke-IngestionApiDelete -authContext $authContext -path "/products/$productId/submissions/$($submission.id)" #> function Invoke-IngestionApiDelete { Param( [Parameter(Mandatory=$true)] [HashTable] $authContext, [Parameter(Mandatory=$true)] [string] $path, [Parameter(Mandatory=$false)] [HashTable] $headers = @{}, [Parameter(Mandatory=$false)] [string] $query = '', [switch] $silent ) $telemetryScope = InitTelemetryScope -name $MyInvocation.InvocationName -parameterValues $PSBoundParameters -includeParameters @() try { if (!$silent) { Write-Host "DELETE https://api.partner.microsoft.com/v1.0/ingestion$path" } $authContext = Renew-BcAuthContext -bcAuthContext $authContext $headers += @{ "Authorization" = "Bearer $($authcontext.AccessToken)" "Content-Type" = "application/json" } $uriBuilder = [UriBuilder]::new("https://api.partner.microsoft.com/v1.0/ingestion$path") $uriBuilder.Query = $query Invoke-RestMethod -UseBasicParsing -Method Delete -Uri $uriBuilder.Uri.ToString() -Headers $headers } catch { TrackException -telemetryScope $telemetryScope -errorRecord $_ throw } finally { TrackTrace -telemetryScope $telemetryScope } } Export-ModuleMember -Function Invoke-IngestionApiGet, Invoke-IngestionApiGetCollection, Invoke-IngestionApiPost, Invoke-IngestionApiPut, Invoke-IngestionApiDelete |