Skip to content

Set-PodeState

SYNOPSIS

Sets an object within the shared state.

SYNTAX

Set-PodeState [-Name] <String> [[-Value] <Object>] [[-Scope] <String[]>] [<CommonParameters>]

DESCRIPTION

Sets an object within the shared state.

EXAMPLES

EXAMPLE 1

Set-PodeState -Name 'Data' -Value @{ 'Name' = 'Rick Sanchez' }

EXAMPLE 2

Set-PodeState -Name 'Users' -Value @('user1', 'user2') -Scope General, Users

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

-Scope

An optional Scope for the state object, used when saving the state.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Value

The value to set in the state.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
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.Object

NOTES