COMMAND EVERYTHING.

Get-NetworkControllerVirtualNetworkPeering

Gets a virtual network peering.

Networking / Security · Risk: Low · Documentation Verified

Last verified: 2026-10-26

Microsoft NetworkController reference: Gets a virtual network peering. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Get-NetworkControllerVirtualNetworkPeering [-VirtualNetworkId] <String[]> [[-ResourceId] <String[]>]
 -ConnectionUri <Uri> [-CertificateThumbprint <String>] [-Credential <PSCredential>] [-PassInnerException]
 [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Get-NetworkControllerVirtualNetworkPeering. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / NetworkController · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-CertificateThumbprint: Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
-ConnectionUri (required): Specifies the Uniform Resource Identifier (URI) of a Network Controller. The cmdlet gets the virtual network peering for that controller.
-Credential: Specifies a user credential that has permission to perform this action. The default value is the current user. This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
-PassInnerException: This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user. The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.
-ResourceId: Specifies the resource ID of the virtual network peering to get.
-VirtualNetworkId (required): Specified the ID of a virtual network. This cmdlet gets a peering for that network.

Prerequisites

Windows with the NetworkController module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.

Examples

Example 1: Get a virtual network peering object

Get-NetworkControllerVirtualNetworkPeering -VirtualNetworkId "Contoso_vnet1" -ConnectionUri https://networkcontroller

This example gets the virtual network peering object for the specified virtual network. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/NetworkController/Get-NetworkControllerVirtualNetworkPeering.md

https://learn.microsoft.com/powershell/module/networkcontroller/get-networkcontrollervirtualnetworkpeering?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands

Get-NetIPInterface

Add-MpPreference

Get-MpPerformanceReport

Add-DhcpServerInDC