[Serial-Console]: az serial-console connect: Change to use different region for url calls when custom storage account firewalls are enabled

[rhkodiak]

---

This changed introduces the ability when using custom storage accounts with the firewall enabled to use the region (i.e. westcentralUS) when connecting to serial-console. If the VIirtual Machine and custom storage account live in the same region then the user gets a Forbidden message when trying to connect to serial-console. These changes allow the code to find the pairing region and connect to serial-console through that region url.

.

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

az serial-console connect

General Guidelines

• Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
• Have you run python scripts/ci/test_index.py -q locally?

For new extensions:

• My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
The precondition is to put your code inside this repository and upgrade the version in the pull request but do not modify src/index.json.

[ghost]

Thank you for your contribution rhkodiak! We will review the pull request and get back to you soon.

[yonzhan]

Serial-Console

[wangzelin007]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[brendank310]

@yonzhan: @rhkodiak has run the tests successfully locally, is there some environmental disparity that causes the CI checks to fail?

[wangzelin007]

@rhkodiak
@brendank310

https://dev.azure.com/azclitools/public/_build/results?buildId=8724&view=logs&j=59e8686e-5e74-514d-6cad-f7d66c66b425&t=59602323-6717-504d-f2cc-5c81369f935f&l=1003

According to the error log, it shows that we need use virtual machines == 2022-08-01,
But in your recording files virtual Machines version is 2022-03-01,

Latest profile in Azure CLI:
https://github.com/Azure/azure-cli/blob/c1c805f5680f27b17412acf6fd53228b50edb8b2/src/azure-cli-core/azure/cli/core/profiles/_shared.py#L153

Your recording file's virtual machines version:

azure-cli-extensions/src/serial-console/azext_serialconsole/tests/latest/recordings/test_check_resource_VM.yaml

Line 16 in bb45618

uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_serialconsole000001/providers/Microsoft.Compute/virtualMachines/cli000003?$expand=instanceView&api-version=2022-03-01

Here are the suggestions:

1. git pull the latest code from Azure/azure-cli
2. azdev setup -c
3. merge the latest code into your branch
4. rerun all the tests and make sure API version is 2022-08-01

[rhkodiak]

@wangzelin007
@brendank310

Thank you for the help! I applied what you suggested and the tests are passing now. I couldn’t tell from the error logs what the problem was so much appreciated.

The PR is ready for your review and approval.

[evelyn-ys]

Is this print for debug? Do you want to keep it in release version?

[rhkodiak]

That print was for debug purposes and I would like to keep it in the release version if possible. Is there a different way to implement that for debug purposes?

[evelyn-ys]

Please use logger.debug() then. This would be print only when --debug parameter specified

[rhkodiak]

I updated the code to use the logger.debug() option instead of print

[evelyn-ys]

Please import logger from knack:

from knack.log import get_logger
logger = get_logger(__name__)

[rhkodiak]

I added the missing import and kicked off the build again

[azclibot]

[Release] Update index.json for extension [ serial-console ] : https://dev.azure.com/azclitools/internal/_build/results?buildId=10355&view=results