Skip to content

Get-PodeState

SYNOPSIS

Retrieves some state object from the shared state.

SYNTAX

Get-PodeState [-Name] <String> [-WithScope] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves some state object from the shared state.

EXAMPLES

EXAMPLE 1

Get-PodeState -Name 'Data'

PARAMETERS

-Name

The name of the state object.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
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

-WithScope

If supplied, the state's value and scope will be returned as a hashtable.

Type: SwitchParameter
Parameter Sets: (All)
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.

INPUTS

OUTPUTS

NOTES