publicmaintenanceconfigurations

README

github.com/hashicorp/go-azure-sdk/resource-manager/maintenance/2022-07-01-preview/publicmaintenanceconfigurations Documentation

The publicmaintenanceconfigurations SDK allows for interaction with the Azure Resource Manager Service maintenance (API Version 2022-07-01-preview).

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/maintenance/2022-07-01-preview/publicmaintenanceconfigurations"

Client Initialization

client := publicmaintenanceconfigurations.NewPublicMaintenanceConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PublicMaintenanceConfigurationsClient.Get

ctx := context.TODO()
id := publicmaintenanceconfigurations.NewPublicMaintenanceConfigurationID("12345678-1234-9876-4563-123456789012", "publicMaintenanceConfigurationValue")

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: PublicMaintenanceConfigurationsClient.List

ctx := context.TODO()
id := publicmaintenanceconfigurations.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

• func PossibleValuesForMaintenanceScope() []string
• func PossibleValuesForRebootOptions() []string
• func PossibleValuesForTaskScope() []string
• func PossibleValuesForVisibility() []string
• func ValidatePublicMaintenanceConfigurationID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type InputLinuxParameters
• type InputPatchConfiguration
• type InputWindowsParameters
• type ListMaintenanceConfigurationsResult
• type ListOperationResponse
• type MaintenanceConfiguration
• type MaintenanceConfigurationProperties
• type MaintenanceScope
• type MaintenanceWindow
• type PublicMaintenanceConfigurationId
  • func NewPublicMaintenanceConfigurationID(subscriptionId string, publicMaintenanceConfigurationName string) PublicMaintenanceConfigurationId
  • func ParsePublicMaintenanceConfigurationID(input string) (*PublicMaintenanceConfigurationId, error)
  • func ParsePublicMaintenanceConfigurationIDInsensitively(input string) (*PublicMaintenanceConfigurationId, error)
  • func (id PublicMaintenanceConfigurationId) ID() string
  • func (id PublicMaintenanceConfigurationId) Segments() []resourceids.Segment
  • func (id PublicMaintenanceConfigurationId) String() string
