workflows

package
v0.20240327.1161949 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2022-09-01/workflows Documentation

The workflows SDK allows for interaction with the Azure Resource Manager Service web (API Version 2022-09-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/2022-09-01/workflows"

Client Initialization

client := workflows.NewWorkflowsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkflowsClient.RegenerateAccessKey

ctx := context.TODO()
id := workflows.NewManagementWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "workflowValue")

payload := workflows.RegenerateActionParameter{
	// ...
}


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

Example Usage: WorkflowsClient.Validate

ctx := context.TODO()
id := workflows.NewManagementWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "workflowValue")

payload := workflows.Workflow{
	// ...
}


read, err := client.Validate(ctx, id, payload)
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 PossibleValuesForKeyType

func PossibleValuesForKeyType() []string

func PossibleValuesForKind

func PossibleValuesForKind() []string

func PossibleValuesForOpenAuthenticationProviderType

func PossibleValuesForOpenAuthenticationProviderType() []string

func PossibleValuesForParameterType

func PossibleValuesForParameterType() []string

func PossibleValuesForWorkflowProvisioningState

func PossibleValuesForWorkflowProvisioningState() []string

func PossibleValuesForWorkflowSkuName

func PossibleValuesForWorkflowSkuName() []string

func PossibleValuesForWorkflowState

func PossibleValuesForWorkflowState() []string

func ValidateManagementWorkflowID

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

ValidateManagementWorkflowID checks that 'input' can be parsed as a Management Workflow ID

Types

type FlowAccessControlConfiguration

type FlowAccessControlConfiguration struct {
	Actions            *FlowAccessControlConfigurationPolicy `json:"actions,omitempty"`
	Contents           *FlowAccessControlConfigurationPolicy `json:"contents,omitempty"`
	Triggers           *FlowAccessControlConfigurationPolicy `json:"triggers,omitempty"`
	WorkflowManagement *FlowAccessControlConfigurationPolicy `json:"workflowManagement,omitempty"`
}

type FlowAccessControlConfigurationPolicy

type FlowAccessControlConfigurationPolicy struct {
	AllowedCallerIPAddresses   *[]IPAddressRange                 `json:"allowedCallerIpAddresses,omitempty"`
	OpenAuthenticationPolicies *OpenAuthenticationAccessPolicies `json:"openAuthenticationPolicies,omitempty"`
}

type FlowEndpoints

type FlowEndpoints struct {
	AccessEndpointIPAddresses *[]IPAddress `json:"accessEndpointIpAddresses,omitempty"`
	OutgoingIPAddresses       *[]IPAddress `json:"outgoingIpAddresses,omitempty"`
}

type FlowEndpointsConfiguration

type FlowEndpointsConfiguration struct {
	Connector *FlowEndpoints `json:"connector,omitempty"`
	Workflow  *FlowEndpoints `json:"workflow,omitempty"`
}

type IPAddress

type IPAddress struct {
	Address *string `json:"address,omitempty"`
}

type IPAddressRange

type IPAddressRange struct {
	AddressRange *string `json:"addressRange,omitempty"`
}

type KeyType

type KeyType string
const (
	KeyTypeNotSpecified KeyType = "NotSpecified"
	KeyTypePrimary      KeyType = "Primary"
	KeyTypeSecondary    KeyType = "Secondary"
)

func (*KeyType) UnmarshalJSON

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

type Kind

type Kind string
const (
	KindStateful  Kind = "Stateful"
	KindStateless Kind = "Stateless"
)

func (*Kind) UnmarshalJSON

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

type ManagementWorkflowId

type ManagementWorkflowId struct {
	SubscriptionId    string
	ResourceGroupName string
	SiteName          string
	WorkflowName      string
}

ManagementWorkflowId is a struct representing the Resource ID for a Management Workflow

func NewManagementWorkflowID

func NewManagementWorkflowID(subscriptionId string, resourceGroupName string, siteName string, workflowName string) ManagementWorkflowId

