Edit

Share via

Add-AzureRmVpnClientRevokedCertificate

  • Reference
Module:
AzureRM.Network

Adds a VPN client-revocation certificate.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

The Add-AzureRmVpnClientRevokedCertificate cmdlet assigns a client-revocation certificate to a virtual network gateway. Client-revocation certificates prevent client computers from using the specified certificate for authentication. You need to specify both the certificate name and the certificate thumbprint to use this cmdlet.

Examples

Example 1: Add a new client-revocation certificate to a virtual network gateway

PS C:\>Add-AzureRmVpnClientRevokedCertificate -VirtualNetworkGatewayName "ContosoVirtualNetwork" -ResourceGroupName "ContosoResourceGroup" -VpnClientRevokedCertificateName "ContosoRevokedClientCertificate"-Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3"

This command adds a new client-revocation certificate to the virtual network gateway named ContosoVirtualNetwork. In order to add the certificate, you must specify both the certificate name and the certificate thumbprint.

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
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:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Thumbprint

Specifies the unique identifier of the certificate being added. For example: -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3" You can get thumbprint information for your certificates by using a Windows PowerShell command similar to this: Get-ChildItem -Path Cert:\LocalMachine\Root. The preceding command gets information for all the local computer certificates found in the root certificate store.

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

-VirtualNetworkGatewayName

Specifies the name of the virtual network gateway where the certificate should be added.

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

-VpnClientRevokedCertificateName

Specifies the name of the VPN client certificate to be added.

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

Inputs

String

Outputs

PSVpnClientRevokedCertificate