< Back

Get-AzureRmApiManagementCertificate

Tue Jan 29, 2019 9:29 pm

NAME Get-AzureRmApiManagementCertificate



SYNOPSIS

Gets API Management certificates configured for Mutual Authentication with Backend in the service.





SYNTAX

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

[-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmApiManagementCertificate cmdlet gets all Azure API Management certificates or certificates that you specify.





PARAMETERS

-CertificateId <String>

Specifies the ID of the certificate to get.



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



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

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: Get all certificates



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

PS C:\\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext



This command gets all API Management certificates.





Example 2: Get a certificate by its ID



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

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



This command gets the API Management certificate with the specified ID.







RELATED LINKS

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

New-AzureRmApiManagementCertificate

Remove-AzureRmApiManagementCertificate

Set-AzureRmApiManagementCertificate