You can interact with the ToRainDrop API from any language or plaftorm. However, to help accelerate adoption we provide a simple PowerShell library (ToRainDropPS) to interact with the ToRainDrop API using familiar PowerShell verbs and nouns.
$ToRainDropPSModuleRepository = @{
Name = "ToRainDropPSRepository"
SourceLocation = "https://modules.beta-powershell.toraindrop.cloud/api"
};
Register-PSRepository @ToRainDropPSModuleRepository;
Get-PSRepository;Find-Package -Source "ToRainDropPSRepository" -Name "ToRainDropPS";Install-Module -Name "ToRainDropPS" -Repository "ToRainDropPSRepository";
## OR ##
Save-Module -Name "ToRainDropPS" -Repository "ToRainDropPSRepository" -Path "C:\<Your-PowerShell-Modules-Path>\";
Import-Module "C:\<Your-PowerShell-Modules-Path>\ToRainDropPS";
Unregister-PSRepository -Name "ToRainDropPSRepository";
Get-PSRepository;Sets the ToRainDrop ClientID and APIToken.
Connect-ToRainDrop [[-ClientID] <String>] [[-Token] <String>] [<CommonParameters>]
Sets both the ClientID and APIToken for the current ToRainDrop Session.
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
Connect-ToRainDrop;
Connect-ToRainDrop -ClientID $myToRainDropClientIDString -Token $myToRainDropAPITokenString;
(Optional) Specifies the ClientID Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the APIToken Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Connect-ToRainDrop
Disconnect-ToRainDrop
Clears the ToRainDrop ClientID and APIToken.
Disconnect-ToRainDrop
Clears / Removes both the ClientID and APIToken for the current ToRainDrop Session.
Disconnect-ToRainDrop;
Connect-ToRainDrop
Disconnect-ToRainDrop
Gets the ToRainDrop ClientID.
Get-ToRainDropClientID
Gets the ClientID for the current ToRainDrop Session.
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Get-ToRainDropClientID;
Get-ToRainDropClientID
Set-ToRainDropClientID
Clear-ToRainDropClientID
Sets the ToRainDrop ClientID.
Set-ToRainDropClientID [-ClientID] <SecureString> [<CommonParameters>]
Sets the ClientID for the current ToRainDrop Session.
Set-ToRainDropClientID -ClientID (Read-Host "Please Enter Client ID" -AsSecureString);
(Read-Host "Please Enter Client ID" -AsSecureString) | Set-ToRainDropClientID;
Specifies the ClientID Value.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [SecureString]$ClientID objects to Set-ToRainDropClientID.
Get-ToRainDropClientID
Set-ToRainDropClientID
Clear-ToRainDropClientID
Clears the ToRainDrop ClientID.
Clear-ToRainDropClientID
Clears / Removes the ClientID for the current ToRainDrop Session.
Clear-ToRainDropClientID;
Get-ToRainDropClientID
Set-ToRainDropClientID
Clear-ToRainDropClientID
Gets the ToRainDrop APIToken.
Get-ToRainDropAPIToken
Gets the APIToken for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
Get-ToRainDropAPIToken;
Get-ToRainDropAPIToken
Set-ToRainDropAPIToken
Clear-ToRainDropAPIToken
Sets the ToRainDrop APIToken.
Set-ToRainDropAPIToken [-Token] <SecureString> [<CommonParameters>]
Sets the APIToken for the current ToRainDrop Session.
Set-ToRainDropAPIToken -Token (Read-Host "Please Enter API Token" -AsSecureString);
(Read-Host "Please Enter API Token" -AsSecureString) | Set-ToRainDropAPIToken;
Specifies the APIToken Value.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [SecureString]$Token objects to Set-ToRainDropAPIToken.
Get-ToRainDropAPIToken
Set-ToRainDropAPIToken
Clear-ToRainDropAPIToken
Clears the ToRainDrop APIToken.
Clear-ToRainDropAPIToken
Clears / Removes the APIToken for the current ToRainDrop Session.
Clear-ToRainDropAPIToken;
Get-ToRainDropAPIToken
Set-ToRainDropAPIToken
Clear-ToRainDropAPIToken
Create a new ToRainDropHeaders.
New-ToRainDropHeaders [[-Token] <String>] [<CommonParameters>]
Creates a new ToRainDropHeaders Dictionary.
(Optional) Token Parameter Specifies an APIToken String to be used instead of APIToken from current ToRainDrop Session.
$myNewToRainDropHeaders = New-ToRainDropHeaders;
$myNewToRainDropHeaders = New-ToRainDropHeaders -Token $myToRainDropAPITokenString;
$myNewToRainDropHeaders = $myToRainDropAPITokenString | New-ToRainDropHeaders;
(Optional) Specifies the APIToken Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [String]$Token objects to New-ToRainDropHeaders.
New-ToRainDropHeaders
New-ToRainDropRequstBody
New-ToRainDropRequest
Create a new ToRainDropRequstBody.
New-ToRainDropRequstBody [-ClientID] <String> [-Value] <String> [[-Key] <String>] [[-Parameters] <Hashtable>]
[[-ConnectionParameters] <Hashtable>] [<CommonParameters>]
Create a new ToRainDropRequstBody as a JSON String.
ClientID Parameter specifies the ClientID to be used.
Value Parameter specifies the Value to be used.
(Optional) Key Parameter specifies the Key to be used.
(Optional) Parameters Parameter specifies the Parameters to be used.
(Optional) ConnectionParameters Parameter specifies the ConnectionParameters to be used.
$myNewToRainDropRequstBody = New-ToRainDropRequstBody -ClientID $myToRainDropClientIDString -Value $MyRequstValueString;
$myParameters = @{ ExampleParameterName1 = "Example-Value-ABC-123"; ExampleParameterName2 = "Example-Value-DEF-456" };
$myNewToRainDropRequstBody = New-ToRainDropRequstBody -ClientID $myToRainDropClientIDString -Value $MyRequstValueString -Parameters $myParameters;
Specifies the ClientID Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the Value Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the Key Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the [hashtable] Parameters Value.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the [hashtable] ConnectionParameters Value.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
New-ToRainDropHeaders
New-ToRainDropRequstBody
New-ToRainDropRequest
Create a new ToRainDropRequest.
New-ToRainDropRequest [-ToRainDropRequstURI] <String> [-ToRainDropRequstBody] <String> [<CommonParameters>]
Creates and Invokes a new ToRainDropRequest.
ToRainDropRequstURI Parameter Specifies the URI used by the invoke of the ToRainDropRequest.
ToRainDropRequstBody Parameter Specifies the Body used by the invoke of the ToRainDropRequest.
$myToRainDropRequestResponse = New-ToRainDropRequest -ToRainDropRequstURI $myToRainDropRequstURI -ToRainDropRequstBody $myToRainDropRequstBody;
ToRainDropRequstURI Parameter Specifies the URI
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
ToRainDropRequstBody Parameter Specifies the Body
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
New-ToRainDropHeaders
New-ToRainDropRequstBody
New-ToRainDropRequest
Gets Details of a ToRainDropAPI.
Get-ToRainDropAPI [-APIName] <String> [[-ClientID] <String>] [[-Token] <String>] [<CommonParameters>]
Gets the Details of a ToRainDropAPI Specifed by the APIName
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
$myToRainDropAPI = Get-ToRainDropAPI -APIName "My-ToRainDropAPI-Name";
$myToRainDropAPI = "My-ToRainDropAPI-Name" | Get-ToRainDropAPI;
$myToRainDropAPI = Get-ToRainDropAPI -APIName "My-ToRainDropAPI-Name" -ClientID $myToRainDropClientIDString -Token $myToRainDropAPITokenString;
Specifies the APIName Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
(Optional) Specifies the ClientID Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the APIToken Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Get-ToRainDropAPI
New-ToRainDrop
Get-ToRainDrop
Create New ToRainDrop Execution
New-ToRainDrop [-APIBody] <Hashtable> [[-Parameters] <Hashtable>] [[-ConnectionParameters] <Hashtable>]
[[-ClientID] <String>] [[-Token] <String>] [<CommonParameters>]
Creates a New ToRainDrop Execution based on the ToRainDropAPI Specifed by the APIBody, Parameters and ConnectionParameters values.
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
$myToRainDropAPI = Get-ToRainDropAPI -APIName
"My-ToRainDropAPI-Name";
$myNewToRainDropExecution = New-ToRainDrop -APIBody $myToRainDropAPI.APIBody;
$myToRainDropAPI = Get-ToRainDropAPI -APIName "My-ToRainDropAPI-Name";
$myParameters = @{ ExampleParameterName1 = "Example-Value-ABC-123"; ExampleParameterName2 = "Example-Value-DEF-456" };
$myNewToRainDropExecution = New-ToRainDrop -APIBody $myToRainDropAPI.APIBody -Parameters $myParameters;
$myToRainDropAPI = "My-ToRainDropAPI-Name" | Get-ToRainDropAPI;
$myNewToRainDropExecution = $myToRainDropAPI.APIBody | New-ToRainDrop;
$myToRainDropAPI = "My-ToRainDropAPI-Name" | Get-ToRainDropAPI;
$myParameters = @{ ExampleParameterName1 = "Example-Value-ABC-123"; ExampleParameterName2 = "Example-Value-DEF-456" };
$myNewToRainDropExecution = $myToRainDropAPI.APIBody | New-ToRainDrop -Parameters $myParameters;
Specifies the [hashtable] APIBody Value.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
(Optional) Specifies the [hashtable] Parameters Value.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: @{}
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the [hashtable] ConnectionParameters Value.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: @{}
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the ClientID Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the APIToken Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [hashtable]$APIBody objects to New-ToRainDrop.
Get-ToRainDropAPI
New-ToRainDrop
Get-ToRainDrop
Get Result of a ToRainDrop Execution.
Get-ToRainDrop [-Key] <String> [[-ClientID] <String>] [[-Token] <String>] [<CommonParameters>]
Gets the Result Details of a ToRainDrop Execution Specifed by the Execution Key.
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
$myToRainDropResult = Get-ToRainDrop -Key $myToRainDropExecutionKeyCmdIdString;
$myToRainDropResult = $myToRainDropExecutionKeyCmdIdString | Get-ToRainDrop;
$myToRainDropResult = Get-ToRainDrop -Key $myToRainDropExecutionKeyCmdIdString -ClientID $myToRainDropClientIDString -Token $myToRainDropAPITokenString;
Specifies the Execution Key Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
(Optional) Specifies the ClientID Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the APIToken Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [String]$Key objects to Get-ToRainDrop.
Get-ToRainDropAPI
New-ToRainDrop
Get-ToRainDrop
Read CmdId of a ToRainDrop Execution Result.
Read-ToRainDropResultCmdId [-ToRainDropResult] <PSObject> [<CommonParameters>]
Gets the CmdId String of a ToRainDrop Execution Result.
$myToRainDropResultCmdID = Read-ToRainDropResultCmdId -ToRainDropResult $myToRainDropResult;
$myToRainDropResultCmdID = $myToRainDropResult | Read-ToRainDropResultCmdId;
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Read-ToRainDropResultCmdId.
Read-ToRainDropResultCmdId
Read-ToRainDropResultStatus
Read-ToRainDropResultReturns
Read-ToRainDropResultReturnByName
Read Status of a ToRainDrop Execution Result.
Read-ToRainDropResultStatus [-ToRainDropResult] <PSObject> [<CommonParameters>]
Gets the Result Status String of a ToRainDrop Execution Result.
$myToRainDropResultStatus = Read-ToRainDropResultStatus -ToRainDropResult $myToRainDropResult;
$myToRainDropResultStatus = $myToRainDropResult | Read-ToRainDropResultStatus;
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Read-ToRainDropResultStatus.
Read-ToRainDropResultCmdId
Read-ToRainDropResultStatus
Read-ToRainDropResultReturns
Read-ToRainDropResultReturnByName
Read All Returns of a ToRainDrop Execution Result.
Read-ToRainDropResultReturns [-ToRainDropResult] <PSObject> [<CommonParameters>]
Gets all of the Return Values of a ToRainDrop Execution Result.
$myToRainDropResultReturns = Read-ToRainDropResultReturns -ToRainDropResult $myToRainDropResult;
$myToRainDropResultReturns = $myToRainDropResult | Read-ToRainDropResultReturns;
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Read-ToRainDropResultReturns.
Read-ToRainDropResultCmdId
Read-ToRainDropResultStatus
Read-ToRainDropResultReturns
Read-ToRainDropResultReturnByName
Read a Return Value from a ToRainDrop Execution Result Specified by the ReturnName.
Read-ToRainDropResultReturnByName [-ToRainDropResult] <PSObject> [-ReturnName] <String>
[-IncludeReturnNameInOutput] [<CommonParameters>]
Gets any matching Return Value from a ToRainDrop Execution Result Specified by the ReturnName.
$myToRainDropResultReturn = Read-ToRainDropResultReturnByName -ToRainDropResult $myToRainDropResult -ReturnName "MyReturnName1";
$myToRainDropResultReturnWithName = Read-ToRainDropResultReturnByName -ToRainDropResult $myToRainDropResult -ReturnName "MyReturnName1" -IncludeReturnNameInOutput;
$myToRainDropResultReturn = $myToRainDropResult | Read-ToRainDropResultReturnByName -ReturnName "MyReturnName1";
$myToRainDropResultReturnWithName = $myToRainDropResult | Read-ToRainDropResultReturnByName -ReturnName "MyReturnName1" -IncludeReturnNameInOutput;
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the ReturnName Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the IncludeReturnNameInOutput Switch.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Read-ToRainDropResultReturns.
Read-ToRainDropResultCmdId
Read-ToRainDropResultStatus
Read-ToRainDropResultReturns
Read-ToRainDropResultReturnByName
Get Result of a ToRainDrop Execution and Read the Status.
Get-ToRainDropStatus -Key <String> [-ToRainDropResult <PSObject>] [<CommonParameters>]
Get-ToRainDropStatus -ToRainDropResult <PSObject> [-CheckLocalObject] [<CommonParameters>]
Gets the Result Details of a ToRainDrop Execution Specifed and Reads the Status.
(performs a Get-ToRainDrop request to Read the Status)
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
Using the -CheckLocalObject Switch Reads the Status from the (PSObject)$ToRainDropResult passed to the -ToRainDropResult parameter.
(does NOT perform a Get-ToRainDrop request to Read the Status)
$myToRainDropResultStatus = Get-ToRainDropStatus -Key $myToRainDropExecutionKeyCmdIdString;
$myToRainDropResultStatus = Get-ToRainDropStatus -ToRainDropResult $myToRainDropResult;
$myToRainDropResultStatus = Get-ToRainDropStatus -ToRainDropResult $myToRainDropResult -CheckLocalObject;
$myToRainDropResultStatus = $myToRainDropResult | Get-ToRainDropStatus;
$myToRainDropResultStatus = $myToRainDropResult | Get-ToRainDropStatus -CheckLocalObject;
$myToRainDropResultStatus = $myToRainDropExecutionKeyCmdIdString | Get-ToRainDrop | Get-ToRainDropStatus -CheckLocalObject;
Specifies the Execution Key Value.
(ParameterSet = “ToRainDropKey”)
Type: String
Parameter Sets: ToRainDropKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
(ParameterSet = “ToRainDropResult”)
Type: PSObject
Parameter Sets: ToRainDropKey
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: PSObject
Parameter Sets: ToRainDropResult
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the CheckLocalObject Switch.
(ParameterSet = “ToRainDropResult”)
Type: SwitchParameter
Parameter Sets: ToRainDropResult
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Get-ToRainDropStatus.
Using the -CheckLocalObject Switch Reads the ‘Status Value’ from the (PSObject)$ToRainDropResult passed to the -ToRainDropResult parameter and does NOT perform a Get-ToRainDrop request to Read the ‘Status Value’)
Get-ToRainDropStatus
Get-ToRainDropReturns
Get-ToRainDropReturnByName
Get Result of a ToRainDrop Execution and Read All Returns.
Get-ToRainDropReturns -Key <String> [-ToRainDropResult <PSObject>] [<CommonParameters>]
Get-ToRainDropReturns -ToRainDropResult <PSObject> [-CheckLocalObject] [<CommonParameters>]
Gets the Result Details of a ToRainDrop Execution Specifed and Reads all of the Return Values.
(performs a Get-ToRainDrop request to Read the Return Values)
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
Using the -CheckLocalObject Switch Reads the Return Values from the (PSObject)$ToRainDropResult passed to the -ToRainDropResult parameter.
(does NOT perform a Get-ToRainDrop request to Read the Return Values)
$myToRainDropResultReturns = Get-ToRainDropReturns -Key $myToRainDropExecutionKeyCmdIdString;
$myToRainDropResultReturns = Get-ToRainDropReturns -ToRainDropResult $myToRainDropResult;
$myToRainDropResultReturns = Get-ToRainDropReturns -ToRainDropResult $myToRainDropResult -CheckLocalObject;
$myToRainDropResultReturns = $myToRainDropResult | Get-ToRainDropReturns;
$myToRainDropResultReturns = $myToRainDropResult | Get-ToRainDropReturns -CheckLocalObject;
$myToRainDropResultReturns = $myToRainDropExecutionKeyCmdIdString | Get-ToRainDrop | Get-ToRainDropReturns -CheckLocalObject;
Specifies the Execution Key Value.
(ParameterSet = “ToRainDropKey”)
Type: String
Parameter Sets: ToRainDropKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
(ParameterSet = “ToRainDropResult”)
Type: PSObject
Parameter Sets: ToRainDropKey
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: PSObject
Parameter Sets: ToRainDropResult
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the CheckLocalObject Switch.
(ParameterSet = “ToRainDropResult”)
Type: SwitchParameter
Parameter Sets: ToRainDropResult
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Get-ToRainDropReturns.
Using the -CheckLocalObject Switch Reads the ‘Return Values’ from the (PSObject)$ToRainDropResult passed to the -ToRainDropResult parameter and does NOT perform a Get-ToRainDrop request to Read the ‘Return Values’).
Get-ToRainDropStatus
Get-ToRainDropReturns
Get-ToRainDropReturnByName
Get Result of a ToRainDrop Execution and Reads a Return Value Specified by the ReturnName.
Get-ToRainDropReturnByName -Key <String> [-ToRainDropResult <PSObject>] -ReturnName <String>
[-IncludeReturnNameInOutput] [<CommonParameters>]
Get-ToRainDropReturnByName -ToRainDropResult <PSObject> [-CheckLocalObject] -ReturnName <String>
[-IncludeReturnNameInOutput] [<CommonParameters>]
Gets the Result Details of a ToRainDrop Execution Specifed and Reads any matching Return Value specified by the ReturnName.
(performs a Get-ToRainDrop request to Read the Return Value)
Prompts ‘Please Enter Client ID’ if no ClientID found for the current ToRainDrop Session.
Prompts ‘Please Enter API Token’ if no APIToken found for the current ToRainDrop Session.
Using the -CheckLocalObject Switch Reads the Return Values from the (PSObject)$ToRainDropResult passed to the -ToRainDropResult parameter.
(does NOT perform a Get-ToRainDrop request to Read the matching Return Value)
$myToRainDropResultReturn = Get-ToRainDropReturnByName -Key $myToRainDropExecutionKeyCmdIdString -ReturnName "MyReturnName1";
$myToRainDropResultReturn = Get-ToRainDropReturnByName -ToRainDropResult $myToRainDropResult -ReturnName "MyReturnName1";
$myToRainDropResultReturn = Get-ToRainDropReturnByName -ToRainDropResult $myToRainDropResult -CheckLocalObject -ReturnName "MyReturnName1";
$myToRainDropResultReturn = $myToRainDropResult | Get-ToRainDropReturnByName -ReturnName "MyReturnName1";
$myToRainDropResultReturn = $myToRainDropResult | Get-ToRainDropReturnByName -CheckLocalObject -ReturnName "MyReturnName1";
$myToRainDropResultReturn = $myToRainDropExecutionKeyCmdIdString | Get-ToRainDrop | Get-ToRainDropReturnByName -CheckLocalObject -ReturnName "MyReturnName1";
$myToRainDropResultReturnWithName = Get-ToRainDropReturnByName -ToRainDropResult $myToRainDropResult -CheckLocalObject -ReturnName "MyReturnName1" -IncludeReturnNameInOutput;
$myToRainDropResultReturnWithName = $myToRainDropResult | Get-ToRainDropReturnByName -CheckLocalObject -ReturnName "MyReturnName1" -IncludeReturnNameInOutput;
Specifies the Execution Key Value.
(ParameterSet = “ToRainDropKey”)
Type: String
Parameter Sets: ToRainDropKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the ToRainDrop Execution Result (PSCustomObject) Value.
(ParameterSet = “ToRainDropResult”)
Type: PSObject
Parameter Sets: ToRainDropKey
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: PSObject
Parameter Sets: ToRainDropResult
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the CheckLocalObject Switch.
(ParameterSet = “ToRainDropResult”)
Type: SwitchParameter
Parameter Sets: ToRainDropResult
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Specifies the ReturnName Value.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
(Optional) Specifies the IncludeReturnNameInOutput Switch.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe [PSCustomObject]$ToRainDropResult objects to Read-ToRainDropResultReturns.
Using the -CheckLocalObject Switch Reads the ‘Return Values’ from the (PSObject)$ToRainDropResult passed to the -ToRainDropResult parameter and does NOT perform a Get-ToRainDrop request to Read the ‘Return Values’).
Get-ToRainDropStatus
Get-ToRainDropReturns
Get-ToRainDropReturnByName