Skip to content

Latest commit

 

History

History
170 lines (126 loc) · 5.03 KB

Set-AzApplicationGatewaySslCertificate.md

File metadata and controls

170 lines (126 loc) · 5.03 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
Az.Network
D7C275E5-BC43-454B-BF1E-48D639C4B4F0
2.0.0

Set-AzApplicationGatewaySslCertificate

SYNOPSIS

Updates an SSL certificate for an application gateway.

SYNTAX

Set-AzApplicationGatewaySslCertificate -ApplicationGateway <PSApplicationGateway> -Name <String>
 [-CertificateFile <String>] [-Password <SecureString>] [-KeyVaultSecretId <String>]
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

The Set-AzApplicationGatewaySslCertificate cmdlet updates an SSL certificate for an application gateway.

EXAMPLES

Example 1: Update an existing SSL certificate on Application Gateway

$appGW = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$password = ConvertTo-SecureString $passwordPlainString -AsPlainText -Force
$cert = Set-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -CertificateFile "D:\cert01.pfx" -Password $password

Update an existing SSL certificate for the application gateway named ApplicationGateway01.

Example 2: Update an existing SSL certificate using KeyVault Secret (version-less secretId) on Application Gateway

$secret = Get-AzKeyVaultSecret -VaultName "keyvault01" -Name "sslCert01"
$secretId = $secret.Id.Replace($secret.Version, "") # https://<keyvaultname>.vault.azure.net/secrets/
$cert = Set-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -KeyVaultSecretId $secretId

Get the secret and update an existing SSL Certificate using Set-AzApplicationGatewaySslCertificate.

Example 3: Update an existing SSL certificate using KeyVault Secret on Application Gateway

$secret = Get-AzKeyVaultSecret -VaultName "keyvault01" -Name "sslCert01"
$secretId = $secret.Id # https://<keyvaultname>.vault.azure.net/secrets/<hash>
$cert = Set-AzApplicationGatewaySslCertificate -ApplicationGateway $AppGW -Name "Cert01" -KeyVaultSecretId $secretId

Get the secret and update an existing SSL Certificate using Set-AzApplicationGatewaySslCertificate. Note: If it is required that Application Gateway syncs the certificate with the KeyVault, please provide the version-less secretId.

PARAMETERS

-ApplicationGateway

Specifies the application gateway with which the Secure Socket Layer (SSL) certificate is associated.

Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
Parameter Sets: (All)
Aliases:

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

-CertificateFile

Specifies the path of the SSL certificate.

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

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

-DefaultProfile

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

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

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

-KeyVaultSecretId

SecretId (uri) of the KeyVault Secret. Use this option when a specific version of secret needs to be used.

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

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

-Name

Specifies the name of the SSL certificate.

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

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

-Password

Specifies the password of the SSL certificate.

Type: System.Security.SecureString
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.

INPUTS

Microsoft.Azure.Commands.Network.Models.PSApplicationGateway

OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSApplicationGateway

NOTES

RELATED LINKS

Add-AzApplicationGatewaySslCertificate

Get-AzApplicationGatewaySslCertificate

New-AzApplicationGatewaySslCertificate

Remove-AzApplicationGatewaySslCertificate