feat: Add APIM context validation (#317)

* added apim context validation

* fix apimContext name

* Use Get-AzApiManagement to validate if the API Management instance exists

* removed tabs

Co-authored-by: Pim Simons <[email protected]>

src/Arcus.Scripting.ApiManagement/Scripts/Create-AzApiManagementApiOperation.ps1

@@ -10,6 +10,10 @@ param(
    [Parameter(Mandatory = $false)][string] $PolicyFilePath = ""
 )
 
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
 $apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 
 New-AzApiManagementOperation -Context $apimContext -ApiId $ApiId -OperationId $OperationId -Name $OperationName -Method $Method -UrlTemplate $UrlTemplate -Description $Description

src/Arcus.Scripting.ApiManagement/Scripts/Import-AzApiManagementApiPolicy.ps1

@@ -5,6 +5,10 @@ param(
    [Parameter(Mandatory = $true)][string] $policyFilePath
 )
 
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
 $apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 
 Write-Host "Updating policy of API '$ApiId'"

src/Arcus.Scripting.ApiManagement/Scripts/Import-AzApiManagementOperationPolicy.ps1

@@ -6,6 +6,10 @@ param(
     [Parameter(Mandatory = $true)][string] $PolicyFilePath
 )
 
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
 $apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 
 Write-Host "Updating policy of the operation '$OperationId' in API '$ApiId'"

src/Arcus.Scripting.ApiManagement/Scripts/Import-AzApiManagementProductPolicy.ps1

@@ -5,6 +5,10 @@ param(
    [Parameter(Mandatory = $true)][string] $PolicyFilePath
 )
 
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
 $apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 
 Write-Host "Updating policy of product '$ProductId'"

src/Arcus.Scripting.ApiManagement/Scripts/Remove-AzApiManagementDefaults.ps1

@@ -4,7 +4,11 @@ param(
 )
 
 Write-Host "Start removing Azure API Management defaults..."
-$apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName 
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
+$apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 $exceptionOccurred = $false
 $failedActions = @()
 

src/Arcus.Scripting.ApiManagement/Scripts/Set-AzApiManagementApiSubscriptionKey.ps1

@@ -6,6 +6,10 @@ param(
     [Parameter(Mandatory = $false)][string] $QueryParamName = "apiKey"
 )
 
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
 $apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 Write-Host "Using API Management instance '$ServiceName' in resource group '$ResourceGroupName'"
 

src/Arcus.Scripting.ApiManagement/Scripts/Upload-AzApiManagementCertificate.ps1

@@ -5,9 +5,13 @@ param(
     [Parameter(Mandatory = $true)][string] $CertificatePassword = $(throw "Password for certificate is required")
 )
 
-$context = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
+$apim = Get-AzApiManagement -ResourceGroupName $ResourceGroupName -Name $ServiceName
+if ($apim -eq $null) {
+    throw "Unable to find the Azure API Management Instance $ServiceName in resource group $ResourceGroupName"
+}
+$apimContext = New-AzApiManagementContext -ResourceGroupName $ResourceGroupName -ServiceName $ServiceName
 Write-Host "Using API Management instance '$ServiceName' in resource group '$ResourceGroupName'"
 
 Write-Verbose "Uploading private certificate at '$CertificateFilePath'..."
-New-AzApiManagementCertificate -Context $context -PfxFilePath $CertificateFilePath -PfxPassword $CertificatePassword
+New-AzApiManagementCertificate -Context $apimContext -PfxFilePath $CertificateFilePath -PfxPassword $CertificatePassword
 Write-Host "Uploaded private certificate at '$CertificateFilePath'"