NewManagementWorkflowID returns a new ManagementWorkflowId struct

func ParseManagementWorkflowID

func ParseManagementWorkflowID(input string) (*ManagementWorkflowId, error)

ParseManagementWorkflowID parses 'input' into a ManagementWorkflowId

func ParseManagementWorkflowIDInsensitively

func ParseManagementWorkflowIDInsensitively(input string) (*ManagementWorkflowId, error)

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

func (*ManagementWorkflowId) FromParseResult

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

func (ManagementWorkflowId) ID

func (id ManagementWorkflowId) ID() string

ID returns the formatted Management Workflow ID

func (ManagementWorkflowId) Segments

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

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

func (ManagementWorkflowId) String

func (id ManagementWorkflowId) String() string

String returns a human-readable description of this Management Workflow ID

type OpenAuthenticationAccessPolicies

type OpenAuthenticationAccessPolicies struct {
	Policies *map[string]OpenAuthenticationAccessPolicy `json:"policies,omitempty"`
}

type OpenAuthenticationAccessPolicy

type OpenAuthenticationAccessPolicy struct {
	Claims *[]OpenAuthenticationPolicyClaim `json:"claims,omitempty"`
	Type   *OpenAuthenticationProviderType  `json:"type,omitempty"`
}

type OpenAuthenticationPolicyClaim

type OpenAuthenticationPolicyClaim struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type OpenAuthenticationProviderType

type OpenAuthenticationProviderType string
const (
	OpenAuthenticationProviderTypeAAD OpenAuthenticationProviderType = "AAD"
)

func (*OpenAuthenticationProviderType) UnmarshalJSON

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

type ParameterType

type ParameterType string
const (
	ParameterTypeArray        ParameterType = "Array"
	ParameterTypeBool         ParameterType = "Bool"
	ParameterTypeFloat        ParameterType = "Float"
	ParameterTypeInt          ParameterType = "Int"
	ParameterTypeNotSpecified ParameterType = "NotSpecified"
	ParameterTypeObject       ParameterType = "Object"
	ParameterTypeSecureObject ParameterType = "SecureObject"
	ParameterTypeSecureString ParameterType = "SecureString"
	ParameterTypeString       ParameterType = "String"
)

func (*ParameterType) UnmarshalJSON

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

type RegenerateAccessKeyOperationResponse

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

type RegenerateActionParameter

type RegenerateActionParameter struct {
	KeyType *KeyType `json:"keyType,omitempty"`
}

type ResourceReference

type ResourceReference struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type ValidateOperationResponse

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

type Workflow

