package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev
# README
github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-12-01/workflowruns
Documentation
The workflowruns
SDK allows for interaction with the Azure Resource Manager Service web
(API Version 2023-12-01
).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-12-01/workflowruns"
Client Initialization
client := workflowruns.NewWorkflowRunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: WorkflowRunsClient.Cancel
ctx := context.TODO()
id := workflowruns.NewRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "workflowValue", "runValue")
read, err := client.Cancel(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: WorkflowRunsClient.Get
ctx := context.TODO()
id := workflowruns.NewRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "workflowValue", "runValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: WorkflowRunsClient.List
ctx := context.TODO()
id := workflowruns.NewManagementWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "workflowValue")
// alternatively `client.List(ctx, id, workflowruns.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, workflowruns.DefaultListOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
# Functions
No description provided by the author
NewManagementWorkflowID returns a new ManagementWorkflowId struct.
NewRunID returns a new RunId struct.
No description provided by the author
ParseManagementWorkflowID parses 'input' into a ManagementWorkflowId.
ParseManagementWorkflowIDInsensitively parses 'input' case-insensitively into a ManagementWorkflowId note: this method should only be used for API response data and not user input.
ParseRunID parses 'input' into a RunId.
ParseRunIDInsensitively parses 'input' case-insensitively into a RunId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
ValidateManagementWorkflowID checks that 'input' can be parsed as a Management Workflow ID.
ValidateRunID checks that 'input' can be parsed as a Run ID.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ManagementWorkflowId is a struct representing the Resource ID for a Management Workflow.
No description provided by the author
RunId is a struct representing the Resource ID for a Run.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author