< Back
Complete-ACMEChallenge
Post
NAME Complete-ACMEChallenge
SYNOPSIS
Completes a Challenge using a prescribed Handler.
SYNTAX
Complete-Challenge [-IdentifierRef] <string> -HandlerProfileRef <string> [-HandlerParameters <Hashtable>]
[-CleanUp <SwitchParameter>] [-RepeatDecoder <SwitchParameter>] [-RepeatHandler <SwitchParameter>] [-UseBaseUri
<SwitchParameter>] [-VaultProfile <string>] [-Force <SwitchParameter>] [<CommonParameters>]
Complete-Challenge [-IdentifierRef] <string> [-ChallengeType] <string> -Handler <string> [-HandlerParameters
<Hashtable>] [-CleanUp <SwitchParameter>] [-RepeatDecoder <SwitchParameter>] [-RepeatHandler <SwitchParameter>]
[-UseBaseUri <SwitchParameter>] [-VaultProfile <string>] [-Force <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
Use this cmdlet to complete a Challenge associated with an Identifier defined in an ACMESharp Vault that has been
submitted for verification to an ACME CA Server.
PARAMETERS
-IdentifierRef <string>
A reference (ID or alias) to a previously defined Identifier submitted to the ACME CA Server for verification.
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 Identifier submitted to the ACME CA Server for verification.
This is an alias of the IdentifierRef parameter.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HandlerProfileRef <string>
Specifies a reference (ID or alias) to a previously defined Challenge Handler profile in the associated Vault
that defines the Handler provider and associated instance parameters that should be used to resolve the
Challenge.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ChallengeType <string>
Specifies the ACME Challenge type that should be handled. This type is expected to be found in the list of
Challenges returned by the ACME CA Server for the associated Identifier.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Handler <string>
Specifies the Challenge Handler instance provider that will be used to handle the associated Challenge.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HandlerParameters <Hashtable>
Specifies the parameters that will be passed to the Challenge Handler instance that will be used to handle the
associated Challenge.
If this cmdlet is invoked *in-line*, then these are the only parameters that will be passed to the handler. If
this cmdlet is invoked with a handler profile reference, then these parameters are merged with, and override,
whatever parameters are already defined within the profile.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CleanUp <SwitchParameter>
When specified, executes the clean up operation associated with the resolved Challenge Handler. This is
typcially invoked after the challenge has been previously successfully completed and submitted to the ACME
server, and is used to remove any residual resources or traces of the steps that were needed during the
challenge-handling process.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RepeatDecoder <SwitchParameter>
When specified, will force the decoding and regeneration of any ACME-defined heuristics and parameters for the
given Challenge type.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Regenerate <SwitchParameter>
When specified, will force the decoding and regeneration of any ACME-defined heuristics and parameters for the
given Challenge type.
This is an alias of the RepeatDecoder parameter.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RepeatHandler <SwitchParameter>
When specified, forces the resolved Handler to repeat the process of handling the given Challenge, even if the
process has already been completed previously.
Required? false
Position? named
Default value False
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
-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
-Force <SwitchParameter>
Forces an attempt to complete the challenge even when the state of the current Identifier authorization is in
a failed or completed state.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
Get-ChallengeHandlerProfile
Set-ChallengeHandlerProfile
SYNOPSIS
Completes a Challenge using a prescribed Handler.
SYNTAX
Complete-Challenge [-IdentifierRef] <string> -HandlerProfileRef <string> [-HandlerParameters <Hashtable>]
[-CleanUp <SwitchParameter>] [-RepeatDecoder <SwitchParameter>] [-RepeatHandler <SwitchParameter>] [-UseBaseUri
<SwitchParameter>] [-VaultProfile <string>] [-Force <SwitchParameter>] [<CommonParameters>]
Complete-Challenge [-IdentifierRef] <string> [-ChallengeType] <string> -Handler <string> [-HandlerParameters
<Hashtable>] [-CleanUp <SwitchParameter>] [-RepeatDecoder <SwitchParameter>] [-RepeatHandler <SwitchParameter>]
[-UseBaseUri <SwitchParameter>] [-VaultProfile <string>] [-Force <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
Use this cmdlet to complete a Challenge associated with an Identifier defined in an ACMESharp Vault that has been
submitted for verification to an ACME CA Server.
PARAMETERS
-IdentifierRef <string>
A reference (ID or alias) to a previously defined Identifier submitted to the ACME CA Server for verification.
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 Identifier submitted to the ACME CA Server for verification.
This is an alias of the IdentifierRef parameter.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HandlerProfileRef <string>
Specifies a reference (ID or alias) to a previously defined Challenge Handler profile in the associated Vault
that defines the Handler provider and associated instance parameters that should be used to resolve the
Challenge.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ChallengeType <string>
Specifies the ACME Challenge type that should be handled. This type is expected to be found in the list of
Challenges returned by the ACME CA Server for the associated Identifier.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Handler <string>
Specifies the Challenge Handler instance provider that will be used to handle the associated Challenge.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HandlerParameters <Hashtable>
Specifies the parameters that will be passed to the Challenge Handler instance that will be used to handle the
associated Challenge.
If this cmdlet is invoked *in-line*, then these are the only parameters that will be passed to the handler. If
this cmdlet is invoked with a handler profile reference, then these parameters are merged with, and override,
whatever parameters are already defined within the profile.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CleanUp <SwitchParameter>
When specified, executes the clean up operation associated with the resolved Challenge Handler. This is
typcially invoked after the challenge has been previously successfully completed and submitted to the ACME
server, and is used to remove any residual resources or traces of the steps that were needed during the
challenge-handling process.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RepeatDecoder <SwitchParameter>
When specified, will force the decoding and regeneration of any ACME-defined heuristics and parameters for the
given Challenge type.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Regenerate <SwitchParameter>
When specified, will force the decoding and regeneration of any ACME-defined heuristics and parameters for the
given Challenge type.
This is an alias of the RepeatDecoder parameter.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RepeatHandler <SwitchParameter>
When specified, forces the resolved Handler to repeat the process of handling the given Challenge, even if the
process has already been completed previously.
Required? false
Position? named
Default value False
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
-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
-Force <SwitchParameter>
Forces an attempt to complete the challenge even when the state of the current Identifier authorization is in
a failed or completed state.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
Get-ChallengeHandlerProfile
Set-ChallengeHandlerProfile