Edit

Share via


Get-AzVpnClientRevokedCertificate

Gets information about VPN client-revocation certificates.

Syntax

Default (Default)

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

Description

The Get-AzVpnClientRevokedCertificate 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-AzVpnClientRevokedCertificate 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

Get-AzVpnClientRevokedCertificate -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

Get-AzVpnClientRevokedCertificate -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.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-VirtualNetworkGatewayName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-VpnClientRevokedCertificateName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

PSVpnClientRevokedCertificate