Fix SSH into VMs without public IP

[dionhaefner]

---

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

Related command

Without the fix:

$ az ssh vm -n <myvm> -g <mygroup>
The command failed with an unexpected error. Here is the traceback:
'publicIPAddress'
Traceback (most recent call last):
  File "/Users/dion/.virtualenvs/tempenv-5ea7193651842/lib/python3.10/site-packages/knack/cli.py", line 233, in invoke
    cmd_result = self.invocation.execute(args)
  File "/Users/dion/.virtualenvs/tempenv-5ea7193651842/lib/python3.10/site-packages/azure/cli/core/commands/__init__.py", line 663, in execute
    raise ex
  File "/Users/dion/.virtualenvs/tempenv-5ea7193651842/lib/python3.10/site-packages/azure/cli/core/commands/__init__.py", line 726, in _run_jobs_serially
    results.append(self._run_job(expanded_arg, cmd_copy))
  File "/Users/dion/.virtualenvs/tempenv-5ea7193651842/lib/python3.10/site-packages/azure/cli/core/commands/__init__.py", line 697, in _run_job
    result = cmd_copy(params)
  File "/Users/dion/.virtualenvs/tempenv-5ea7193651842/lib/python3.10/site-packages/azure/cli/core/commands/__init__.py", line 333, in __call__
    return self.handler(*args, **kwargs)
  File "/Users/dion/.virtualenvs/tempenv-5ea7193651842/lib/python3.10/site-packages/azure/cli/core/commands/command_operation.py", line 121, in handler
    return op(**command_args)
  File "/Users/dion/.azure/cliextensions/ssh/azext_ssh/custom.py", line 66, in ssh_vm
    _do_ssh_op(cmd, ssh_session, op_call)
  File "/Users/dion/.azure/cliextensions/ssh/azext_ssh/custom.py", line 159, in _do_ssh_op
    op_info.ip = op_info.ip or ip_utils.get_ssh_ip(cmd, op_info.resource_group_name,
  File "/Users/dion/.azure/cliextensions/ssh/azext_ssh/ip_utils.py", line 36, in get_ssh_ip
    public_ip_ref = ip_config["publicIPAddress"]
KeyError: 'publicIPAddress'

With the fix:

$ az ssh vm -n <myvm> -g <mygroup>
No public IP detected, attempting private IP (you must bring your own connectivity).
Use --prefer-private-ip to avoid this message.
OpenSSH_9.0p1, LibreSSL 3.3.6
Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.15.0-1034-azure x86_64)

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.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

[azure-client-tools-bot-prd]

Hi @dionhaefner,
Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

[ghost]

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

[yonzhan]

SSH

[zhoxing-ms]

Could you please add test for this case?

[zhoxing-ms]

Please write the description of PR change into the HISTORY.rst. If you want to release a new extension version for this PR, please also upgrade the version defined in the setup.py.

[vthiebaut10]

@zhoxing - There are no scenario tests for this extension at the moment, and I don't think there is an easy way to test this logic simply with unit tests. This part of the code is currently untested by automated tests, which is something that I've been planning on addressing soon.

[navba-MSFT]

Please write the description of PR change into the HISTORY.rst. If you want to release a new extension version for this PR, please also upgrade the version defined in the setup.py.

@dionhaefner I have submitted a PR for this suggestion in your branch https://github.com/dionhaefner/azure-cli-extensions/tree/patch-1 to save your time. Could you please approve it so that it can be reviewed again here ?

[dionhaefner]

Merged, thanks! 👍

[dionhaefner]

@microsoft-github-policy-service agree

[azclibot]

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