Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ms.assetid: F99CCF82-D482-4BA3-A4B3-EB9DB1FAFEC2
# Get-NetworkControllerVirtualNetwork

## SYNOPSIS

This cmdlet retrieves the settings of a virtual network from the Network Controller
## SYNTAX

```
Expand All @@ -29,13 +29,19 @@ Get-NetworkControllerVirtualNetwork [[-ResourceId] <String[]>] -ConnectionUri <U
```

## DESCRIPTION
This cmdlet retrieves the settings of a virtual network from the Network Controller

## EXAMPLES

This example retrieves a virtual network named vnet1 from the Network Controller.
```
Get-NetworkControllerVirtualNetwork -ConnectionUri https://networkcontroller -ResourceId vnet1
```

## PARAMETERS

### -CertificateThumbprint
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.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.

```yaml
Type: String
Parameter Sets: (All)
Expand All @@ -49,6 +55,8 @@ Accept wildcard characters: False
```

### -ConnectionUri
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

```yaml
Type: Uri
Parameter Sets: (All)
Expand All @@ -62,6 +70,8 @@ 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.

```yaml
Type: PSCredential
Parameter Sets: (All)
Expand All @@ -88,6 +98,9 @@ Accept wildcard characters: False
```

### -ResourceId

Specifies the unique identifier for the virtual network

```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -106,6 +119,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS

## OUTPUTS
Following properties can be retrieved for a virtual network:
1. Address space of the network
2. DHCP options
3. Subnets in the virtual network
4. Logical network associated with the virtual network

## NOTES

Expand Down