softwareupdateconfigurationrun

package
v0.20240603.1222802 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2023-11-01/softwareupdateconfigurationrun Documentation

The softwareupdateconfigurationrun SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2023-11-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/automation/2023-11-01/softwareupdateconfigurationrun"

Client Initialization

client := softwareupdateconfigurationrun.NewSoftwareUpdateConfigurationRunClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SoftwareUpdateConfigurationRunClient.GetById

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

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

Example Usage: SoftwareUpdateConfigurationRunClient.List

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

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

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

ValidateSoftwareUpdateConfigurationRunID checks that 'input' can be parsed as a Software Update Configuration 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 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        *SoftwareUpdateConfigurationRun
}

type ListCompleteResult added in v0.20240226.1173038 

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

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

type SoftwareUpdateConfigurationRun 

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

type SoftwareUpdateConfigurationRunClient 

type SoftwareUpdateConfigurationRunClient struct {
	Client *resourcemanager.Client
}

func NewSoftwareUpdateConfigurationRunClientWithBaseURI 

func NewSoftwareUpdateConfigurationRunClientWithBaseURI(sdkApi sdkEnv.Api) (*SoftwareUpdateConfigurationRunClient, error)

func (SoftwareUpdateConfigurationRunClient) GetById 

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

GetById ...

func (SoftwareUpdateConfigurationRunClient) List 

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

List ...

func (SoftwareUpdateConfigurationRunClient) ListComplete added in v0.20240226.1173038 

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

ListComplete retrieves all the results into a single object

func (SoftwareUpdateConfigurationRunClient) ListCompleteMatchingPredicate added in v0.20240226.1173038 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SoftwareUpdateConfigurationRunId 

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

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

func NewSoftwareUpdateConfigurationRunID 

func NewSoftwareUpdateConfigurationRunID(subscriptionId string, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationRunId string) SoftwareUpdateConfigurationRunId

NewSoftwareUpdateConfigurationRunID returns a new SoftwareUpdateConfigurationRunId struct

func ParseSoftwareUpdateConfigurationRunID 

func ParseSoftwareUpdateConfigurationRunID(input string) (*SoftwareUpdateConfigurationRunId, error)

ParseSoftwareUpdateConfigurationRunID parses 'input' into a SoftwareUpdateConfigurationRunId

func ParseSoftwareUpdateConfigurationRunIDInsensitively 

func ParseSoftwareUpdateConfigurationRunIDInsensitively(input string) (*SoftwareUpdateConfigurationRunId, error)

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

func (*SoftwareUpdateConfigurationRunId) FromParseResult 

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

func (SoftwareUpdateConfigurationRunId) ID 

func (id SoftwareUpdateConfigurationRunId) ID() string

ID returns the formatted Software Update Configuration Run ID

func (SoftwareUpdateConfigurationRunId) Segments 

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

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

func (SoftwareUpdateConfigurationRunId) String 

func (id SoftwareUpdateConfigurationRunId) String() string

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

type SoftwareUpdateConfigurationRunOperationPredicate added in v0.20240226.1173038 

type SoftwareUpdateConfigurationRunOperationPredicate struct {
	Id   *string
	Name *string
}

func (SoftwareUpdateConfigurationRunOperationPredicate) Matches added in v0.20240226.1173038 

func (p SoftwareUpdateConfigurationRunOperationPredicate) Matches(input SoftwareUpdateConfigurationRun) bool

type SoftwareUpdateConfigurationRunProperties 

type SoftwareUpdateConfigurationRunProperties struct {
	ComputerCount               *int64                               `json:"computerCount,omitempty"`
	ConfiguredDuration          *string                              `json:"configuredDuration,omitempty"`
	CreatedBy                   *string                              `json:"createdBy,omitempty"`
	CreationTime                *string                              `json:"creationTime,omitempty"`
	EndTime                     *string                              `json:"endTime,omitempty"`
	FailedCount                 *int64                               `json:"failedCount,omitempty"`
	LastModifiedBy              *string                              `json:"lastModifiedBy,omitempty"`
	LastModifiedTime            *string                              `json:"lastModifiedTime,omitempty"`
	OsType                      *string                              `json:"osType,omitempty"`
	SoftwareUpdateConfiguration *UpdateConfigurationNavigation       `json:"softwareUpdateConfiguration,omitempty"`
	StartTime                   *string                              `json:"startTime,omitempty"`
	Status                      *string                              `json:"status,omitempty"`
	Tasks                       *SoftwareUpdateConfigurationRunTasks `json:"tasks,omitempty"`
}

func (*SoftwareUpdateConfigurationRunProperties) GetCreationTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) GetEndTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) GetLastModifiedTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) GetStartTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) SetCreationTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) SetEndTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) SetLastModifiedTimeAsTime 

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

func (*SoftwareUpdateConfigurationRunProperties) SetStartTimeAsTime 

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

type SoftwareUpdateConfigurationRunTaskProperties 

type SoftwareUpdateConfigurationRunTaskProperties struct {
	JobId  *string `json:"jobId,omitempty"`
	Source *string `json:"source,omitempty"`
	Status *string `json:"status,omitempty"`
}

type SoftwareUpdateConfigurationRunTasks 

type SoftwareUpdateConfigurationRunTasks struct {
	PostTask *SoftwareUpdateConfigurationRunTaskProperties `json:"postTask,omitempty"`
	PreTask  *SoftwareUpdateConfigurationRunTaskProperties `json:"preTask,omitempty"`
}

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.