workflowversions

package
v0.20240118.1175416 Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/logic/2019-05-01/workflowversions Documentation

The workflowversions SDK allows for interaction with the Azure Resource Manager Service logic (API Version 2019-05-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/logic/2019-05-01/workflowversions"

Client Initialization

client := workflowversions.NewWorkflowVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkflowVersionsClient.Get

ctx := context.TODO()
id := workflowversions.NewVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workflowValue", "versionIdValue")

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: WorkflowVersionsClient.List

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForOpenAuthenticationProviderType 

func PossibleValuesForOpenAuthenticationProviderType() []string

func PossibleValuesForParameterType 

func PossibleValuesForParameterType() []string

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func PossibleValuesForWorkflowProvisioningState 

func PossibleValuesForWorkflowProvisioningState() []string

func PossibleValuesForWorkflowState 

func PossibleValuesForWorkflowState() []string

func ValidateVersionID 

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

ValidateVersionID checks that 'input' can be parsed as a Version 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 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 GetOperationResponse 

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

type IPAddress 

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

type IPAddressRange 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WorkflowVersion
}

type ListOperationOptions 

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230712.1163130 

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

func (ListOperationOptions) ToOData added in v0.20230712.1163130 

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

func (ListOperationOptions) ToQuery added in v0.20230712.1163130 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WorkflowVersion
}

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 added in v0.20230712.1163130 

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 added in v0.20230712.1163130 

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

type ResourceReference 

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

type Sku 

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

type SkuName 

type SkuName string
const (
	SkuNameBasic        SkuName = "Basic"
	SkuNameFree         SkuName = "Free"
	SkuNameNotSpecified SkuName = "NotSpecified"
	SkuNamePremium      SkuName = "Premium"
	SkuNameShared       SkuName = "Shared"
	SkuNameStandard     SkuName = "Standard"
)

func (*SkuName) UnmarshalJSON added in v0.20230712.1163130 

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

type VersionId 

type VersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
	VersionId         string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID 

func NewVersionID(subscriptionId string, resourceGroupName string, workflowName string, versionId string) VersionId

NewVersionID returns a new VersionId struct

func ParseVersionID 

func ParseVersionID(input string) (*VersionId, error)

ParseVersionID parses 'input' into a VersionId

func ParseVersionIDInsensitively 

func ParseVersionIDInsensitively(input string) (*VersionId, error)

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

func (*VersionId) FromParseResult added in v0.20231127.1171502 

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

func (VersionId) ID 

func (id VersionId) ID() string

ID returns the formatted Version ID

func (VersionId) Segments 

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

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

func (VersionId) String 

func (id VersionId) String() string

String returns a human-readable description of this Version ID

type WorkflowId 

type WorkflowId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
}

WorkflowId is a struct representing the Resource ID for a Workflow

func NewWorkflowID 

func NewWorkflowID(subscriptionId string, resourceGroupName 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 added in v0.20231127.1171502 

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 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 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 added in v0.20230712.1163130 

func (s *WorkflowProvisioningState) 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 added in v0.20230712.1163130 

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

type WorkflowVersion 

type WorkflowVersion struct {
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *WorkflowVersionProperties `json:"properties,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type WorkflowVersionOperationPredicate 

type WorkflowVersionOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (WorkflowVersionOperationPredicate) Matches 

func (p WorkflowVersionOperationPredicate) Matches(input WorkflowVersion) bool

type WorkflowVersionProperties 

type WorkflowVersionProperties 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"`
	Parameters             *map[string]WorkflowParameter   `json:"parameters,omitempty"`
	ProvisioningState      *WorkflowProvisioningState      `json:"provisioningState,omitempty"`
	Sku                    *Sku                            `json:"sku,omitempty"`
	State                  *WorkflowState                  `json:"state,omitempty"`
	Version                *string                         `json:"version,omitempty"`
}

func (*WorkflowVersionProperties) GetChangedTimeAsTime 

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

func (*WorkflowVersionProperties) GetCreatedTimeAsTime 

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

func (*WorkflowVersionProperties) SetChangedTimeAsTime 

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

func (*WorkflowVersionProperties) SetCreatedTimeAsTime 

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

type WorkflowVersionsClient 

type WorkflowVersionsClient struct {
	Client *resourcemanager.Client
}

func NewWorkflowVersionsClientWithBaseURI 

func NewWorkflowVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkflowVersionsClient, error)

func (WorkflowVersionsClient) Get 

func (c WorkflowVersionsClient) Get(ctx context.Context, id VersionId) (result GetOperationResponse, err error)

Get ...

func (WorkflowVersionsClient) List 

func (c WorkflowVersionsClient) List(ctx context.Context, id WorkflowId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (WorkflowVersionsClient) ListComplete 

func (c WorkflowVersionsClient) ListComplete(ctx context.Context, id WorkflowId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (WorkflowVersionsClient) ListCompleteMatchingPredicate 

func (c WorkflowVersionsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkflowId, options ListOperationOptions, predicate WorkflowVersionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.