Skip to content

Get FSCPSSettings

onikolaiev edited this page May 1, 2024 · 1 revision

external help file: fscps.tools-help.xml Module Name: fscps.tools online version: schema: 2.0.0

Get-FSCPSSettings

SYNOPSIS

Get the FSCPS configuration details

SYNTAX

Get-FSCPSSettings [[-SettingsJsonString] <String>] [[-SettingsJsonPath] <String>] [-OutputAsHashtable]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Get the FSCPS configuration details from the configuration store

All settings retrieved from this cmdlets is to be considered the default parameter values across the different cmdlets

EXAMPLES

EXAMPLE 1

Get-FSCPSSettings

This will output the current FSCPS configuration. The object returned will be a PSCustomObject.

EXAMPLE 2

Get-FSCPSSettings -OutputAsHashtable

This will output the current FSCPS configuration. The object returned will be a Hashtable.

PARAMETERS

-SettingsJsonString

String contains settings JSON

Type: String
Parameter Sets: (All)
Aliases:

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

-SettingsJsonPath

String contains path to the settings.json

Type: String
Parameter Sets: (All)
Aliases:

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

-OutputAsHashtable

Instruct the cmdlet to return a hashtable object

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

OUTPUTS

NOTES

Tags: Environment, Url, Config, Configuration, LCS, Upload, ClientId

Author: Oleksandr Nikolaiev (@onikolaiev)

RELATED LINKS

Set-FSCPSSettings

Clone this wiki locally