Edit

Share via

Add-AzVpnClientRevokedCertificate

Module:
Az.Network Module

Adds a VPN client-revocation certificate.

Syntax

Default (Default) 

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

Description

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

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

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

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

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:False
Value from remaining arguments:False

-VirtualNetworkGatewayName

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

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 to be added.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
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