Skip to content

Add-PodeOAComponentParameter

SYNOPSIS

Adds a reusable component for a request parameter.

SYNTAX

Add-PodeOAComponentParameter [[-Name] <String>] [-Parameter] <Hashtable> [<CommonParameters>]

DESCRIPTION

Adds a reusable component for a request parameter.

EXAMPLES

EXAMPLE 1

New-PodeOAIntProperty -Name 'userId' | ConvertTo-PodeOAParameter -In Query | Add-PodeOAComponentParameter -Name 'UserIdParam'

PARAMETERS

-Name

The reference Name of the parameter.

Type: String
Parameter Sets: (All)
Aliases:

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

-Parameter

The Parameter to use for the component (from ConvertTo-PodeOAParameter)

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

NOTES