Invoke-TppRestMethod

SYNOPSIS

Generic REST API call

SYNTAX

Session (Default)

Invoke-TppRestMethod -TppSession <TppSession> -Method <String> [-UriRoot <String>] -UriLeaf <String>
 [-Header <Hashtable>] [-Body <Hashtable>] [<CommonParameters>]

URL

Invoke-TppRestMethod -ServerUrl <String> [-UseDefaultCredentials] -Method <String> [-UriRoot <String>]
 -UriLeaf <String> [-Header <Hashtable>] [-Body <Hashtable>] [<CommonParameters>]

DESCRIPTION

Generic REST API call

EXAMPLES

EXAMPLE 1


PARAMETERS

-TppSession

TppSession object from New-TppSession. For typical calls to New-TppSession, the object will be stored as a session object named $TppSession. Otherwise, if -PassThru was used, provide the resulting object.

Type: TppSession
Parameter Sets: Session
Aliases:

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

-ServerUrl

{{ Fill ServerUrl Description }}

Type: String
Parameter Sets: URL
Aliases:

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

-UseDefaultCredentials

{{ Fill UseDefaultCredentials Description }}

Type: SwitchParameter
Parameter Sets: URL
Aliases:

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

-Method

API method, either get, post, patch, put or delete.

Type: String
Parameter Sets: (All)
Aliases:

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

-UriRoot

{{ Fill UriRoot Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-UriLeaf

Path to the api endpoint excluding the base url and site, eg. certificates/import

Type: String
Parameter Sets: (All)
Aliases:

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

-Header

Optional additional headers. The authorization header will be included automatically.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Body

Optional body to pass to the endpoint

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

None

OUTPUTS

PSCustomObject

NOTES