Microsoft NetworkController reference: Removes 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.
Use an account with the target resource permissions documented for Remove-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.
-Confirm
Prompts you for confirmation before running the cmdlet.
-ConnectionUri (required)
Specifies the Uniform Resource Identifier (URI) of a Network Controller. The cmdlet removes a 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.
-Etag
Specifies the entity tag (ETag) parameter of the resource. An ETag is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.
-Force
Forces the command to run without asking for user confirmation.
-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 (required)
Specifies the resource ID of the virtual network peering to remove.
-VirtualNetworkId (required)
Specified the ID of a virtual network. This cmdlet removes a peering for that network.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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 cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
Examples
Example 1: Remove a virtual network peering object
This example removes the virtual network peering for the specified virtual network. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.