How to check virtual network gateway connection state using PS?

Question

How to check virtual network gateway connection state using PS?

Oleg Tserkovnyuk 671

I am looking for a way to check the virtual network gateway connection state using PS.

Based on the MS article that should be pretty simple, using command:

Get-AzVirtualNetworkGatewayConnection -Name $ConnectionName -ResourceGroupName $RGName

However, this solution does not work. Command Get-AzVirtualNetworkGatewayConnection returns some connection information but does not return the state.

The field 'ConnectionStatus' is always blank. Tried on more than 10 tenants. Tried on connected and disconnected connections.

KapilAnanth 49,851 Reputation points Moderator

2024-01-08T07:20:29.2866667+00:00

@Oleg Tserkovnyuk

Reaching out to check if there are any questions on this.

Please let us know if we can be of any further assistance here.

Thanks,

Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-09T09:33:09.0766667+00:00

@Oleg Tserkovnyuk

Could you please provide an update on this post?

Kindly let us know if this helps or you need further assistance on this issue.

Thanks,

Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-11T09:53:45.1566667+00:00

@Oleg Tserkovnyuk
Just checking in to see if the below answer helped. If this answers your query, please don’t forget to click "Accept the answer" and Up-Vote for the same, which might be beneficial to other community members reading this thread. And, if you have any further query do let us know.

Thanks, Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-18T05:48:44.4466667+00:00

@Oleg Tserkovnyuk

We noticed your recent experience on the Q&A community platform for this thread was rated as not helpful.

However, the survey we are taking is testimony of our team providing timely attention to reported issue and partnering with customer to ensure their voice reaches the engineering team to improve the product.

If you feel our team members or the community have been providing right level of support and your scenario has got timely response or work around, we would like to request you to reconsider the feedback.

If the workaround suggested is helpful, Please don’t forget to close this thread by clicking "Accept the answer".

If not, we are eager to know what could have been done better to evolve your experience to a 5* star rating. Your candid feedback is very important to us.

Cheers,

Kapil.
Joshua Stevenson 0 Reputation points

2025-03-04T15:41:18.3166667+00:00
I can confirm on my own setup, if you pass in the -name parameter into the get-azVirtualNetworkGatewayConnection cmdlet, the ConnectionStatus property will correctly return a value, such as "Connected"
If however you do not supply the -Name param, and only pass in the -ResourceGroupName, whilst it will return exactly the same results, the ConnectionStatus property will be blank.
TL;DR - Make sure you explicitly pass in the -Name param

For a quick fix, and to work with an unknown amount of connections, just pass the results of the first command back into itself:

Get-AzVirtualNetworkGatewayConnection -ResourceGroupName "ResourceGroupNameHere" | % { Get-AzVirtualNetworkGatewayConnection -ResourceGroupName $_.ResourceGroupName -Name $_.Name | select ResourceGroupName, Name, ConnectionStatus }

Answer accepted by question author

0 additional answers

Your answer

KapilAnanth 49,851 Reputation points Moderator

2024-01-08T07:20:29.2866667+00:00

@Oleg Tserkovnyuk

Reaching out to check if there are any questions on this.

Please let us know if we can be of any further assistance here.

Thanks,

Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-09T09:33:09.0766667+00:00

@Oleg Tserkovnyuk

Could you please provide an update on this post?

Kindly let us know if this helps or you need further assistance on this issue.

Thanks,

Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-11T09:53:45.1566667+00:00

@Oleg Tserkovnyuk
Just checking in to see if the below answer helped. If this answers your query, please don’t forget to click "Accept the answer" and Up-Vote for the same, which might be beneficial to other community members reading this thread. And, if you have any further query do let us know.

Thanks, Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-18T05:48:44.4466667+00:00

@Oleg Tserkovnyuk

We noticed your recent experience on the Q&A community platform for this thread was rated as not helpful.

However, the survey we are taking is testimony of our team providing timely attention to reported issue and partnering with customer to ensure their voice reaches the engineering team to improve the product.

If you feel our team members or the community have been providing right level of support and your scenario has got timely response or work around, we would like to request you to reconsider the feedback.

If the workaround suggested is helpful, Please don’t forget to close this thread by clicking "Accept the answer".

If not, we are eager to know what could have been done better to evolve your experience to a 5* star rating. Your candid feedback is very important to us.

Cheers,

Kapil.
Joshua Stevenson 0 Reputation points

