Improve/insights samples

[mehighlow]

Refers #2821 and #2822

What this PR does / why we need it:
This PR improves insights sample

Special notes for your reviewer:
None

[matthchr]

We also have tests for each sample (to ensure that the samples are correct). The tests are done using HTTP recordings and the results are checked in.

These samples have two tests associated with them:
https://github.com/Azure/azure-service-operator/blob/main/v2/internal/controllers/recordings/Test_Samples_CreationAndDeletion/Test_Insights_v1api_CreationAndDeletion.yaml
and
https://github.com/Azure/azure-service-operator/blob/main/v2/internal/controllers/recordings/Test_Samples_CreationAndDeletion/Test_Insights_v1beta_CreationAndDeletion.yaml

In order to re-record those tests, you need to follow the instructions here. Mainly you need to set up the AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, etc.

You don't need to run every integration test, if you just run the one sample test: Test_Samples_CreationAndDeletion, that will re-record the those files. The actual workflow to do this is:

1. Set AZURE_SUBSCRIPTION_ID, etc vars
2. Delete the two existing recording files (linked above).
3. Run TEST_FILTER=Test_Samples_CreationAndDeletion task controller:test-integration-envtest

This should produce 2 new files (named the same as before but with different content) containing the HTTP recordings of successfully deploying that component + workspace.

It's a bit annoying but it ensures that our samples always work (because they're all tested). If setting that up is super odious let us know and we can come up with something to help you possibly.

[mehighlow]

@matthchr, tests associated with samples have been added. PTAL.

[theunrepentantgeek]

/ok-to-test: shar=3a44fea

[codecov-commenter]

Codecov Report

Merging #2827 (3a44fea) into main (c6e2cf5) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             main    #2827    +/-   ##
========================================
  Coverage   52.59%   52.59%            
========================================
  Files        1222     1228     +6     
  Lines      561814   562022   +208     
========================================
+ Hits       295461   295577   +116     
- Misses     217981   218077    +96     
+ Partials    48372    48368     -4     

see 26 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[matthchr]

/ok-to-test sha=3a44fea

[matthchr]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[matthchr]

Thanks for this contribution @mehighlow!

[matthchr]

/ok-to-test sha=3a44fea

[matthchr]

/ok-to-test sha=3a44fea

[matthchr]

/ok-to-test sha=507869a