logicapps

package
v0.20241128.1112539 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 28, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-02-02-preview/logicapps Documentation

The logicapps SDK allows for interaction with Azure Resource Manager containerapps (API Version 2024-02-02-preview).

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/containerapps/2024-02-02-preview/logicapps"

Client Initialization

client := logicapps.NewLogicAppsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LogicAppsClient.CreateOrUpdate

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

payload := logicapps.LogicApp{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LogicAppsClient.Delete

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LogicAppsClient.DeployWorkflowArtifacts

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

payload := logicapps.WorkflowArtifacts{
	// ...
}


read, err := client.DeployWorkflowArtifacts(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LogicAppsClient.Get

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

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: LogicAppsClient.GetWorkflow

ctx := context.TODO()
id := logicapps.NewWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName", "workflowName")

read, err := client.GetWorkflow(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LogicAppsClient.Invoke

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

read, err := client.Invoke(ctx, id, logicapps.DefaultInvokeOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LogicAppsClient.ListWorkflows

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

// alternatively `client.ListWorkflows(ctx, id)` can be used to do batched pagination
items, err := client.ListWorkflowsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: LogicAppsClient.ListWorkflowsConnections

ctx := context.TODO()
id := logicapps.NewLogicAppID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "logicAppName")

read, err := client.ListWorkflowsConnections(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForLogicAppsProxyMethod 

func PossibleValuesForLogicAppsProxyMethod() []string

func PossibleValuesForWorkflowHealthState 

func PossibleValuesForWorkflowHealthState() []string

func PossibleValuesForWorkflowState 

func PossibleValuesForWorkflowState() []string

func ValidateLogicAppID 

func ValidateLogicAppID(input interface{}, key string) (warnings []string, errors []error)

ValidateLogicAppID checks that 'input' can be parsed as a Logic App ID

func ValidateWorkflowID 

func ValidateWorkflowID(input interface{}, key string) (warnings []string, errors []error)

ValidateWorkflowID checks that 'input' can be parsed as a Workflow ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LogicApp
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeployWorkflowArtifactsOperationResponse 

type DeployWorkflowArtifactsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ErrorEntity 

type ErrorEntity struct {
	Code            *string        `json:"code,omitempty"`
	Details         *[]ErrorEntity `json:"details,omitempty"`
	ExtendedCode    *string        `json:"extendedCode,omitempty"`
	InnerErrors     *[]ErrorEntity `json:"innerErrors,omitempty"`
	Message         *string        `json:"message,omitempty"`
	MessageTemplate *string        `json:"messageTemplate,omitempty"`
	Parameters      *[]string      `json:"parameters,omitempty"`
	Target          *string        `json:"target,omitempty"`
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LogicApp
}

type GetWorkflowOperationResponse 

type GetWorkflowOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkflowEnvelope
}

type InvokeOperationOptions 

type InvokeOperationOptions struct {
	XMsLogicAppsProxyMethod *LogicAppsProxyMethod
	XMsLogicAppsProxyPath   *string
}

func DefaultInvokeOperationOptions 

func DefaultInvokeOperationOptions() InvokeOperationOptions

func (InvokeOperationOptions) ToHeaders 

func (o InvokeOperationOptions) ToHeaders() *client.Headers

func (InvokeOperationOptions) ToOData 

func (o InvokeOperationOptions) ToOData() *odata.Query

func (InvokeOperationOptions) ToQuery 

func (o InvokeOperationOptions) ToQuery() *client.QueryParams

type InvokeOperationResponse 

type InvokeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *interface{}
}

type ListWorkflowsCompleteResult 

type ListWorkflowsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WorkflowEnvelope
}

type ListWorkflowsConnectionsOperationResponse 

type ListWorkflowsConnectionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkflowEnvelope
}

type ListWorkflowsCustomPager 

type ListWorkflowsCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListWorkflowsCustomPager) NextPageLink() *odata.Link

type ListWorkflowsOperationResponse 

type ListWorkflowsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WorkflowEnvelope
}

type LogicApp 

type LogicApp struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *interface{}           `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type LogicAppId 

type LogicAppId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	LogicAppName      string
}

LogicAppId is a struct representing the Resource ID for a Logic App

func NewLogicAppID 

func NewLogicAppID(subscriptionId string, resourceGroupName string, containerAppName string, logicAppName string) LogicAppId

NewLogicAppID returns a new LogicAppId struct

func ParseLogicAppID 

func ParseLogicAppID(input string) (*LogicAppId, error)

ParseLogicAppID parses 'input' into a LogicAppId

func ParseLogicAppIDInsensitively 

func ParseLogicAppIDInsensitively(input string) (*LogicAppId, error)

ParseLogicAppIDInsensitively parses 'input' case-insensitively into a LogicAppId note: this method should only be used for API response data and not user input

func (*LogicAppId) FromParseResult 

func (id *LogicAppId) FromParseResult(input resourceids.ParseResult) error

func (LogicAppId) ID 

func (id LogicAppId) ID() string

ID returns the formatted Logic App ID

func (LogicAppId) Segments 

func (id LogicAppId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Logic App ID

func (LogicAppId) String 

func (id LogicAppId) String() string

String returns a human-readable description of this Logic App ID

type LogicAppsClient 

type LogicAppsClient struct {
	Client *resourcemanager.Client
}

func NewLogicAppsClientWithBaseURI 

func NewLogicAppsClientWithBaseURI(sdkApi sdkEnv.Api) (*LogicAppsClient, error)

func (LogicAppsClient) CreateOrUpdate 

func (c LogicAppsClient) CreateOrUpdate(ctx context.Context, id LogicAppId, input LogicApp) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (LogicAppsClient) Delete 

func (c LogicAppsClient) Delete(ctx context.Context, id LogicAppId) (result DeleteOperationResponse, err error)

Delete ...

func (LogicAppsClient) DeployWorkflowArtifacts 

func (c LogicAppsClient) DeployWorkflowArtifacts(ctx context.Context, id LogicAppId, input WorkflowArtifacts) (result DeployWorkflowArtifactsOperationResponse, err error)

DeployWorkflowArtifacts ...

func (LogicAppsClient) Get 

func (c LogicAppsClient) Get(ctx context.Context, id LogicAppId) (result GetOperationResponse, err error)

Get ...

func (LogicAppsClient) GetWorkflow 

func (c LogicAppsClient) GetWorkflow(ctx context.Context, id WorkflowId) (result GetWorkflowOperationResponse, err error)

GetWorkflow ...

func (LogicAppsClient) Invoke 

func (c LogicAppsClient) Invoke(ctx context.Context, id LogicAppId, options InvokeOperationOptions) (result InvokeOperationResponse, err error)

Invoke ...

func (LogicAppsClient) ListWorkflows 

func (c LogicAppsClient) ListWorkflows(ctx context.Context, id LogicAppId) (result ListWorkflowsOperationResponse, err error)

ListWorkflows ...

func (LogicAppsClient) ListWorkflowsComplete 

func (c LogicAppsClient) ListWorkflowsComplete(ctx context.Context, id LogicAppId) (ListWorkflowsCompleteResult, error)

ListWorkflowsComplete retrieves all the results into a single object

func (LogicAppsClient) ListWorkflowsCompleteMatchingPredicate 

func (c LogicAppsClient) ListWorkflowsCompleteMatchingPredicate(ctx context.Context, id LogicAppId, predicate WorkflowEnvelopeOperationPredicate) (result ListWorkflowsCompleteResult, err error)

ListWorkflowsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (LogicAppsClient) ListWorkflowsConnections 

func (c LogicAppsClient) ListWorkflowsConnections(ctx context.Context, id LogicAppId) (result ListWorkflowsConnectionsOperationResponse, err error)

ListWorkflowsConnections ...

type LogicAppsProxyMethod 

type LogicAppsProxyMethod string
const (
	LogicAppsProxyMethodGET  LogicAppsProxyMethod = "GET"
	LogicAppsProxyMethodPOST LogicAppsProxyMethod = "POST"
)

func (*LogicAppsProxyMethod) UnmarshalJSON 

func (s *LogicAppsProxyMethod) UnmarshalJSON(bytes []byte) error

type WorkflowArtifacts 

type WorkflowArtifacts struct {
	AppSettings   *interface{} `json:"appSettings,omitempty"`
	Files         *interface{} `json:"files,omitempty"`
	FilesToDelete *[]string    `json:"filesToDelete,omitempty"`
}

type WorkflowEnvelope 

type WorkflowEnvelope struct {
	Id         *string                     `json:"id,omitempty"`
	Kind       *string                     `json:"kind,omitempty"`
	Location   *string                     `json:"location,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *WorkflowEnvelopeProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type WorkflowEnvelopeOperationPredicate 

type WorkflowEnvelopeOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (WorkflowEnvelopeOperationPredicate) Matches 

func (p WorkflowEnvelopeOperationPredicate) Matches(input WorkflowEnvelope) bool

type WorkflowEnvelopeProperties 

type WorkflowEnvelopeProperties struct {
	Files     *interface{}    `json:"files,omitempty"`
	FlowState *WorkflowState  `json:"flowState,omitempty"`
	Health    *WorkflowHealth `json:"health,omitempty"`
}

type WorkflowHealth 

type WorkflowHealth struct {
	Error *ErrorEntity        `json:"error,omitempty"`
	State WorkflowHealthState `json:"state"`
}

type WorkflowHealthState 

type WorkflowHealthState string
const (
	WorkflowHealthStateHealthy      WorkflowHealthState = "Healthy"
	WorkflowHealthStateNotSpecified WorkflowHealthState = "NotSpecified"
	WorkflowHealthStateUnhealthy    WorkflowHealthState = "Unhealthy"
	WorkflowHealthStateUnknown      WorkflowHealthState = "Unknown"
)

func (*WorkflowHealthState) UnmarshalJSON 

func (s *WorkflowHealthState) UnmarshalJSON(bytes []byte) error

type WorkflowId 

type WorkflowId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	LogicAppName      string
	WorkflowName      string
}

WorkflowId is a struct representing the Resource ID for a Workflow

func NewWorkflowID 

func NewWorkflowID(subscriptionId string, resourceGroupName string, containerAppName string, logicAppName string, workflowName string) WorkflowId

NewWorkflowID returns a new WorkflowId struct

func ParseWorkflowID 

func ParseWorkflowID(input string) (*WorkflowId, error)

ParseWorkflowID parses 'input' into a WorkflowId

func ParseWorkflowIDInsensitively 

func ParseWorkflowIDInsensitively(input string) (*WorkflowId, error)

ParseWorkflowIDInsensitively parses 'input' case-insensitively into a WorkflowId note: this method should only be used for API response data and not user input

func (*WorkflowId) FromParseResult 

func (id *WorkflowId) FromParseResult(input resourceids.ParseResult) error

func (WorkflowId) ID 

func (id WorkflowId) ID() string

ID returns the formatted Workflow ID

func (WorkflowId) Segments 

func (id WorkflowId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Workflow ID

func (WorkflowId) String 

func (id WorkflowId) String() string

String returns a human-readable description of this Workflow ID

type WorkflowState 

type WorkflowState string
const (
	WorkflowStateCompleted    WorkflowState = "Completed"
	WorkflowStateDeleted      WorkflowState = "Deleted"
	WorkflowStateDisabled     WorkflowState = "Disabled"
	WorkflowStateEnabled      WorkflowState = "Enabled"
	WorkflowStateNotSpecified WorkflowState = "NotSpecified"
	WorkflowStateSuspended    WorkflowState = "Suspended"
)

func (*WorkflowState) UnmarshalJSON 

func (s *WorkflowState) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.