softwareupdateconfigurationmachinerun

package
v0.20240731.1170959 Latest Latest
Warning

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

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

README

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

The softwareupdateconfigurationmachinerun 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/softwareupdateconfigurationmachinerun"

Client Initialization

client := softwareupdateconfigurationmachinerun.NewSoftwareUpdateConfigurationMachineRunClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SoftwareUpdateConfigurationMachineRunClient.GetById

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

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

Example Usage: SoftwareUpdateConfigurationMachineRunClient.List

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

// alternatively `client.List(ctx, id, softwareupdateconfigurationmachinerun.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, softwareupdateconfigurationmachinerun.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 ValidateAutomationAccountID 

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

func ValidateSoftwareUpdateConfigurationMachineRunID 

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

ValidateSoftwareUpdateConfigurationMachineRunID checks that 'input' can be parsed as a Software Update Configuration Machine Run 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 ErrorResponse 

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

type GetByIdOperationOptions 

type GetByIdOperationOptions struct {
	ClientRequestId *string
}

func DefaultGetByIdOperationOptions 

func DefaultGetByIdOperationOptions() GetByIdOperationOptions

func (GetByIdOperationOptions) ToHeaders 

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

func (GetByIdOperationOptions) ToOData 

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

func (GetByIdOperationOptions) ToQuery 

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

type GetByIdOperationResponse 

type GetByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SoftwareUpdateConfigurationMachineRun
}

type JobNavigation 

type JobNavigation struct {
	Id *string `json:"id,omitempty"`
}

type ListCompleteResult added in v0.20240226.1173038 

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

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 {
	ClientRequestId *string
	Filter          *string
	Skip            *string
	Top             *string
}

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        *[]SoftwareUpdateConfigurationMachineRun
}

type SoftwareUpdateConfigurationMachineRun 

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

type SoftwareUpdateConfigurationMachineRunClient 

type SoftwareUpdateConfigurationMachineRunClient struct {
	Client *resourcemanager.Client
}

func NewSoftwareUpdateConfigurationMachineRunClientWithBaseURI 

func NewSoftwareUpdateConfigurationMachineRunClientWithBaseURI(sdkApi sdkEnv.Api) (*SoftwareUpdateConfigurationMachineRunClient, error)

func (SoftwareUpdateConfigurationMachineRunClient) GetById 

func (c SoftwareUpdateConfigurationMachineRunClient) GetById(ctx context.Context, id SoftwareUpdateConfigurationMachineRunId, options GetByIdOperationOptions) (result GetByIdOperationResponse, err error)

GetById ...

func (SoftwareUpdateConfigurationMachineRunClient) List 

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

List ...

func (SoftwareUpdateConfigurationMachineRunClient) ListComplete added in v0.20240226.1173038 

func (c SoftwareUpdateConfigurationMachineRunClient) ListComplete(ctx context.Context, id AutomationAccountId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SoftwareUpdateConfigurationMachineRunClient) ListCompleteMatchingPredicate added in v0.20240226.1173038 

func (c SoftwareUpdateConfigurationMachineRunClient) ListCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, options ListOperationOptions, predicate SoftwareUpdateConfigurationMachineRunOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SoftwareUpdateConfigurationMachineRunId 

type SoftwareUpdateConfigurationMachineRunId struct {
	SubscriptionId                          string
	ResourceGroupName                       string
	AutomationAccountName                   string
	SoftwareUpdateConfigurationMachineRunId string
}

SoftwareUpdateConfigurationMachineRunId is a struct representing the Resource ID for a Software Update Configuration Machine Run

func NewSoftwareUpdateConfigurationMachineRunID 

func NewSoftwareUpdateConfigurationMachineRunID(subscriptionId string, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationMachineRunId string) SoftwareUpdateConfigurationMachineRunId

NewSoftwareUpdateConfigurationMachineRunID returns a new SoftwareUpdateConfigurationMachineRunId struct

func ParseSoftwareUpdateConfigurationMachineRunID 

