softwareupdateconfiguration

package
v0.20230714.1170806 Latest Latest
Warning

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

Go to latest
Published: Jul 14, 2023 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2019-06-01/softwareupdateconfiguration Documentation

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

Client Initialization

client := softwareupdateconfiguration.NewSoftwareUpdateConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SoftwareUpdateConfigurationClient.SoftwareUpdateConfigurationsCreate

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

payload := softwareupdateconfiguration.SoftwareUpdateConfiguration{
	// ...
}


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

Example Usage: SoftwareUpdateConfigurationClient.SoftwareUpdateConfigurationsDelete

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

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

Example Usage: SoftwareUpdateConfigurationClient.SoftwareUpdateConfigurationsGetByName

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

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

Example Usage: SoftwareUpdateConfigurationClient.SoftwareUpdateConfigurationsList

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

read, err := client.SoftwareUpdateConfigurationsList(ctx, id, softwareupdateconfiguration.DefaultSoftwareUpdateConfigurationsListOperationOptions())
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 PossibleValuesForLinuxUpdateClasses

func PossibleValuesForLinuxUpdateClasses() []string

func PossibleValuesForOperatingSystemType

func PossibleValuesForOperatingSystemType() []string

func PossibleValuesForScheduleDay

func PossibleValuesForScheduleDay() []string

func PossibleValuesForScheduleFrequency

func PossibleValuesForScheduleFrequency() []string

func PossibleValuesForTagOperators

func PossibleValuesForTagOperators() []string

func PossibleValuesForWindowsUpdateClasses

func PossibleValuesForWindowsUpdateClasses() []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 ValidateSoftwareUpdateConfigurationID

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

ValidateSoftwareUpdateConfigurationID checks that 'input' can be parsed as a Software Update Configuration ID

Types

type AdvancedSchedule

type AdvancedSchedule struct {
	MonthDays          *[]int64                             `json:"monthDays,omitempty"`
	MonthlyOccurrences *[]AdvancedScheduleMonthlyOccurrence `json:"monthlyOccurrences,omitempty"`
	WeekDays           *[]string                            `json:"weekDays,omitempty"`
}

type AdvancedScheduleMonthlyOccurrence

type AdvancedScheduleMonthlyOccurrence struct {
	Day        *ScheduleDay `json:"day,omitempty"`
	Occurrence *int64       `json:"occurrence,omitempty"`
}

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

type AzureQueryProperties struct {
	Locations   *[]string              `json:"locations,omitempty"`
	Scope       *[]string              `json:"scope,omitempty"`
	TagSettings *TagSettingsProperties `json:"tagSettings,omitempty"`
}

type ErrorResponse

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

type LinuxProperties

type LinuxProperties struct {
	ExcludedPackageNameMasks       *[]string           `json:"excludedPackageNameMasks,omitempty"`
	IncludedPackageClassifications *LinuxUpdateClasses `json:"includedPackageClassifications,omitempty"`
	IncludedPackageNameMasks       *[]string           `json:"includedPackageNameMasks,omitempty"`
	RebootSetting                  *string             `json:"rebootSetting,omitempty"`
}

type LinuxUpdateClasses

type LinuxUpdateClasses string
const (
	LinuxUpdateClassesCritical     LinuxUpdateClasses = "Critical"
	LinuxUpdateClassesOther        LinuxUpdateClasses = "Other"
	LinuxUpdateClassesSecurity     LinuxUpdateClasses = "Security"
	LinuxUpdateClassesUnclassified LinuxUpdateClasses = "Unclassified"
)

type NonAzureQueryProperties

type NonAzureQueryProperties struct {
	FunctionAlias *string `json:"functionAlias,omitempty"`
	WorkspaceId   *string `json:"workspaceId,omitempty"`
}

type OperatingSystemType

type OperatingSystemType string
const (
	OperatingSystemTypeLinux   OperatingSystemType = "Linux"
	OperatingSystemTypeWindows OperatingSystemType = "Windows"
)

type SUCScheduleProperties

