Set-AzureRmApiManagementCertificate

NAME Set-AzureRmApiManagementCertificate



SYNOPSIS

Modifies an API Management certificate which is configured for mutual authentication with backend.





SYNTAX

Set-AzureRmApiManagementCertificate -CertificateId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]

[-PassThru] -PfxBytes <Byte[]> -PfxPassword <String> [<CommonParameters>]



Set-AzureRmApiManagementCertificate -CertificateId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]

[-PassThru] -PfxFilePath <String> -PfxPassword <String> [<CommonParameters>]





DESCRIPTION

The Set-AzureRmApiManagementCertificate cmdlet modifies an Azure API Management certificate.





PARAMETERS

-CertificateId <String>

Specifies the ID of the certificate to modify.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Context <PsApiManagementContext>

Specifies a PsApiManagementContext object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

passthru



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PfxBytes <Byte[]>

Specifies an array of bytes of the certificate file in .pfx format. This parameter is required if you do not specify the PfxFilePath parameter.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PfxFilePath <String>

Specifies the path to the certificate file in .pfx format to create and upload. This parameter is required if you do not specify the PfxBytes

parameter.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PfxPassword <String>

Specifies the password for the certificate.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate







NOTES









Example 1: Modify a certificate



PS C:\\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Set-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -PfxFilePath

"C:\\contoso\\certificates\\apimanagementnew.pfx" -PfxPassword "2222"



This command modifies the specified API Management certificate.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ertificate

Get-AzureRmApiManagementCertificate

New-AzureRmApiManagementCertificate

Remove-AzureRmApiManagementCertificate