Edit

Share via

Get-NetworkControllerVirtualNetworkPeering

  • Reference
Module:
NetworkController

Gets a virtual network peering.

Syntax

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

Description

The Get-NetworkControllerVirtualNetworkPeering cmdlet gets a virtual network peering. A peering enables connectivity between two virtual networks.

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.

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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of a Network Controller. The cmdlet gets the virtual network peering for that controller.

Type:Uri
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

Specifies the resource ID of the virtual network peering to get.

Type:String[]
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualNetworkId

Specified the ID of a virtual network. This cmdlet gets a peering for that network.

Type:String[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String[]

Outputs

Object