type SUCScheduleProperties struct {
	AdvancedSchedule        *AdvancedSchedule  `json:"advancedSchedule,omitempty"`
	CreationTime            *string            `json:"creationTime,omitempty"`
	Description             *string            `json:"description,omitempty"`
	ExpiryTime              *string            `json:"expiryTime,omitempty"`
	ExpiryTimeOffsetMinutes *float64           `json:"expiryTimeOffsetMinutes,omitempty"`
	Frequency               *ScheduleFrequency `json:"frequency,omitempty"`
	Interval                *int64             `json:"interval,omitempty"`
	IsEnabled               *bool              `json:"isEnabled,omitempty"`
	LastModifiedTime        *string            `json:"lastModifiedTime,omitempty"`
	NextRun                 *string            `json:"nextRun,omitempty"`
	NextRunOffsetMinutes    *float64           `json:"nextRunOffsetMinutes,omitempty"`
	StartTime               *string            `json:"startTime,omitempty"`
	StartTimeOffsetMinutes  *float64           `json:"startTimeOffsetMinutes,omitempty"`
	TimeZone                *string            `json:"timeZone,omitempty"`
}

func (*SUCScheduleProperties) GetCreationTimeAsTime

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

func (*SUCScheduleProperties) GetExpiryTimeAsTime

func (o *SUCScheduleProperties) GetExpiryTimeAsTime() (*time.Time, error)

func (*SUCScheduleProperties) GetLastModifiedTimeAsTime

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

func (*SUCScheduleProperties) GetNextRunAsTime

func (o *SUCScheduleProperties) GetNextRunAsTime() (*time.Time, error)

func (*SUCScheduleProperties) GetStartTimeAsTime

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

func (*SUCScheduleProperties) SetCreationTimeAsTime

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

func (*SUCScheduleProperties) SetExpiryTimeAsTime

func (o *SUCScheduleProperties) SetExpiryTimeAsTime(input time.Time)

func (*SUCScheduleProperties) SetLastModifiedTimeAsTime

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

func (*SUCScheduleProperties) SetNextRunAsTime

func (o *SUCScheduleProperties) SetNextRunAsTime(input time.Time)

func (*SUCScheduleProperties) SetStartTimeAsTime

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

type ScheduleDay

type ScheduleDay string
const (
	ScheduleDayFriday    ScheduleDay = "Friday"
	ScheduleDayMonday    ScheduleDay = "Monday"
	ScheduleDaySaturday  ScheduleDay = "Saturday"
	ScheduleDaySunday    ScheduleDay = "Sunday"
	ScheduleDayThursday  ScheduleDay = "Thursday"
	ScheduleDayTuesday   ScheduleDay = "Tuesday"
	ScheduleDayWednesday ScheduleDay = "Wednesday"
)

type ScheduleFrequency

type ScheduleFrequency string
const (
	ScheduleFrequencyDay     ScheduleFrequency = "Day"
	ScheduleFrequencyHour    ScheduleFrequency = "Hour"
	ScheduleFrequencyMinute  ScheduleFrequency = "Minute"
	ScheduleFrequencyMonth   ScheduleFrequency = "Month"
	ScheduleFrequencyOneTime ScheduleFrequency = "OneTime"
	ScheduleFrequencyWeek    ScheduleFrequency = "Week"
)

type SoftwareUpdateConfiguration

