Provide script to upload a certificate in the APIM CA Certificate store

[mbraekman]

Is your feature request related to a problem? Please describe.
Provide script to upload a certificate in the APIM CA Certificate store.
This allows you to upload public certificates of partners/clients to allow client certificate validation in the APIM policy using the following snippet:

<!-- Validate the client certificate in the inbound request -->
        <choose>
            <!-- Below condition verifies if the request contains a client certificate + if the certificate can be validated against 1 of the available certificates in the CA Certificates-store. -->
            <when condition="@(context.Request.Certificate == null || !context.Request.Certificate.Verify())">
                <return-response>
                    <set-status code="403" reason="Invalid client certificate" />
                </return-response>
            </when>
        </choose>

Describe the solution you'd like
In order to upload a certificate, you need to perform these steps:

• Load the certificate and create a new AzApiManagementSystemCertificate
• Get APIM Context
• Add the newly created systemCertificate to the APIM Context
• Update the APIM Context

Would be useful to have this as a function to which you only need to provide the following parameters:

• ResourceGroupName (resource group containing the APIM instance)
• ServiceName (name of the APIM instance)
• CertificateFilePath (full path to the location of the public certificate)

See example: https://github.com/mbraekman/Powershell/blob/master/Azure/APIM-UploadCACertificate.ps1

This does take quite a long time to upload, if it would be possible to state whether to wait for the result or to immediately return, would be a nice addition, otherwise, a release pipeline might be waiting up to 20minutes for this script to finish.
Or if there is a better solution, which doesn't take as long, that would be even better.

Target-module:

• Arcus.Scripting.ApiManagement

Describe alternatives you've considered
Manually uploading the certificate.

[stijnmoreels]

We could include the uploading functionality in a Start-Job based on a -PassThru argument or so; so it immediately returns or not?

[mbraekman]

We could include the uploading functionality in a Start-Job based on a -PassThru argument or so; so it immediately returns or not?

Aha yes, that should work indeed.
Perhaps use the switch -WaitForCompletion instead of -PassThru as it perhaps better indicates what it does? But depending on what's being used in other Arcus-related artifacts of course, in regards to aligning the approach/naming conventions.

[stijnmoreels]

Aha, seems like the Set-AzApiManagement already has a -AsJob parameter 😉 . Let's use that one.