-
Notifications
You must be signed in to change notification settings - Fork 3
Add help for all Durable Functions cmdlets #96
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
Module Name: AzureFunctions.PowerShell.Durable.SDK | ||
Module Guid: 841fad61-94f5-4330-89be-613d54165289 | ||
Download Help Link: https://github.com/Azure/azure-functions-durable-powershell | ||
Help Version: 1.0.0.0 | ||
Locale: en-US | ||
--- | ||
|
||
# AzureFunctions.PowerShell.Durable.SDK Module | ||
|
||
## Description | ||
|
||
The AzureFunctions.PowerShell.Durable.SDK module provides cmdlets for building durable, stateful functions in Azure Functions using PowerShell. This SDK enables you to create orchestrator functions, activity functions, and manage durable orchestration workflows with features like timers, external events, and sub-orchestrations. | ||
|
||
## AzureFunctions.PowerShell.Durable.SDK Cmdlets | ||
|
||
### [Get-DurableStatus](Get-DurableStatus.md) | ||
|
||
Gets the status of a durable orchestration instance, including execution history, input data, and output data. | ||
|
||
### [Get-DurableTaskResult](Get-DurableTaskResult.md) | ||
|
||
Gets the result of a completed durable task, such as an activity function or sub-orchestrator. | ||
|
||
### [Invoke-DurableActivity](Invoke-DurableActivity.md) | ||
|
||
Invokes an activity function from within an orchestrator function. | ||
|
||
### [Invoke-DurableSubOrchestrator](Invoke-DurableSubOrchestrator.md) | ||
|
||
Invokes a sub-orchestrator function from within a parent orchestrator function. | ||
|
||
### [New-DurableOrchestrationCheckStatusResponse](New-DurableOrchestrationCheckStatusResponse.md) | ||
|
||
Creates an HTTP response for orchestration status check endpoints with status polling URLs. | ||
|
||
### [New-DurableRetryPolicy](New-DurableRetryPolicy.md) | ||
|
||
Creates a retry policy for durable activity functions and sub-orchestrators. | ||
|
||
### [Resume-DurableOrchestration](Resume-DurableOrchestration.md) | ||
|
||
Resumes a suspended durable orchestration instance. | ||
|
||
### [Send-DurableExternalEvent](Send-DurableExternalEvent.md) | ||
|
||
Sends an external event to a running durable orchestration instance. | ||
|
||
### [Set-DurableCustomStatus](Set-DurableCustomStatus.md) | ||
|
||
Sets custom status information for a durable orchestration instance. | ||
|
||
### [Set-FunctionInvocationContext](Set-FunctionInvocationContext.md) | ||
|
||
Sets the function invocation context for durable function operations. | ||
|
||
### [Start-DurableExternalEventListener](Start-DurableExternalEventListener.md) | ||
|
||
Starts listening for an external event within an orchestrator function. | ||
|
||
### [Start-DurableOrchestration](Start-DurableOrchestration.md) | ||
|
||
Starts a new durable orchestration instance with the specified function name and input. | ||
|
||
### [Start-DurableTimer](Start-DurableTimer.md) | ||
|
||
Starts a durable timer that fires after a specified delay or at a specific time. | ||
|
||
### [Stop-DurableOrchestration](Stop-DurableOrchestration.md) | ||
|
||
Terminates a running durable orchestration instance. | ||
|
||
### [Stop-DurableTimerTask](Stop-DurableTimerTask.md) | ||
|
||
Stops a running durable timer task. | ||
|
||
### [Suspend-DurableOrchestration](Suspend-DurableOrchestration.md) | ||
|
||
Suspends a running durable orchestration instance. | ||
|
||
### [Wait-DurableTask](Wait-DurableTask.md) | ||
|
||
Waits for the completion of one or more durable tasks within an orchestrator function. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
--- | ||
external help file: AzureFunctions.PowerShell.Durable.SDK-help.xml | ||
Module Name: AzureFunctions.PowerShell.Durable.SDK | ||
online version: | ||
schema: 2.0.0 | ||
--- | ||
|
||
# Get-DurableStatus | ||
|
||
## SYNOPSIS | ||
|
||
Get the status of a durable orchestration instance. | ||
|
||
## SYNTAX | ||
|
||
``` | ||
Get-DurableStatus [-InstanceId] <String> [-DurableClient <Object>] [-ShowHistory] [-ShowHistoryOutput] [-ShowInput] [<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
|
||
Get the status of a durable orchestration instance with the given instance ID. | ||
Optionally includes execution history, history output, and input data. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1 | ||
|
||
```powershell | ||
Get-DurableStatus -InstanceId "example-instance-id" | ||
``` | ||
|
||
Returns the basic status of the orchestration instance. | ||
|
||
### Example 2 | ||
|
||
```powershell | ||
Get-DurableStatus -InstanceId "example-instance-id" -ShowHistory -ShowHistoryOutput | ||
``` | ||
|
||
Returns the status with detailed execution history and output. | ||
|
||
## PARAMETERS | ||
|
||
### -InstanceId | ||
|
||
The ID of the orchestration instance to get the status for. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 1 | ||
Default value: None | ||
Accept pipeline input: True (ByPropertyName) | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -DurableClient | ||
|
||
The durable client object. | ||
If not provided, it will be retrieved from module private data. | ||
|
||
```yaml | ||
Type: Object | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: True (ByPropertyName) | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -ShowHistory | ||
|
||
When present, includes the execution history in the response. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: False | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -ShowHistoryOutput | ||
|
||
When present, includes the output of each step in the execution history. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: False | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -ShowInput | ||
|
||
When present, includes the input data that was provided to the orchestration instance. | ||
|
||
```yaml | ||
Type: SwitchParameter | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: False | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### CommonParameters | ||
|
||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
||
## INPUTS | ||
|
||
### System.String | ||
|
||
You can pipe instance ID strings to this cmdlet to get the status of multiple orchestration instances. | ||
|
||
## OUTPUTS | ||
|
||
### System.Object | ||
|
||
Returns a status object containing information about the durable orchestration instance, including: | ||
|
||
- InstanceId: The unique identifier of the orchestration instance | ||
- RuntimeStatus: The current runtime status (Running, Completed, Failed, etc.) | ||
- Input: The input data provided to the orchestration (if -ShowInput is specified) | ||
- Output: The output of the orchestration (if completed) | ||
- CreatedTime: When the orchestration was created | ||
- LastUpdatedTime: When the orchestration was last updated | ||
- History: Execution history (if -ShowHistory is specified) | ||
|
||
## NOTES | ||
|
||
- This cmdlet is typically used in HTTP trigger functions or other client functions to check orchestration progress. | ||
- The InstanceId must be from an existing orchestration; invalid IDs will result in a null response. | ||
- Use -ShowHistory to get detailed execution steps, which is useful for debugging orchestration behavior. | ||
- The -ShowHistoryOutput parameter can produce large responses; use carefully in production environments. | ||
- Status information includes runtime state, input/output data, creation time, and last update time. | ||
- Orchestration status is eventually consistent and may take a moment to reflect the latest state after operations. | ||
|
||
## RELATED LINKS | ||
|
||
[Durable Functions for PowerShell](https://github.com/Azure/azure-functions-durable-powershell) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.