Get-CBOrder

NAME Get-CBOrder



SYNOPSIS

Gets an order from CloudBolt.





SYNTAX

Get-CBOrder [-Session] <Object> [-ID] <Object> [<CommonParameters>]





DESCRIPTION

The `Get-CBOrder` function gets an order from CloudBolt. Pass the session to the target CloudBolt instance to the

`Session` parameter. Pass the ID of the order to the `ID` parameter. You can also pipe order objects or order IDs

to the `Get-CBOrder`. Order objects must have an `ID` property.



Use the `New-CBSession` function to create a session object.





PARAMETERS

-Session <Object>

The session/connecton to the CloudBolt instance to use. Use `New-CBSession` to create a session object.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <Object>

The order's ID.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-CBOrder -Session $session -ID 54



Demonstrates how to get a specific order by passing its ID to the `ID` parameter.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$order | Get-CBOrder -Session $session



Demonstrates how to get a specific order by piping an order object to `Get-CBOrder`.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>65 | Get-CBOrder -Session $session



Demonstrates how to get a specific order by piping the order's id to `Get-CBOrder`.











RELATED LINKS