Get-​Azure​Rm​Vpn​Client​Root​Certificate

Gets information about VPN root certificates.

Syntax

Get-AzureRmVpnClientRootCertificate
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
   -VirtualNetworkGatewayName <String>
   [-VpnClientRootCertificateName <String>]
   [<CommonParameters>]

Description

The Get-AzureRmVpnClientRootCertificate cmdlet returns information about the root certificates assigned to a virtual network gateway. Root certificates are X.509 certificates that identify your Root Certification Authority: all other certificates used on the gateway trust the root certificate.

By default, Get-AzureRmVpnClientRootCertificate returns information about all the root certificates assigned to a gateway. (Gateways can have more than one root certificate.) However, by including the VpnClientRootCertificateName parameter you can limit the returned data to a specific certificate.

Examples

Example 1: Get information about all root certificates

PS C:\>Get-AzureRmVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup"

This command gets information about all the root certificates assigned to a virtual network gateway named ContosoVirtualNetwork.

Example 2: Get information about specific root certificates

PS C:\>Get-AzureRmVpnClientRootCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRootCertificateName "ContosoRootClientCertificate"

This command is a variation of the command shown in Example 1. In this case, however, the VpnClientRootCertificateName parameter is included in order to limit the returned data to a specific root certificate: ContosoRootClientCertificate.

Required Parameters

-ResourceGroupName

Specifies the name of the resource group that the virtual network gateway is assigned to.Resource groups categorize items to help simplify inventory management and general Azure administration.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VirtualNetworkGatewayName

Specifies the name of the virtual network gateway where the root certificate is assigned.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VpnClientRootCertificateName

Specifies the name of the client root certificate that this cmdlet gets.

Type:String
Aliases:ResourceName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs