Get-NetworkControllerPublicIpAddress

This cmdlet retrieves a public IP address resource from the Network Controller

Syntax

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

Description

This cmdlet retrieves a public IP address resource from the Network Controller. This publicIpAddress resource is used by the virtualGateway resource and the loadBalancer resource to indicate the IP Address that can be used to communicate with the virtual network from outside it.

Examples

Example 1

This example retrieves all the public IP address resources from the Network Controller. Network Controller is represented by the REST uri https://networkcontroller.

Get-NetworkControllerPublicIpAddress -ConnectionUri https://networkcontroller

Required Parameters

-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
Accept pipeline input:False
Accept wildcard characters:False

Optional 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
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
Accept pipeline input:False
Accept wildcard characters:False
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the unique ID of the resource

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

Outputs

Following properties can be retrieved from this cmdlet:

  1. The public IP Address of the resource
  2. Allocation method of the public IP address: Static or dynamic
  3. Properties of a DNS record associated with this public IP address
  4. Idle timeout of the TCP connection
  5. Reference to private IP address that the public IP address is associated to