workflowversions

package
v0.20240903.1111904 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-01-01/workflowversions Documentation

The workflowversions SDK allows for interaction with the Azure Resource Manager Service web (API Version 2023-01-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-01-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", "siteValue", "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.NewManagementWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "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 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

func ValidateVersionID 

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

ValidateVersionID checks that 'input' can be parsed as a Version 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 ListCustomPager added in v0.20240628.1153531 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

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

type ListOperationResponse 

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

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 ResourceReference 

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

type VersionId 

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

VersionId is a struct representing the Resource ID for a Version

func NewVersionID 

func NewVersionID(subscriptionId string, resourceGroupName string, siteName 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 

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 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 

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 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                    *WorkflowSku                    `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 ManagementWorkflowId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (WorkflowVersionsClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (WorkflowVersionsClient) ListCompleteMatchingPredicate 

func (c WorkflowVersionsClient) ListCompleteMatchingPredicate(ctx context.Context, id ManagementWorkflowId, 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.