activity

package
v0.20230901.1170029 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2022-08-08/activity Documentation

The activity SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2022-08-08).

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/automation/2022-08-08/activity"

Client Initialization

client := activity.NewActivityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ActivityClient.Get

ctx := context.TODO()
id := activity.NewActivityID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "moduleValue", "activityValue")

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: ActivityClient.ListByModule

ctx := context.TODO()
id := activity.NewModuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "moduleValue")

// alternatively `client.ListByModule(ctx, id)` can be used to do batched pagination
items, err := client.ListByModuleComplete(ctx, id)
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 ValidateActivityID 

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

ValidateActivityID checks that 'input' can be parsed as a Activity ID

func ValidateModuleID 

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

ValidateModuleID checks that 'input' can be parsed as a Module ID

Types

type Activity 

type Activity struct {
	Id         *string             `json:"id,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Properties *ActivityProperties `json:"properties,omitempty"`
}

type ActivityClient 

type ActivityClient struct {
	Client *resourcemanager.Client
}

func NewActivityClientWithBaseURI 

func NewActivityClientWithBaseURI(sdkApi sdkEnv.Api) (*ActivityClient, error)

func (ActivityClient) Get 

func (c ActivityClient) Get(ctx context.Context, id ActivityId) (result GetOperationResponse, err error)

Get ...

func (ActivityClient) ListByModule 

func (c ActivityClient) ListByModule(ctx context.Context, id ModuleId) (result ListByModuleOperationResponse, err error)

ListByModule ...

func (ActivityClient) ListByModuleComplete 

func (c ActivityClient) ListByModuleComplete(ctx context.Context, id ModuleId) (ListByModuleCompleteResult, error)

ListByModuleComplete retrieves all the results into a single object

func (ActivityClient) ListByModuleCompleteMatchingPredicate 

func (c ActivityClient) ListByModuleCompleteMatchingPredicate(ctx context.Context, id ModuleId, predicate ActivityOperationPredicate) (result ListByModuleCompleteResult, err error)

ListByModuleCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ActivityId 

type ActivityId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ModuleName            string
	ActivityName          string
}

ActivityId is a struct representing the Resource ID for a Activity

func NewActivityID 

func NewActivityID(subscriptionId string, resourceGroupName string, automationAccountName string, moduleName string, activityName string) ActivityId

NewActivityID returns a new ActivityId struct

func ParseActivityID 

func ParseActivityID(input string) (*ActivityId, error)

ParseActivityID parses 'input' into a ActivityId

func ParseActivityIDInsensitively 

func ParseActivityIDInsensitively(input string) (*ActivityId, error)

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

func (ActivityId) ID 

func (id ActivityId) ID() string

ID returns the formatted Activity ID

func (ActivityId) Segments 

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

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

func (ActivityId) String 

func (id ActivityId) String() string

String returns a human-readable description of this Activity ID

type ActivityOperationPredicate 

type ActivityOperationPredicate struct {
	Id   *string
	Name *string
}

func (ActivityOperationPredicate) Matches 

func (p ActivityOperationPredicate) Matches(input Activity) bool

type ActivityOutputType 

type ActivityOutputType struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type ActivityParameter 

type ActivityParameter struct {
	Description                     *string                           `json:"description,omitempty"`
	IsDynamic                       *bool                             `json:"isDynamic,omitempty"`
	IsMandatory                     *bool                             `json:"isMandatory,omitempty"`
	Name                            *string                           `json:"name,omitempty"`
	Position                        *int64                            `json:"position,omitempty"`
	Type                            *string                           `json:"type,omitempty"`
	ValidationSet                   *[]ActivityParameterValidationSet `json:"validationSet,omitempty"`
	ValueFromPipeline               *bool                             `json:"valueFromPipeline,omitempty"`
	ValueFromPipelineByPropertyName *bool                             `json:"valueFromPipelineByPropertyName,omitempty"`
	ValueFromRemainingArguments     *bool                             `json:"valueFromRemainingArguments,omitempty"`
}

type ActivityParameterSet 

type ActivityParameterSet struct {
	Name       *string              `json:"name,omitempty"`
	Parameters *[]ActivityParameter `json:"parameters,omitempty"`
}

type ActivityParameterValidationSet 

type ActivityParameterValidationSet struct {
	MemberValue *string `json:"memberValue,omitempty"`
}

type ActivityProperties 

type ActivityProperties struct {
	CreationTime     *string                 `json:"creationTime,omitempty"`
	Definition       *string                 `json:"definition,omitempty"`
	Description      *string                 `json:"description,omitempty"`
	LastModifiedTime *string                 `json:"lastModifiedTime,omitempty"`
	OutputTypes      *[]ActivityOutputType   `json:"outputTypes,omitempty"`
	ParameterSets    *[]ActivityParameterSet `json:"parameterSets,omitempty"`
}

func (*ActivityProperties) GetCreationTimeAsTime 

func (o *ActivityProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*ActivityProperties) GetLastModifiedTimeAsTime 

func (o *ActivityProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*ActivityProperties) SetCreationTimeAsTime 

func (o *ActivityProperties) SetCreationTimeAsTime(input time.Time)

func (*ActivityProperties) SetLastModifiedTimeAsTime 

func (o *ActivityProperties) SetLastModifiedTimeAsTime(input time.Time)

type GetOperationResponse 

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

type ListByModuleCompleteResult 

type ListByModuleCompleteResult struct {
	Items []Activity
}

type ListByModuleOperationResponse 

type ListByModuleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Activity
}

type ModuleId 

type ModuleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	ModuleName            string
}

ModuleId is a struct representing the Resource ID for a Module

func NewModuleID 

func NewModuleID(subscriptionId string, resourceGroupName string, automationAccountName string, moduleName string) ModuleId

NewModuleID returns a new ModuleId struct

func ParseModuleID 

func ParseModuleID(input string) (*ModuleId, error)

ParseModuleID parses 'input' into a ModuleId

func ParseModuleIDInsensitively 

func ParseModuleIDInsensitively(input string) (*ModuleId, error)

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

func (ModuleId) ID 

func (id ModuleId) ID() string

ID returns the formatted Module ID

func (ModuleId) Segments 

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

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

func (ModuleId) String 

func (id ModuleId) String() string

String returns a human-readable description of this Module ID

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.