2025-03-04T15:41:18.3166667+00:00

I can confirm on my own setup, if you pass in the -name parameter into the get-azVirtualNetworkGatewayConnection cmdlet, the ConnectionStatus property will correctly return a value, such as "Connected"
If however you do not supply the -Name param, and only pass in the -ResourceGroupName, whilst it will return exactly the same results, the ConnectionStatus property will be blank.
TL;DR - Make sure you explicitly pass in the -Name param

For a quick fix, and to work with an unknown amount of connections, just pass the results of the first command back into itself:

Get-AzVirtualNetworkGatewayConnection -ResourceGroupName "ResourceGroupNameHere" | % { Get-AzVirtualNetworkGatewayConnection -ResourceGroupName $_.ResourceGroupName -Name $_.Name | select ResourceGroupName, Name, ConnectionStatus }

Answer 1

KapilAnanth 49,851 Moderator

Hi @Oleg Tserkovnyuk

I tried to reproduce your issue with Powershell in Azure Cloud Shell and I am not able to repo the issue.

User's image

As you can see, I am able to see the ConnectionStatus as "Unknown" and not blank.

Can you check the same using Azure Cloud Shell?
- What is Azure Cloud Shell : https://learn.microsoft.com/en-us/azure/cloud-shell/overview
Please make sure Azure Powershell Modules are up to date if you are using it in Windows device.

Cheers,

Kapil

Oleg Tserkovnyuk 671 Reputation points

2024-01-15T13:56:37.6966667+00:00

Hi @KapilAnanth-MSFT, Thanks for your help. I use az.network module 7.3.0. I run my code from windows device. Connection status is blank. Azure Cloud Shell will not be helpful in this case, since I need PS script.
KapilAnanth 49,851 Reputation points Moderator

2024-01-16T13:06:06.8533333+00:00
Hi @Oleg Tserkovnyuk,

I shall check the version az.network module 7.3.0 and let you know.

Meanwhile, can you please share the status from the Portal?

Does it have a value or it is Empty as well?

Cheers,

Kapil
Oleg Tserkovnyuk 671 Reputation points

2024-01-16T13:42:59.9866667+00:00

Status from the portal is 'Connected':
Deleted

This comment has been deleted due to a violation of our Code of Conduct. The comment was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.
KapilAnanth 49,851 Reputation points Moderator

2024-01-16T13:50:48.6666667+00:00
Hi @Oleg Tserkovnyuk,

I am not able to repo your issue.

I tried both connected and non-connected scenarios and here is the results.

I even tried to print the entire Connection Object and I can see the results:

Next Steps:

Please uninstall and reinstall the Az PS Module

Try it with a different device and share the results.

Cheers,

Kapil
KapilAnanth 49,851 Reputation points Moderator

2024-01-17T03:52:37.2133333+00:00
Hi @Oleg Tserkovnyuk ,

I think I found the issue.

When I run Get-AzVirtualNetworkGatewayConnection to get a Connection Object Array, the ConnectionStatus is empty

The same happens for “Shared Key” also

However, if I just get one Connection Object (by specifying the -Name parameter), the ConnectionStatus is non-empty

I have informed this behavior to the concerned Product Teams and they are checking on this.

Meanwhile, what you can do is, run a for each loop across all the Connections to get the status (or any other property).

$Connections=Get-AzVirtualNetworkGatewayConnection -ResourceGroupName <RGName> foreach ($Connection in $Connections) { $ConnectionObject=Get-AzVirtualNetworkGatewayConnection -Name $Connection.Name -ResourceGroupName $Connection.ResourceGroupName Write-Host $ConnectionObject.Name Write-Host $ConnectionObject.ConnectionStatus }

Thanks for your continued contribution on Q&A and appreciate much for taking the time to share your feedback.

Request you to please close the thread by clicking "Accept the answer" wherever the information provided helps you, as this can be beneficial to other community members.

Cheers,

Kapil
Oleg Tserkovnyuk 671 Reputation points

2024-01-18T08:24:50.3566667+00:00

Magnificent! That works. Appreciate your help.
KapilAnanth 49,851 Reputation points Moderator

2024-01-18T09:23:59.3666667+00:00

Hi @Oleg Tserkovnyuk, You are most welcome :)

Share via

How to check virtual network gateway connection state using PS?

0 additional answers

Your answer