New-AzureRmVpnClientRevokedCertificate

Creates a new 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

New-AzureRmVpnClientRevokedCertificate
   -Name <String>
   -Thumbprint <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzureRmVpnClientRevokedCertificate cmdlet creates a new virtual private network (VPN) client-revocation certificate for use on a virtual network gateway. Client-revocation certificates prevent client computers from using the specified certificate for authentication. This cmdlet creates a stand-alone certificate that is not assigned to a virtual gateway. Instead, the certificate created by New-AzureRmVpnClientRevokedCertificate is used in conjunction with the New-AzureRmVirtualNetworkGateway cmdlet when it creates a new gateway. For instance, suppose you create a new certificate and store it in a variable named $Certificate. You can then use that certificate object when you create a new virtual gateway. For instance, New-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway" -ResourceGroupName "ContosoResourceGroup" -Location "West US" -GatewayType "VPN" -IpConfigurations $Ipconfig -VPNType "RouteBased" -VpnClientRevokedCertificates $Certificate For more information, see the documentation for the New-AzureRmVirtualNetworkGateway cmdlet.

Examples

Example 1: Create a new client-revoked certificate

PS C:\>$Certificate = New-AzureRmVpnClientRevokedCertificate -Name "ContosoClientRevokedCertificate" -Thumbprint "E3A38EBA60CAA1C162785A2E1C44A15AD450199C3"

This command creates a new client-revoked certificate and stores the certificate object in a variable named $Certificate. This variable can then be used by the New-AzureRmVirtualNetworkGateway cmdlet to add the certificate to a new virtual network gateway.

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

-Name

Specifies a unique name for the new client-revocation certificate.

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

-Thumbprint

Specifies the unique identifier of the certificate being added. You can return thumbprint information for your certificates by using a Windows PowerShell command similar to this: Get-ChildItem -Path Cert:\LocalMachine\Root The preceding command returns 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

Inputs

None

Outputs

PSVpnClientRevokedCertificate