PSCredentialStore/docs/Get-CredentialStore.md
Marco Blessing e3404666d4
All checks were successful
continuous-integration/drone/push Build is passing
update references (#60)
#### 📖 Summary

- Replace all github refs with gitea url

#### 📑 Test Plan

> 💡 Select your test plan for the code changes.

- [x] Tested via Drone.io pipeline
- [ ] Custom test
- [ ] No test plan

##### Details / Justification

<!-- Add your test details or justification for missing tests here. -->

#### 📚 Additional Notes

<!-- A place for additional detail notes. -->

Co-authored-by: OCram85 <marco.blessing@googlemail.com>
Reviewed-on: #60
2022-07-13 08:34:31 +02:00

1.8 KiB

external help file Module Name schema
PSCredentialStore-help.xml PSCredentialStore 2.0.0

Get-CredentialStore

SYNOPSIS

Reads the complete content of the credential store and returns it as a new object.

SYNTAX

Private (Default)

Get-CredentialStore [<CommonParameters>]

Shared

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

DESCRIPTION

The content is in a raw format. It means there is no transformation to the different credential types. You can not use the object properties to connect with remote host. Therefore please use Get-CredentialStoreItem.

EXAMPLES

EXAMPLE 1

$CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json"

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

[None]

OUTPUTS

[PSObject] Returns the credential store content as PSObject.

NOTES