< Back

Get-ACMECertificate

Fri Jan 10, 2020 6:42 pm

NAME Get-ACMECertificate



SYNOPSIS

Gets the status and details of a Certificate stored in the Vault.





SYNTAX

Get-Certificate [-CertificateRef] <string> [-ExportKeyPEM <string>] [-ExportCsrPEM <string>]

[-ExportCertificatePEM <string>] [-ExportCertificateDER <string>] [-ExportIssuerPEM <string>] [-ExportIssuerDER

<string>] [-ExportPkcs12 <string>] [-CertificatePassword <string>] [-Overwrite <SwitchParameter>] [-VaultProfile

<string>] [-PkiTool <string>] [<CommonParameters>]





DESCRIPTION

This cmdlet retrieves the details of a Certificate defined in the Vault. It is also used to export various

artificates associated with the Certificate to various formats.





PARAMETERS

-CertificateRef <string>

A reference (ID or alias) to a previously defined Certificate request.



Required? true

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Ref <string>

A reference (ID or alias) to a previously defined Certificate request.



This is an alias of the CertificateRef parameter.



Required? true

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportKeyPEM <string>

Optionally, specifies a file path where the private key associated with the referenced Certificate will be

saved in PEM format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportCsrPEM <string>

Optionally, specifies a file path where the CSR associated with the referenced Certificate will be saved in

PEM format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportCertificatePEM <string>

Optionally, specifies a file path where the referenced Certificate will be saved in PEM format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportCertificateDER <string>

Optionally, specifies a file path where the referenced Certificate will be saved in DER format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportIssuerPEM <string>

Optionally, specifies a file path where the referenced Issuer Certificate will be saved in PEM format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportIssuerDER <string>

Optionally, specifies a file path where the referenced Issuer Certificate will be saved in DER format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ExportPkcs12 <string>

Optionally, specifies a file path where the referenced Certificate and related artifacts will be saved into a

PKCS#12 archive format.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificatePassword <string>

Optionally, specifies a password to use to secure an exported PKCS#12 archive file.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Overwrite <SwitchParameter>

This flag indicates that any existing files matching any of the requested export parameter paths will be

overwritten. If not specified, existing files will cause this cmdlet to error.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-VaultProfile <string>

Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations

and storage/retrieval of all related assets.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PkiTool <string>

Specifies a PKI tool provider (i.e. CertificateProvider) to be used in all PKI related operations such as

private key generation, CSR generation and certificate importing and exporting. If left unspecified a default

PKI tool provider will be used.



Required? false

Position? named

Default value

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

ACMESharp.Vault.Model.CertificateInfo







RELATED LINKS

New-Certificate

Submit-Certificate

Update-Certificate