type SoftwareUpdateConfiguration struct {
	Id         *string                               `json:"id,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties SoftwareUpdateConfigurationProperties `json:"properties"`
	Type       *string                               `json:"type,omitempty"`
}

type SoftwareUpdateConfigurationClient

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

func NewSoftwareUpdateConfigurationClientWithBaseURI

func NewSoftwareUpdateConfigurationClientWithBaseURI(endpoint string) SoftwareUpdateConfigurationClient

func (SoftwareUpdateConfigurationClient) SoftwareUpdateConfigurationsCreate

SoftwareUpdateConfigurationsCreate ...

func (SoftwareUpdateConfigurationClient) SoftwareUpdateConfigurationsDelete

SoftwareUpdateConfigurationsDelete ...

func (SoftwareUpdateConfigurationClient) SoftwareUpdateConfigurationsGetByName

SoftwareUpdateConfigurationsGetByName ...

func (SoftwareUpdateConfigurationClient) SoftwareUpdateConfigurationsList

SoftwareUpdateConfigurationsList ...

type SoftwareUpdateConfigurationCollectionItem

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

type SoftwareUpdateConfigurationCollectionItemProperties

type SoftwareUpdateConfigurationCollectionItemProperties struct {
	CreationTime        *string                           `json:"creationTime,omitempty"`
	Frequency           *ScheduleFrequency                `json:"frequency,omitempty"`
	LastModifiedTime    *string                           `json:"lastModifiedTime,omitempty"`
	NextRun             *string                           `json:"nextRun,omitempty"`
	ProvisioningState   *string                           `json:"provisioningState,omitempty"`
	StartTime           *string                           `json:"startTime,omitempty"`
	Tasks               *SoftwareUpdateConfigurationTasks `json:"tasks,omitempty"`
	UpdateConfiguration *UpdateConfiguration              `json:"updateConfiguration,omitempty"`
}

func (*SoftwareUpdateConfigurationCollectionItemProperties) GetCreationTimeAsTime

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

func (*SoftwareUpdateConfigurationCollectionItemProperties) GetLastModifiedTimeAsTime

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

func (*SoftwareUpdateConfigurationCollectionItemProperties) GetNextRunAsTime

func (*SoftwareUpdateConfigurationCollectionItemProperties) GetStartTimeAsTime

func (*SoftwareUpdateConfigurationCollectionItemProperties) SetCreationTimeAsTime

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

func (*SoftwareUpdateConfigurationCollectionItemProperties) SetLastModifiedTimeAsTime

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

func (*SoftwareUpdateConfigurationCollectionItemProperties) SetNextRunAsTime

func (*SoftwareUpdateConfigurationCollectionItemProperties) SetStartTimeAsTime

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

type SoftwareUpdateConfigurationId

type SoftwareUpdateConfigurationId struct {
	SubscriptionId                  string
	ResourceGroupName               string
	AutomationAccountName           string
	SoftwareUpdateConfigurationName string
}

SoftwareUpdateConfigurationId is a struct representing the Resource ID for a Software Update Configuration

func NewSoftwareUpdateConfigurationID

func NewSoftwareUpdateConfigurationID(subscriptionId string, resourceGroupName string, automationAccountName string, softwareUpdateConfigurationName string) SoftwareUpdateConfigurationId

NewSoftwareUpdateConfigurationID returns a new SoftwareUpdateConfigurationId struct

func ParseSoftwareUpdateConfigurationID

func ParseSoftwareUpdateConfigurationID(input string) (*SoftwareUpdateConfigurationId, error)

ParseSoftwareUpdateConfigurationID parses 'input' into a SoftwareUpdateConfigurationId

func ParseSoftwareUpdateConfigurationIDInsensitively

func ParseSoftwareUpdateConfigurationIDInsensitively(input string) (*SoftwareUpdateConfigurationId, error)

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

func (SoftwareUpdateConfigurationId) ID

ID returns the formatted Software Update Configuration ID

func (SoftwareUpdateConfigurationId) Segments

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

func (SoftwareUpdateConfigurationId) String

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

type SoftwareUpdateConfigurationListResult

type SoftwareUpdateConfigurationListResult struct {
	Value *[]SoftwareUpdateConfigurationCollectionItem `json:"value,omitempty"`
}

type SoftwareUpdateConfigurationProperties

type SoftwareUpdateConfigurationProperties struct {
	CreatedBy           *string                           `json:"createdBy,omitempty"`
	CreationTime        *string                           `json:"creationTime,omitempty"`
	Error               *ErrorResponse                    `json:"error,omitempty"`
	LastModifiedBy      *string                           `json:"lastModifiedBy,omitempty"`
	LastModifiedTime    *string                           `json:"lastModifiedTime,omitempty"`
	ProvisioningState   *string                           `json:"provisioningState,omitempty"`
	ScheduleInfo        SUCScheduleProperties             `json:"scheduleInfo"`
	Tasks               *SoftwareUpdateConfigurationTasks `json:"tasks,omitempty"`
	UpdateConfiguration UpdateConfiguration               `json:"updateConfiguration"`
}

func (*SoftwareUpdateConfigurationProperties) GetCreationTimeAsTime

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

func (*SoftwareUpdateConfigurationProperties) GetLastModifiedTimeAsTime

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

func (*SoftwareUpdateConfigurationProperties) SetCreationTimeAsTime

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

func (*SoftwareUpdateConfigurationProperties) SetLastModifiedTimeAsTime

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

type SoftwareUpdateConfigurationTasks

type SoftwareUpdateConfigurationTasks struct {
	PostTask *TaskProperties `json:"postTask,omitempty"`
	PreTask  *TaskProperties `json:"preTask,omitempty"`
}

type SoftwareUpdateConfigurationsCreateOperationOptions

type SoftwareUpdateConfigurationsCreateOperationOptions struct {
	ClientRequestId *string
}

func DefaultSoftwareUpdateConfigurationsCreateOperationOptions

func DefaultSoftwareUpdateConfigurationsCreateOperationOptions() SoftwareUpdateConfigurationsCreateOperationOptions

type SoftwareUpdateConfigurationsCreateOperationResponse

type SoftwareUpdateConfigurationsCreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *SoftwareUpdateConfiguration
}

type SoftwareUpdateConfigurationsDeleteOperationOptions

type SoftwareUpdateConfigurationsDeleteOperationOptions struct {
	ClientRequestId *string
}

func DefaultSoftwareUpdateConfigurationsDeleteOperationOptions

func DefaultSoftwareUpdateConfigurationsDeleteOperationOptions() SoftwareUpdateConfigurationsDeleteOperationOptions

type SoftwareUpdateConfigurationsDeleteOperationResponse

type SoftwareUpdateConfigurationsDeleteOperationResponse struct {
	HttpResponse *http.Response
}

type SoftwareUpdateConfigurationsGetByNameOperationOptions

type SoftwareUpdateConfigurationsGetByNameOperationOptions struct {
	ClientRequestId *string
}

func DefaultSoftwareUpdateConfigurationsGetByNameOperationOptions

func DefaultSoftwareUpdateConfigurationsGetByNameOperationOptions() SoftwareUpdateConfigurationsGetByNameOperationOptions

type SoftwareUpdateConfigurationsGetByNameOperationResponse

type SoftwareUpdateConfigurationsGetByNameOperationResponse struct {
	HttpResponse *http.Response
	Model        *SoftwareUpdateConfiguration
}

type SoftwareUpdateConfigurationsListOperationOptions

type SoftwareUpdateConfigurationsListOperationOptions struct {
	ClientRequestId *string
	Filter          *string
}

func DefaultSoftwareUpdateConfigurationsListOperationOptions

func DefaultSoftwareUpdateConfigurationsListOperationOptions() SoftwareUpdateConfigurationsListOperationOptions

type SoftwareUpdateConfigurationsListOperationResponse

type SoftwareUpdateConfigurationsListOperationResponse struct {
	HttpResponse *http.Response
	Model        *SoftwareUpdateConfigurationListResult
}

type TagOperators

type TagOperators string
const (
	TagOperatorsAll TagOperators = "All"
	TagOperatorsAny TagOperators = "Any"
)

type TagSettingsProperties

type TagSettingsProperties struct {
	FilterOperator *TagOperators        `json:"filterOperator,omitempty"`
	Tags           *map[string][]string `json:"tags,omitempty"`
}

type TargetProperties

type TargetProperties struct {
	AzureQueries    *[]AzureQueryProperties    `json:"azureQueries,omitempty"`
	NonAzureQueries *[]NonAzureQueryProperties `json:"nonAzureQueries,omitempty"`
}

type TaskProperties

type TaskProperties struct {
	Parameters *map[string]string `json:"parameters,omitempty"`
	Source     *string            `json:"source,omitempty"`
}

type UpdateConfiguration

type UpdateConfiguration struct {
	AzureVirtualMachines  *[]string           `json:"azureVirtualMachines,omitempty"`
	Duration              *string             `json:"duration,omitempty"`
	Linux                 *LinuxProperties    `json:"linux,omitempty"`
	NonAzureComputerNames *[]string           `json:"nonAzureComputerNames,omitempty"`
	OperatingSystem       OperatingSystemType `json:"operatingSystem"`
	Targets               *TargetProperties   `json:"targets,omitempty"`
	Windows               *WindowsProperties  `json:"windows,omitempty"`
}

type WindowsProperties

type WindowsProperties struct {
	ExcludedKbNumbers             *[]string             `json:"excludedKbNumbers,omitempty"`
	IncludedKbNumbers             *[]string             `json:"includedKbNumbers,omitempty"`
	IncludedUpdateClassifications *WindowsUpdateClasses `json:"includedUpdateClassifications,omitempty"`
	RebootSetting                 *string               `json:"rebootSetting,omitempty"`
}

type WindowsUpdateClasses

type WindowsUpdateClasses string
const (
	WindowsUpdateClassesCritical     WindowsUpdateClasses = "Critical"
	WindowsUpdateClassesDefinition   WindowsUpdateClasses = "Definition"
	WindowsUpdateClassesFeaturePack  WindowsUpdateClasses = "FeaturePack"
	WindowsUpdateClassesSecurity     WindowsUpdateClasses = "Security"
	WindowsUpdateClassesServicePack  WindowsUpdateClasses = "ServicePack"
	WindowsUpdateClassesTools        WindowsUpdateClasses = "Tools"
	WindowsUpdateClassesUnclassified WindowsUpdateClasses = "Unclassified"
	WindowsUpdateClassesUpdateRollup WindowsUpdateClasses = "UpdateRollup"
	WindowsUpdateClassesUpdates      WindowsUpdateClasses = "Updates"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL