Skip to content

Commit c010cda

Browse files
Merge pull request #33 from AnirbanPaul/patch-25
Update get-networkcontrollervirtualnetwork.md
2 parents 71f57fc + 2a8b2c1 commit c010cda

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

docset/windows/network-controller/get-networkcontrollervirtualnetwork.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ms.assetid: F99CCF82-D482-4BA3-A4B3-EB9DB1FAFEC2
2020
# Get-NetworkControllerVirtualNetwork
2121

2222
## SYNOPSIS
23-
23+
This cmdlet retrieves the settings of a virtual network from the Network Controller
2424
## SYNTAX
2525

2626
```
@@ -29,13 +29,19 @@ Get-NetworkControllerVirtualNetwork [[-ResourceId] <String[]>] -ConnectionUri <U
2929
```
3030

3131
## DESCRIPTION
32+
This cmdlet retrieves the settings of a virtual network from the Network Controller
3233

3334
## EXAMPLES
34-
35+
This example retrieves a virtual network named vnet1 from the Network Controller.
36+
```
37+
Get-NetworkControllerVirtualNetwork -ConnectionUri https://networkcontroller -ResourceId vnet1
38+
```
3539

3640
## PARAMETERS
3741

3842
### -CertificateThumbprint
43+
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.
44+
3945
```yaml
4046
Type: String
4147
Parameter Sets: (All)
@@ -49,6 +55,8 @@ Accept wildcard characters: False
4955
```
5056
5157
### -ConnectionUri
58+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
59+
5260
```yaml
5361
Type: Uri
5462
Parameter Sets: (All)
@@ -62,6 +70,8 @@ Accept wildcard characters: False
6270
```
6371
6472
### -Credential
73+
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.
74+
6575
```yaml
6676
Type: PSCredential
6777
Parameter Sets: (All)
@@ -88,6 +98,9 @@ Accept wildcard characters: False
8898
```
8999
90100
### -ResourceId
101+
102+
Specifies the unique identifier for the virtual network
103+
91104
```yaml
92105
Type: String[]
93106
Parameter Sets: (All)
@@ -106,6 +119,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
106119
## INPUTS
107120
108121
## OUTPUTS
122+
Following properties can be retrieved for a virtual network:
123+
1. Address space of the network
124+
2. DHCP options
125+
3. Subnets in the virtual network
126+
4. Logical network associated with the virtual network
109127
110128
## NOTES
111129

0 commit comments

Comments
 (0)