How do I remove a sesion host from a AVD hostpool using the cli

Question

How do I remove a sesion host from a AVD hostpool using the cli

Greg Bonk 86

Using only the Azure CLI I would like to remove a session host registration that is registered with a host pool in Azure Virtual Desktop

I've been round and round with the CLI docs and I can't find anything for unregister a session host.

There does appear to be a powershell way, but I am restricted to using the CLI.

KarishmaTiwari-MSFT 20,772 Reputation points Microsoft Employee Moderator

2022-10-18T05:11:22.66+00:00

@Greg Bonk Thanks for posting your query on Microsoft Q&A.

Do you want to delete the host pool as well?
Here are the steps to delete a host pol which deletes/unregisters the session host as well : https://github.com/MicrosoftDocs/azure-docs/blob/main/articles/virtual-desktop/delete-host-pool.md#azure-cli

I couldn't find a document to just unregister the session host from host pool using Azure CLI. I have reached out to the internal teams to get confirmation on it and will share an update as I hear back.
Greg Bonk 86 Reputation points

2022-10-18T13:16:15.403+00:00

Hi @KarishmaTiwari-MSFT

Thank you for getting back to me.

To answer your question, if I want to delete the host pool as well, the answer is no I do not want to delete the host pool.

My goal is to maintain the host pool, but when I delete a VM I would like a way to automatically remove it from the preserved host pool via the CLI.
KarishmaTiwari-MSFT 20,772 Reputation points Microsoft Employee Moderator

2022-10-18T18:15:14.13+00:00

Thanks for clarifying.

I've looked at the AZ CLI reference and the sessionhost object is not listed: az desktopvirtualization | Microsoft Learn

Do you only want to use the AZ CLI or could use the REST API instead, if that's acceptable?

Session Hosts - Delete - REST API (Azure Desktop Virtualization) | Microsoft Learn

Accepted answer

1 additional answer

Your answer

KarishmaTiwari-MSFT 20,772 Reputation points Microsoft Employee Moderator

2022-10-18T05:11:22.66+00:00

@Greg Bonk Thanks for posting your query on Microsoft Q&A.

Do you want to delete the host pool as well?
Here are the steps to delete a host pol which deletes/unregisters the session host as well : https://github.com/MicrosoftDocs/azure-docs/blob/main/articles/virtual-desktop/delete-host-pool.md#azure-cli

I couldn't find a document to just unregister the session host from host pool using Azure CLI. I have reached out to the internal teams to get confirmation on it and will share an update as I hear back.
Greg Bonk 86 Reputation points

2022-10-18T13:16:15.403+00:00

Hi @KarishmaTiwari-MSFT

Thank you for getting back to me.

To answer your question, if I want to delete the host pool as well, the answer is no I do not want to delete the host pool.

My goal is to maintain the host pool, but when I delete a VM I would like a way to automatically remove it from the preserved host pool via the CLI.
KarishmaTiwari-MSFT 20,772 Reputation points Microsoft Employee Moderator

2022-10-18T18:15:14.13+00:00

Thanks for clarifying.

I've looked at the AZ CLI reference and the sessionhost object is not listed: az desktopvirtualization | Microsoft Learn

Do you only want to use the AZ CLI or could use the REST API instead, if that's acceptable?

Session Hosts - Delete - REST API (Azure Desktop Virtualization) | Microsoft Learn

Answer 1

@Greg Bonk
Currently, the session host object is not listed in the AZ CLI reference : az desktopvirtualization | Microsoft Learn
Thus, it is not supported to remove a session host using Azure CLI.

However, an alternative is to use REST API instead to delete the session host as described here:

Session Hosts - Delete - REST API (Azure Desktop Virtualization) | Microsoft Learn

Your feedback is valuable and we would request you to share your feedback by clicking on Feedback option at the bottom of this document so that it can reach the right team and they can prioritize it.

Answer 2

Greg Bonk 86

Thank you for the details. Hopefully they will get the CLI updated.

Share via

How do I remove a sesion host from a AVD hostpool using the cli

1 additional answer

Your answer