PSCredentialStore/docs/Test-CredentialStore.md
OCram85 d4633d4b80
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
update docs
2022-07-19 11:27:12 +02:00

1.5 KiB

external help file Module Name online version schema
ModuleRoot-help.xml PSCredentialStore 2.0.0

Test-CredentialStore

SYNOPSIS

Returns the credential store state.

SYNTAX

Private (Default)

Test-CredentialStore [<CommonParameters>]

Shared

Test-CredentialStore [-Path <String>] [-Shared] [<CommonParameters>]

DESCRIPTION

Use this script to test your credential store. For now it only checks if the file exists.

EXAMPLES

EXAMPLE 1

Test-CredentialStore -eq $true

PARAMETERS

-Path

Define a custom path to a shared CredentialStore.

Type: String
Parameter Sets: Shared
Aliases:

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

-Shared

Switch to shared mode with this param. This enforces the command to work with a shared CredentialStore which can be decrypted across systems.

Type: SwitchParameter
Parameter Sets: Shared
Aliases:

Required: True
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

OUTPUTS

System.Boolean

NOTES