DSInternals/Documentation/PowerShell/Get-ADKeyCredential.md
Michael Grafnetter 85b48b32df - Added the Add-ADReplNgcKey cmdlet
- Added the UserPrincipalName parameter to Get-ADReplAccount cmdlet
- Improved DRS_MSG_GETCHGREQ_V8 delete
- Fixed Set-ADDBBootKey cmdlet output type
- Fixed some formatting inconsistencies
2019-08-24 23:07:57 +02:00

3.8 KiB

external help file Module Name online version schema
DSInternals.PowerShell.dll-Help.xml DSInternals https://github.com/MichaelGrafnetter/DSInternals/blob/master/Documentation/PowerShell/Get-ADKeyCredential.md 2.0.0

Get-ADKeyCredential

SYNOPSIS

Creates an object representing Windows Hello for Business or FIDO credentials from its binary representation or an X.509 certificate.

SYNTAX

FromUserCertificate (Default)

Get-ADKeyCredential [-Certificate] <X509Certificate2> [-DeviceId] <Guid> -HolderDN <String>
 [-CreationTime <DateTime>] [<CommonParameters>]

FromDNBinary

Get-ADKeyCredential [-DNWithBinaryData] <String[]> [<CommonParameters>]

FromBinary

Get-ADKeyCredential -BinaryData <Byte[]> -HolderDN <String> [<CommonParameters>]

FromComputerCertificate

Get-ADKeyCredential [-Certificate] <X509Certificate2> -HolderDN <String> [-CreationTime <DateTime>]
 [-IsComputerKey] [<CommonParameters>]

DESCRIPTION

{{Fill in the Description}}

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-BinaryData

Specifies the credentials in binary/hexadecimal format.

Type: Byte[]
Parameter Sets: FromBinary
Aliases: Binary

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Certificate

Specifies a certificate that wraps an NGC key.

Type: X509Certificate2
Parameter Sets: FromUserCertificate, FromComputerCertificate
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreationTime

Specifies the time when the key was created. Default value is the current time.

Type: DateTime
Parameter Sets: FromUserCertificate, FromComputerCertificate
Aliases: CreatedTime, TimeCreated, TimeGenerated

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeviceId

Specifies an identifier (typically objectGUID) of the associated computer.

Type: Guid
Parameter Sets: FromUserCertificate
Aliases: ComputerId, ComputerGuid

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DNWithBinaryData

Specifies the credentials in the DN-Binary syntax.

Type: String[]
Parameter Sets: FromDNBinary
Aliases: DNWithBinary, DistinguishedNameWithBinary

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-HolderDN

Specifies the distinguished name (DN) of the object that these credentials are associated with.

Type: String
Parameter Sets: FromUserCertificate, FromBinary, FromComputerCertificate
Aliases: DistinguishedName, DN, ObjectDN

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsComputerKey

Indicates that the resulting key credential must meet the DS-Validated-Write-Computer requirements.

Type: SwitchParameter
Parameter Sets: FromComputerCertificate
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String[]

OUTPUTS

DSInternals.Common.Data.KeyCredential

NOTES

Add-ADReplNgcKey Get-ADReplAccount Get-ADDBAccount