< Back
Get-AzureRmVpnClientRootCertificate
Post
NAME Get-AzureRmVpnClientRootCertificate
SYNOPSIS
Gets information about VPN root certificates.
SYNTAX
Get-AzureRmVpnClientRootCertificate [-DefaultProfile <IAzureContextContainer>] -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.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetworkGatewayName <String>
Specifies the name of the virtual network gateway where the root certificate is assigned.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VpnClientRootCertificateName <String>
Specifies the name of the client root certificate that this cmdlet gets.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Get-AzureRmVpnClientRootCertificate gets instances of the Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate object.
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ertificate
Add-AzureRmVpnClientRootCertificate
New-AzureRmVpnClientRootCertificate
Remove-AzureRmVpnClientRootCertificate
SYNOPSIS
Gets information about VPN root certificates.
SYNTAX
Get-AzureRmVpnClientRootCertificate [-DefaultProfile <IAzureContextContainer>] -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.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetworkGatewayName <String>
Specifies the name of the virtual network gateway where the root certificate is assigned.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VpnClientRootCertificateName <String>
Specifies the name of the client root certificate that this cmdlet gets.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Get-AzureRmVpnClientRootCertificate gets instances of the Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate object.
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ertificate
Add-AzureRmVpnClientRootCertificate
New-AzureRmVpnClientRootCertificate
Remove-AzureRmVpnClientRootCertificate