Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 4.24 KB

Get-AzureRmVpnClientRevokedCertificate.md

File metadata and controls

128 lines (93 loc) · 4.24 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.Network.dll-Help.xml
AzureRM.Network
05626BF7-F886-4C76-8FC2-DDF783DEB539
2.0.0

Get-AzureRmVpnClientRevokedCertificate

SYNOPSIS

Gets information about VPN client-revocation certificates.

SYNTAX

Get-AzureRmVpnClientRevokedCertificate [-VpnClientRevokedCertificateName <String>]
 -VirtualNetworkGatewayName <String> -ResourceGroupName <String> [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

DESCRIPTION

The Get-AzureRmVpnClientRevokedCertificate cmdlet returns information about the client-revocation certificates assigned to a virtual network gateway. Client-revocation certificates prevent client computers from using the specified certificate for authentication. Get-AzureRmVpnClientRevokedCertificate enables you to return information about all the client-revocation certificates on the gateway or, by using the VpnClientRevokedCertificateName parameter, to get information about a single certificate.

EXAMPLES

Example 1: Get information about all client-revocation certificates

PS C:\>Get-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetworkGateway" -ResourceGroupName "ContosoResourceGroup"

This command gets information about all the client-revocation certificates associated with the virtual network gateway named ContosoVirtualNetworkGateway.

Example 2: Get information about specific client-revocation certificates

PS C:\>Get-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate"

This command is a variation of the command shown in Example 1. In this case, however, the VpnClientRevokedCertificateName parameter is used to limit the returned data to a specific client-revoked certificate: the certificate with the name ContosoRevokedClientCertificate.

PARAMETERS

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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: System.String
Parameter Sets: (All)
Aliases:

Required: True
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 revoked certificate information is assigned.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-VpnClientRevokedCertificateName

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

Type: System.String
Parameter Sets: (All)
Aliases: ResourceName

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate

NOTES

RELATED LINKS

Add-AzureRmVpnClientRevokedCertificate

New-AzureRmVpnClientRevokedCertificate

Remove-AzureRmVpnClientRevokedCertificate