type Workflow struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *WorkflowProperties                `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type WorkflowParameter

type WorkflowParameter struct {
	Description *string        `json:"description,omitempty"`
	Metadata    *interface{}   `json:"metadata,omitempty"`
	Type        *ParameterType `json:"type,omitempty"`
	Value       *interface{}   `json:"value,omitempty"`
}

type WorkflowProperties

type WorkflowProperties struct {
	AccessControl                 *FlowAccessControlConfiguration `json:"accessControl,omitempty"`
	AccessEndpoint                *string                         `json:"accessEndpoint,omitempty"`
	ChangedTime                   *string                         `json:"changedTime,omitempty"`
	CreatedTime                   *string                         `json:"createdTime,omitempty"`
	Definition                    *interface{}                    `json:"definition,omitempty"`
	EndpointsConfiguration        *FlowEndpointsConfiguration     `json:"endpointsConfiguration,omitempty"`
	IntegrationAccount            *ResourceReference              `json:"integrationAccount,omitempty"`
	IntegrationServiceEnvironment *ResourceReference              `json:"integrationServiceEnvironment,omitempty"`
	Kind                          *Kind                           `json:"kind,omitempty"`
	Parameters                    *map[string]WorkflowParameter   `json:"parameters,omitempty"`
	ProvisioningState             *WorkflowProvisioningState      `json:"provisioningState,omitempty"`
	Sku                           *WorkflowSku                    `json:"sku,omitempty"`
	State                         *WorkflowState                  `json:"state,omitempty"`
	Version                       *string                         `json:"version,omitempty"`
}

func (*WorkflowProperties) GetChangedTimeAsTime

func (o *WorkflowProperties) GetChangedTimeAsTime() (*time.Time, error)

func (*WorkflowProperties) GetCreatedTimeAsTime

func (o *WorkflowProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*WorkflowProperties) SetChangedTimeAsTime

func (o *WorkflowProperties) SetChangedTimeAsTime(input time.Time)

func (*WorkflowProperties) SetCreatedTimeAsTime

func (o *WorkflowProperties) SetCreatedTimeAsTime(input time.Time)

type WorkflowProvisioningState

type WorkflowProvisioningState string
const (
	WorkflowProvisioningStateAccepted      WorkflowProvisioningState = "Accepted"
	WorkflowProvisioningStateCanceled      WorkflowProvisioningState = "Canceled"
	WorkflowProvisioningStateCompleted     WorkflowProvisioningState = "Completed"
	WorkflowProvisioningStateCreated       WorkflowProvisioningState = "Created"
	WorkflowProvisioningStateCreating      WorkflowProvisioningState = "Creating"
	WorkflowProvisioningStateDeleted       WorkflowProvisioningState = "Deleted"
	WorkflowProvisioningStateDeleting      WorkflowProvisioningState = "Deleting"
	WorkflowProvisioningStateFailed        WorkflowProvisioningState = "Failed"
	WorkflowProvisioningStateInProgress    WorkflowProvisioningState = "InProgress"
	WorkflowProvisioningStateMoving        WorkflowProvisioningState = "Moving"
	WorkflowProvisioningStateNotSpecified  WorkflowProvisioningState = "NotSpecified"
	WorkflowProvisioningStatePending       WorkflowProvisioningState = "Pending"
	WorkflowProvisioningStateReady         WorkflowProvisioningState = "Ready"
	WorkflowProvisioningStateRegistered    WorkflowProvisioningState = "Registered"
	WorkflowProvisioningStateRegistering   WorkflowProvisioningState = "Registering"
	WorkflowProvisioningStateRenewing      WorkflowProvisioningState = "Renewing"
	WorkflowProvisioningStateRunning       WorkflowProvisioningState = "Running"
	WorkflowProvisioningStateSucceeded     WorkflowProvisioningState = "Succeeded"
	WorkflowProvisioningStateUnregistered  WorkflowProvisioningState = "Unregistered"
	WorkflowProvisioningStateUnregistering WorkflowProvisioningState = "Unregistering"
	WorkflowProvisioningStateUpdating      WorkflowProvisioningState = "Updating"
	WorkflowProvisioningStateWaiting       WorkflowProvisioningState = "Waiting"
)

func (*WorkflowProvisioningState) UnmarshalJSON

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

type WorkflowSku

type WorkflowSku struct {
	Name WorkflowSkuName    `json:"name"`
	Plan *ResourceReference `json:"plan,omitempty"`
}

type WorkflowSkuName

type WorkflowSkuName string
const (
	WorkflowSkuNameBasic        WorkflowSkuName = "Basic"
	WorkflowSkuNameFree         WorkflowSkuName = "Free"
	WorkflowSkuNameNotSpecified WorkflowSkuName = "NotSpecified"
	WorkflowSkuNamePremium      WorkflowSkuName = "Premium"
	WorkflowSkuNameShared       WorkflowSkuName = "Shared"
	WorkflowSkuNameStandard     WorkflowSkuName = "Standard"
)

func (*WorkflowSkuName) UnmarshalJSON

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

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

type WorkflowsClient

type WorkflowsClient struct {
	Client *resourcemanager.Client
}

func NewWorkflowsClientWithBaseURI

func NewWorkflowsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkflowsClient, error)

func (WorkflowsClient) RegenerateAccessKey

RegenerateAccessKey ...

func (WorkflowsClient) Validate

Validate ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL