< Back
Update-ACMEIdentifier
Post
NAME Update-ACMEIdentifier
SYNOPSIS
Updates the status and details of an Identifier stored in the Vault.
SYNTAX
Update-Identifier [-IdentifierRef] <string> [-ChallengeType] <string> [-UseBaseUri <SwitchParameter>] [-NewAlias
<string>] [-Label <string>] [-Memo <string>] [-VaultProfile <string>] [<CommonParameters>]
Update-Identifier [-IdentifierRef] <string> [-UseBaseUri <SwitchParameter>] [-NewAlias <string>] [-Label <string>]
[-Memo <string>] [-VaultProfile <string>] [<CommonParameters>]
Update-Identifier [-IdentifierRef] <string> [-LocalOnly <SwitchParameter>] [-NewAlias <string>] [-Label <string>]
[-Memo <string>] [-VaultProfile <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 an Identifier by probing the associated ACME CA Server for
Identifier details.
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
-ChallengeType <string>
Specifies the ACME Challenge type that should be updated.
Required? true
Position? 1
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
-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 Identifier 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 Identifier 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
Identifier.
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
<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
New-Identifier
Get-Identifier
Complete-Challenge
Submit-Challenge
SYNOPSIS
Updates the status and details of an Identifier stored in the Vault.
SYNTAX
Update-Identifier [-IdentifierRef] <string> [-ChallengeType] <string> [-UseBaseUri <SwitchParameter>] [-NewAlias
<string>] [-Label <string>] [-Memo <string>] [-VaultProfile <string>] [<CommonParameters>]
Update-Identifier [-IdentifierRef] <string> [-UseBaseUri <SwitchParameter>] [-NewAlias <string>] [-Label <string>]
[-Memo <string>] [-VaultProfile <string>] [<CommonParameters>]
Update-Identifier [-IdentifierRef] <string> [-LocalOnly <SwitchParameter>] [-NewAlias <string>] [-Label <string>]
[-Memo <string>] [-VaultProfile <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 an Identifier by probing the associated ACME CA Server for
Identifier details.
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
-ChallengeType <string>
Specifies the ACME Challenge type that should be updated.
Required? true
Position? 1
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
-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 Identifier 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 Identifier 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
Identifier.
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
<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
New-Identifier
Get-Identifier
Complete-Challenge
Submit-Challenge