< Back
Install-ACMECertificate
Post
NAME Install-ACMECertificate
SYNOPSIS
Invokes an Installer to install a PKI certificate.
SYNTAX
Install-Certificate [-CertificateRef] <string> -InstallerProfileRef <string> [-InstallerParameters <Hashtable>]
[-VaultProfile <string>] [<CommonParameters>]
Install-Certificate [-CertificateRef] <string> -Installer <string> [-InstallerParameters <Hashtable>]
[-VaultProfile <string>] [<CommonParameters>]
DESCRIPTION
Use this cmdlet to invoke an instance of an Installer Provider defined by a profile stored in an ACMESharp Vault.
The profile will specify the provider name as well as any parameters that will be applied during the instance
creation and invocation. Alternatively, you can specify all the details captured in a profile "inline" during this
cmdlet's invocation.
PARAMETERS
-CertificateRef <string>
A reference (ID or alias) to a previously retrieved and resolved Certificated provided by an ACME CA Server.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Ref <string>
A reference (ID or alias) to a previously retrieved and resolved Certificated provided by an ACME CA Server.
This is an alias of the CertificateRef parameter.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstallerProfileRef <string>
Specifies a reference (ID or alias) to a previously defined Installer profile in the associated Vault that
defines the Installer provider and associated instance parameters that should be used to install the
certificate.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Installer <string>
Specifies the Installer instance provider that will be used to install the associated certificate.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstallerParameters <Hashtable>
Specifies the parameters that will be passed to the Installer instance that will be used to install the
associated certificate.
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
-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
Get-InstallerProfile
Set-InstallerProfile
SYNOPSIS
Invokes an Installer to install a PKI certificate.
SYNTAX
Install-Certificate [-CertificateRef] <string> -InstallerProfileRef <string> [-InstallerParameters <Hashtable>]
[-VaultProfile <string>] [<CommonParameters>]
Install-Certificate [-CertificateRef] <string> -Installer <string> [-InstallerParameters <Hashtable>]
[-VaultProfile <string>] [<CommonParameters>]
DESCRIPTION
Use this cmdlet to invoke an instance of an Installer Provider defined by a profile stored in an ACMESharp Vault.
The profile will specify the provider name as well as any parameters that will be applied during the instance
creation and invocation. Alternatively, you can specify all the details captured in a profile "inline" during this
cmdlet's invocation.
PARAMETERS
-CertificateRef <string>
A reference (ID or alias) to a previously retrieved and resolved Certificated provided by an ACME CA Server.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Ref <string>
A reference (ID or alias) to a previously retrieved and resolved Certificated provided by an ACME CA Server.
This is an alias of the CertificateRef parameter.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstallerProfileRef <string>
Specifies a reference (ID or alias) to a previously defined Installer profile in the associated Vault that
defines the Installer provider and associated instance parameters that should be used to install the
certificate.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Installer <string>
Specifies the Installer instance provider that will be used to install the associated certificate.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstallerParameters <Hashtable>
Specifies the parameters that will be passed to the Installer instance that will be used to install the
associated certificate.
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
-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
Get-InstallerProfile
Set-InstallerProfile