func ParseSoftwareUpdateConfigurationMachineRunID(input string) (*SoftwareUpdateConfigurationMachineRunId, error)

ParseSoftwareUpdateConfigurationMachineRunID parses 'input' into a SoftwareUpdateConfigurationMachineRunId

func ParseSoftwareUpdateConfigurationMachineRunIDInsensitively 

func ParseSoftwareUpdateConfigurationMachineRunIDInsensitively(input string) (*SoftwareUpdateConfigurationMachineRunId, error)

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

func (*SoftwareUpdateConfigurationMachineRunId) FromParseResult 

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

func (SoftwareUpdateConfigurationMachineRunId) ID 

func (id SoftwareUpdateConfigurationMachineRunId) ID() string

ID returns the formatted Software Update Configuration Machine Run ID

func (SoftwareUpdateConfigurationMachineRunId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Software Update Configuration Machine Run ID

func (SoftwareUpdateConfigurationMachineRunId) String 

func (id SoftwareUpdateConfigurationMachineRunId) String() string

String returns a human-readable description of this Software Update Configuration Machine Run ID

type SoftwareUpdateConfigurationMachineRunOperationPredicate added in v0.20240226.1173038 

type SoftwareUpdateConfigurationMachineRunOperationPredicate struct {
	Id   *string
	Name *string
}

func (SoftwareUpdateConfigurationMachineRunOperationPredicate) Matches added in v0.20240226.1173038 

func (p SoftwareUpdateConfigurationMachineRunOperationPredicate) Matches(input SoftwareUpdateConfigurationMachineRun) bool

type UpdateConfigurationMachineRunProperties 

type UpdateConfigurationMachineRunProperties struct {
	ConfiguredDuration          *string                        `json:"configuredDuration,omitempty"`
	CorrelationId               *string                        `json:"correlationId,omitempty"`
	CreatedBy                   *string                        `json:"createdBy,omitempty"`
	CreationTime                *string                        `json:"creationTime,omitempty"`
	EndTime                     *string                        `json:"endTime,omitempty"`
	Error                       *ErrorResponse                 `json:"error,omitempty"`
	Job                         *JobNavigation                 `json:"job,omitempty"`
	LastModifiedBy              *string                        `json:"lastModifiedBy,omitempty"`
	LastModifiedTime            *string                        `json:"lastModifiedTime,omitempty"`
	OsType                      *string                        `json:"osType,omitempty"`
	SoftwareUpdateConfiguration *UpdateConfigurationNavigation `json:"softwareUpdateConfiguration,omitempty"`
	SourceComputerId            *string                        `json:"sourceComputerId,omitempty"`
	StartTime                   *string                        `json:"startTime,omitempty"`
	Status                      *string                        `json:"status,omitempty"`
	TargetComputer              *string                        `json:"targetComputer,omitempty"`
	TargetComputerType          *string                        `json:"targetComputerType,omitempty"`
}

func (*UpdateConfigurationMachineRunProperties) GetCreationTimeAsTime 

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

func (*UpdateConfigurationMachineRunProperties) GetEndTimeAsTime 

func (o *UpdateConfigurationMachineRunProperties) GetEndTimeAsTime() (*time.Time, error)

func (*UpdateConfigurationMachineRunProperties) GetLastModifiedTimeAsTime 

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

func (*UpdateConfigurationMachineRunProperties) GetStartTimeAsTime 

func (o *UpdateConfigurationMachineRunProperties) GetStartTimeAsTime() (*time.Time, error)

func (*UpdateConfigurationMachineRunProperties) SetCreationTimeAsTime 

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

func (*UpdateConfigurationMachineRunProperties) SetEndTimeAsTime 

func (o *UpdateConfigurationMachineRunProperties) SetEndTimeAsTime(input time.Time)

func (*UpdateConfigurationMachineRunProperties) SetLastModifiedTimeAsTime 

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

func (*UpdateConfigurationMachineRunProperties) SetStartTimeAsTime 

func (o *UpdateConfigurationMachineRunProperties) SetStartTimeAsTime(input time.Time)

type UpdateConfigurationNavigation 

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

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.