PSCredentialStore/docs/New-CredentialStore.md
Marco Blessing 2422afbd8f
Publish version 0.2.1.X (#18)
- fix pester test execution order in vscode test task.
- fix coveralls.io link in bagde.
- skip coverage report creation for PR triggered builds
- update docs
- Connection type SCP added for `Connect-To` and `Disconnect-From`.

## Internal Changes
- pester tests now don't need to dotsource other public functions from the same module (fixes #17 )
  - helper and private functions stilll needs to be dotsourced.
- basic module tests added
- pester tests for `Resolve-Dependency` added
- Wrapper function  `Get-ModuleBase` added. This enables mocking in tests.
2018-03-09 14:02:51 +01:00

2.8 KiB

external help file Module Name online version schema
PSCredentialStore-help.xml PSCredentialStore https://github.com/OCram85/PSCredentialStore 2.0.0

New-CredentialStore

SYNOPSIS

Creates a new credential store File

SYNTAX

Private (Default)

New-CredentialStore [-Force] [<CommonParameters>]

Shared

New-CredentialStore [-Shared] [-Path <String>] [-Force] [<CommonParameters>]

DESCRIPTION

You need to run this script first to create a new credential store before you try to save new credentials with New-CredentialStoreItem.

EXAMPLES

EXAMPLE 1

New-CredentialStore

Creates a new private CredentialStore

EXAMPLE 2

New-CredentialStore -Force

Resets an existing private CredentialStore

EXAMPLE 3

New-CredentialStore -Shared

Creates a new shared CredentialStore

EXAMPLE 4

New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json"

Creates a new shared CredentialStore in the given location.

PARAMETERS

-Force

Use this switch to reset an existing store. The complete content will be wiped.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Path

Define a location for the new shared CredentialStore. The default store will be created in $Env:ProgramData\PSCredentialStore dir.

Type: String
Parameter Sets: Shared
Aliases:

Required: False
Position: Named
Default value: "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData
Accept pipeline input: False
Accept wildcard characters: False

-Shared

Creates a CredentialStore in the Shared mode. This enables you to read the CredentialStore Items on different systems or profiles. In addition you can optionally provide a custom path wit the -Path parameter.

Type: SwitchParameter
Parameter Sets: Shared
Aliases:

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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

[None]

OUTPUTS

[None]

NOTES

``` File Name : New-CredentialStore.ps1 Author : Marco Blessing - marco.blessing@googlemail.com Requires : ```

https://github.com/OCram85/PSCredentialStore