< Back
Update-ACMECertificate
Post
NAME Update-ACMECertificate
SYNOPSIS
Updates the status and details of a Certificate stored in the Vault.
SYNTAX
Update-Certificate [-CertificateRef] <string> [-UseBaseUri <SwitchParameter>] [-Repeat <SwitchParameter>]
[-NewAlias <string>] [-Label <string>] [-Memo <string>] [-VaultProfile <string>] [-PkiTool <string>]
[<CommonParameters>]
Update-Certificate [-CertificateRef] <string> [-LocalOnly <SwitchParameter>] [-NewAlias <string>] [-Label
<string>] [-Memo <string>] [-VaultProfile <string>] [-PkiTool <string>] [<CommonParameters>]
DESCRIPTION
Use this cmdlet to update characteristics of an Identifier that are defined locally, such as the Alias or Label.
Also use this cmdlet to refresh the state and status of a Certificate including retrieving the certificate and
intermediate signing certificate from the associated ACME CA Server.
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
-UseBaseUri <SwitchParameter>
Overrides the base URI associated with the target Registration and used for subsequent communication with the
associated ACME CA Server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Repeat <SwitchParameter>
When specified, this flag instructs the cmdlet to repeat the retrieval of the issued certificate and related
artifacts (e.g. intermediate signing cert).
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LocalOnly <SwitchParameter>
Indicates that updates should be performed locally only, and no attempt should be made to retrieve the current
status from the ACME CA Server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NewAlias <string>
Optionaly, set or update the unique alias assigned to the Certificate for future reference. To remove the
alias, use the empty string.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Label <string>
Optionally, set or update the human-friendly label to assigned to the Certificate for easy recognition.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Memo <string>
Optionall, set or update the arbitrary text field used to capture any notes or details associated with the
Certificate.
Required? false
Position? named
Default value
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
Get-Certificate
Submit-Certificate
SYNOPSIS
Updates the status and details of a Certificate stored in the Vault.
SYNTAX
Update-Certificate [-CertificateRef] <string> [-UseBaseUri <SwitchParameter>] [-Repeat <SwitchParameter>]
[-NewAlias <string>] [-Label <string>] [-Memo <string>] [-VaultProfile <string>] [-PkiTool <string>]
[<CommonParameters>]
Update-Certificate [-CertificateRef] <string> [-LocalOnly <SwitchParameter>] [-NewAlias <string>] [-Label
<string>] [-Memo <string>] [-VaultProfile <string>] [-PkiTool <string>] [<CommonParameters>]
DESCRIPTION
Use this cmdlet to update characteristics of an Identifier that are defined locally, such as the Alias or Label.
Also use this cmdlet to refresh the state and status of a Certificate including retrieving the certificate and
intermediate signing certificate from the associated ACME CA Server.
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
-UseBaseUri <SwitchParameter>
Overrides the base URI associated with the target Registration and used for subsequent communication with the
associated ACME CA Server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Repeat <SwitchParameter>
When specified, this flag instructs the cmdlet to repeat the retrieval of the issued certificate and related
artifacts (e.g. intermediate signing cert).
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LocalOnly <SwitchParameter>
Indicates that updates should be performed locally only, and no attempt should be made to retrieve the current
status from the ACME CA Server.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NewAlias <string>
Optionaly, set or update the unique alias assigned to the Certificate for future reference. To remove the
alias, use the empty string.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Label <string>
Optionally, set or update the human-friendly label to assigned to the Certificate for easy recognition.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Memo <string>
Optionall, set or update the arbitrary text field used to capture any notes or details associated with the
Certificate.
Required? false
Position? named
Default value
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
Get-Certificate
Submit-Certificate