Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Test-KdsRootKey

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Tests the root key configuration.

SYNTAX

Test-KdsRootKey [-KeyId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Test-KdsRootKey cmdlet tests that the root key with the specified key identifier (ID) uses a valid configuration. The test verifies generation of both new group public key and group private key.

This cmdlet is useful for analyzing failures based on invalid root key configuration failures.

EXAMPLES

Example 1: Test the root key configuration

PS C:\> Test-KdsRootKey -KeyId 4A3615F1-5A90-22E4-0B1D-1416F93D4412

This command tests the configuration of the root key specified by key ID.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-KeyId

Specifies the ID of the root key to test.

Type: Guid
Parameter Sets: (All)
Aliases: 

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
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

None

This cmdlet accepts no input objects.

OUTPUTS

System.Boolean

This cmdlet returns whether the root key can be used to generate derived keys.

NOTES

Add-KdsRootKey

Clear-KdsCache

Get-KdsConfiguration

Set-KdsConfiguration

Add-KdsRootKey

© 2017 Microsoft