• type PublicMaintenanceConfigurationsClient
  • func NewPublicMaintenanceConfigurationsClientWithBaseURI(endpoint string) PublicMaintenanceConfigurationsClient
  • func (c PublicMaintenanceConfigurationsClient) Get(ctx context.Context, id PublicMaintenanceConfigurationId) (result GetOperationResponse, err error)
  • func (c PublicMaintenanceConfigurationsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
• type RebootOptions
• type SoftwareUpdateConfigurationTasks
• type TaskProperties
• type TaskScope
• type Visibility

Functions

func PossibleValuesForMaintenanceScope

func PossibleValuesForMaintenanceScope() []string

func PossibleValuesForRebootOptions

func PossibleValuesForRebootOptions() []string

func PossibleValuesForTaskScope

func PossibleValuesForTaskScope() []string

func PossibleValuesForVisibility

func PossibleValuesForVisibility() []string

func ValidatePublicMaintenanceConfigurationID

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

ValidatePublicMaintenanceConfigurationID checks that 'input' can be parsed as a Public Maintenance Configuration ID

Types

type GetOperationResponse

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

type InputLinuxParameters

type InputLinuxParameters struct {
	ClassificationsToInclude  *[]string `json:"classificationsToInclude,omitempty"`
	PackageNameMasksToExclude *[]string `json:"packageNameMasksToExclude,omitempty"`
	PackageNameMasksToInclude *[]string `json:"packageNameMasksToInclude,omitempty"`
}

type InputPatchConfiguration

type InputPatchConfiguration struct {
	LinuxParameters   *InputLinuxParameters             `json:"linuxParameters,omitempty"`
	RebootSetting     *RebootOptions                    `json:"rebootSetting,omitempty"`
	Tasks             *SoftwareUpdateConfigurationTasks `json:"tasks,omitempty"`
	WindowsParameters *InputWindowsParameters           `json:"windowsParameters,omitempty"`
}

type InputWindowsParameters

type InputWindowsParameters struct {
	ClassificationsToInclude  *[]string `json:"classificationsToInclude,omitempty"`
	ExcludeKbsRequiringReboot *bool     `json:"excludeKbsRequiringReboot,omitempty"`
	KbNumbersToExclude        *[]string `json:"kbNumbersToExclude,omitempty"`
	KbNumbersToInclude        *[]string `json:"kbNumbersToInclude,omitempty"`
}

type ListMaintenanceConfigurationsResult

type ListMaintenanceConfigurationsResult struct {
	Value *[]MaintenanceConfiguration `json:"value,omitempty"`
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *ListMaintenanceConfigurationsResult
}

type MaintenanceConfiguration

type MaintenanceConfiguration struct {
	Id         *string                             `json:"id,omitempty"`
	Location   *string                             `json:"location,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties *MaintenanceConfigurationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Tags       *map[string]string                  `json:"tags,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type MaintenanceConfigurationProperties

type MaintenanceConfigurationProperties struct {
	ExtensionProperties *map[string]string       `json:"extensionProperties,omitempty"`
	InstallPatches      *InputPatchConfiguration `json:"installPatches,omitempty"`
	MaintenanceScope    *MaintenanceScope        `json:"maintenanceScope,omitempty"`
	MaintenanceWindow   *MaintenanceWindow       `json:"maintenanceWindow,omitempty"`
	Namespace           *string                  `json:"namespace,omitempty"`
	Visibility          *Visibility              `json:"visibility,omitempty"`
}

type MaintenanceScope

type MaintenanceScope string

const (
	MaintenanceScopeExtension          MaintenanceScope = "Extension"
	MaintenanceScopeHost               MaintenanceScope = "Host"
	MaintenanceScopeInGuestPatch       MaintenanceScope = "InGuestPatch"
	MaintenanceScopeOSImage            MaintenanceScope = "OSImage"
	MaintenanceScopeResource           MaintenanceScope = "Resource"
	MaintenanceScopeSQLDB              MaintenanceScope = "SQLDB"
	MaintenanceScopeSQLManagedInstance MaintenanceScope = "SQLManagedInstance"
)

type MaintenanceWindow

type MaintenanceWindow struct {
	Duration           *string `json:"duration,omitempty"`
	ExpirationDateTime *string `json:"expirationDateTime,omitempty"`
	RecurEvery         *string `json:"recurEvery,omitempty"`
	StartDateTime      *string `json:"startDateTime,omitempty"`
	TimeZone           *string `json:"timeZone,omitempty"`
}

type PublicMaintenanceConfigurationId

type PublicMaintenanceConfigurationId struct {
	SubscriptionId                     string
	PublicMaintenanceConfigurationName string
}

PublicMaintenanceConfigurationId is a struct representing the Resource ID for a Public Maintenance Configuration

func NewPublicMaintenanceConfigurationID

func NewPublicMaintenanceConfigurationID(subscriptionId string, publicMaintenanceConfigurationName string) PublicMaintenanceConfigurationId

NewPublicMaintenanceConfigurationID returns a new PublicMaintenanceConfigurationId struct

func ParsePublicMaintenanceConfigurationID

func ParsePublicMaintenanceConfigurationID(input string) (*PublicMaintenanceConfigurationId, error)

ParsePublicMaintenanceConfigurationID parses 'input' into a PublicMaintenanceConfigurationId

func ParsePublicMaintenanceConfigurationIDInsensitively

func ParsePublicMaintenanceConfigurationIDInsensitively(input string) (*PublicMaintenanceConfigurationId, error)

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

func (PublicMaintenanceConfigurationId) ID

func (id PublicMaintenanceConfigurationId) ID() string

ID returns the formatted Public Maintenance Configuration ID

func (PublicMaintenanceConfigurationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Public Maintenance Configuration ID

func (PublicMaintenanceConfigurationId) String

func (id PublicMaintenanceConfigurationId) String() string

String returns a human-readable description of this Public Maintenance Configuration ID

type PublicMaintenanceConfigurationsClient

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

func NewPublicMaintenanceConfigurationsClientWithBaseURI

func NewPublicMaintenanceConfigurationsClientWithBaseURI(endpoint string) PublicMaintenanceConfigurationsClient

func (PublicMaintenanceConfigurationsClient) Get

func (c PublicMaintenanceConfigurationsClient) Get(ctx context.Context, id PublicMaintenanceConfigurationId) (result GetOperationResponse, err error)

Get ...

func (PublicMaintenanceConfigurationsClient) List

func (c PublicMaintenanceConfigurationsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

type RebootOptions

type RebootOptions string

const (
	RebootOptionsAlways     RebootOptions = "Always"
	RebootOptionsIfRequired RebootOptions = "IfRequired"
	RebootOptionsNever      RebootOptions = "Never"
)

type SoftwareUpdateConfigurationTasks

type SoftwareUpdateConfigurationTasks struct {
	PostTasks *[]TaskProperties `json:"postTasks,omitempty"`
	PreTasks  *[]TaskProperties `json:"preTasks,omitempty"`
}

type TaskProperties

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

type TaskScope

type TaskScope string

const (
	TaskScopeGlobal   TaskScope = "Global"
	TaskScopeResource TaskScope = "Resource"
)

type Visibility

type Visibility string

const (
	VisibilityCustom Visibility = "Custom"
	VisibilityPublic Visibility = "Public"
)