Edit

Get-NetworkControllerVirtualSubnet

  • Reference
Module:
NetworkController

This cmdlet retrieves a virtual subnet belonging to a virtual network

Syntax

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

Description

This cmdlet retrieves a virtual subnet belonging to a virtual network

Examples

Example 1

This cmdlet retrieves all the virtual subnets belonging to the virtual network vnet1.

Get-NetworkControllerVirtualSubnet -ConnectionUri https://networkcontroller -VirtualNetworkId 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.

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 the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network 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.

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

Sepcifies the unique identifier for the virtual subnet

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

-VirtualNetworkId

Specifies the virtual network where the virtual subnet belongs

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

Inputs

String[]

Outputs

Object

Following properties of a virtual subnet are retrieved:

  1. Address prefix
  2. Access control list associated with the subnet
  3. Route table associated with the subnet
  4. IP configuration
  5. Service insertion rules associated with the subnet