module

package
v0.20240125.1170241 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2015-10-31/module Documentation

The module SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2015-10-31).

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/2015-10-31/module"

Client Initialization

client := module.NewModuleClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ModuleClient.CreateOrUpdate

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

payload := module.ModuleCreateOrUpdateParameters{
	// ...
}


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: ModuleClient.Delete

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

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: ModuleClient.Get

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

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: ModuleClient.ListByAutomationAccount

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

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

Example Usage: ModuleClient.Update

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

payload := module.ModuleUpdateParameters{
	// ...
}


read, err := client.Update(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 PossibleValuesForModuleProvisioningState 

func PossibleValuesForModuleProvisioningState() []string

func ValidateAutomationAccountID 

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account 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 AutomationAccountId 

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID 

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID 

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively 

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (*AutomationAccountId) FromParseResult 

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

func (AutomationAccountId) ID 

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String 

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type ContentHash 

type ContentHash struct {
	Algorithm string `json:"algorithm"`
	Value     string `json:"value"`
}
type ContentLink struct {
	ContentHash *ContentHash `json:"contentHash,omitempty"`
	Uri         *string      `json:"uri,omitempty"`
	Version     *string      `json:"version,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Module
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Module
}

type ListByAutomationAccountCompleteResult 

type ListByAutomationAccountCompleteResult struct {
	Items []Module
}

type ListByAutomationAccountOperationResponse 

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Module
	// contains filtered or unexported fields
}

func (ListByAutomationAccountOperationResponse) HasMore 

func (r ListByAutomationAccountOperationResponse) HasMore() bool

func (ListByAutomationAccountOperationResponse) LoadMore 

func (r ListByAutomationAccountOperationResponse) LoadMore(ctx context.Context) (resp ListByAutomationAccountOperationResponse, err error)

type Module 

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

type ModuleClient 

type ModuleClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewModuleClientWithBaseURI 

func NewModuleClientWithBaseURI(endpoint string) ModuleClient

func (ModuleClient) CreateOrUpdate 

func (c ModuleClient) CreateOrUpdate(ctx context.Context, id ModuleId, input ModuleCreateOrUpdateParameters) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ModuleClient) Delete 

func (c ModuleClient) Delete(ctx context.Context, id ModuleId) (result DeleteOperationResponse, err error)

Delete ...

func (ModuleClient) Get 

func (c ModuleClient) Get(ctx context.Context, id ModuleId) (result GetOperationResponse, err error)

Get ...

func (ModuleClient) ListByAutomationAccount 

func (c ModuleClient) ListByAutomationAccount(ctx context.Context, id AutomationAccountId) (resp ListByAutomationAccountOperationResponse, err error)

ListByAutomationAccount ...

func (ModuleClient) ListByAutomationAccountComplete 

func (c ModuleClient) ListByAutomationAccountComplete(ctx context.Context, id AutomationAccountId) (ListByAutomationAccountCompleteResult, error)

ListByAutomationAccountComplete retrieves all of the results into a single object

func (ModuleClient) ListByAutomationAccountCompleteMatchingPredicate 

func (c ModuleClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, predicate ModuleOperationPredicate) (resp ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ModuleClient) Update 

func (c ModuleClient) Update(ctx context.Context, id ModuleId, input ModuleUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

type ModuleCreateOrUpdateParameters 

type ModuleCreateOrUpdateParameters struct {
	Location   *string                        `json:"location,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties ModuleCreateOrUpdateProperties `json:"properties"`
	Tags       *map[string]string             `json:"tags,omitempty"`
}

type ModuleCreateOrUpdateProperties 

type ModuleCreateOrUpdateProperties struct {
	ContentLink ContentLink `json:"contentLink"`
}

type ModuleErrorInfo 

type ModuleErrorInfo struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

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

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

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

type ModuleOperationPredicate 

type ModuleOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ModuleOperationPredicate) Matches 

func (p ModuleOperationPredicate) Matches(input Module) bool

type ModuleProperties 

type ModuleProperties struct {
	ActivityCount     *int64                   `json:"activityCount,omitempty"`
	ContentLink       *ContentLink             `json:"contentLink,omitempty"`
	CreationTime      *string                  `json:"creationTime,omitempty"`
	Description       *string                  `json:"description,omitempty"`
	Error             *ModuleErrorInfo         `json:"error,omitempty"`
	IsComposite       *bool                    `json:"isComposite,omitempty"`
	IsGlobal          *bool                    `json:"isGlobal,omitempty"`
	LastModifiedTime  *string                  `json:"lastModifiedTime,omitempty"`
	ProvisioningState *ModuleProvisioningState `json:"provisioningState,omitempty"`
	SizeInBytes       *int64                   `json:"sizeInBytes,omitempty"`
	Version           *string                  `json:"version,omitempty"`
}

func (*ModuleProperties) GetCreationTimeAsTime 

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

func (*ModuleProperties) GetLastModifiedTimeAsTime 

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

func (*ModuleProperties) SetCreationTimeAsTime 

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

func (*ModuleProperties) SetLastModifiedTimeAsTime 

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

type ModuleProvisioningState 

type ModuleProvisioningState string
const (
	ModuleProvisioningStateActivitiesStored            ModuleProvisioningState = "ActivitiesStored"
	ModuleProvisioningStateCancelled                   ModuleProvisioningState = "Cancelled"
	ModuleProvisioningStateConnectionTypeImported      ModuleProvisioningState = "ConnectionTypeImported"
	ModuleProvisioningStateContentDownloaded           ModuleProvisioningState = "ContentDownloaded"
	ModuleProvisioningStateContentRetrieved            ModuleProvisioningState = "ContentRetrieved"
	ModuleProvisioningStateContentStored               ModuleProvisioningState = "ContentStored"
	ModuleProvisioningStateContentValidated            ModuleProvisioningState = "ContentValidated"
	ModuleProvisioningStateCreated                     ModuleProvisioningState = "Created"
	ModuleProvisioningStateCreating                    ModuleProvisioningState = "Creating"
	ModuleProvisioningStateFailed                      ModuleProvisioningState = "Failed"
	ModuleProvisioningStateModuleDataStored            ModuleProvisioningState = "ModuleDataStored"
	ModuleProvisioningStateModuleImportRunbookComplete ModuleProvisioningState = "ModuleImportRunbookComplete"
	ModuleProvisioningStateRunningImportModuleRunbook  ModuleProvisioningState = "RunningImportModuleRunbook"
	ModuleProvisioningStateStartingImportModuleRunbook ModuleProvisioningState = "StartingImportModuleRunbook"
	ModuleProvisioningStateSucceeded                   ModuleProvisioningState = "Succeeded"
	ModuleProvisioningStateUpdating                    ModuleProvisioningState = "Updating"
)

type ModuleUpdateParameters 

type ModuleUpdateParameters struct {
	Location   *string                 `json:"location,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *ModuleUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string      `json:"tags,omitempty"`
}

type ModuleUpdateProperties 

type ModuleUpdateProperties struct {
	ContentLink *ContentLink `json:"contentLink,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Module
}

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.