maintenanceconfigurations

package
v0.20240320.1000025 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/maintenance/2023-04-01/maintenanceconfigurations Documentation

The maintenanceconfigurations SDK allows for interaction with the Azure Resource Manager Service maintenance (API Version 2023-04-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/maintenance/2023-04-01/maintenanceconfigurations"

Client Initialization

client := maintenanceconfigurations.NewMaintenanceConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MaintenanceConfigurationsClient.CreateOrUpdate

ctx := context.TODO()
id := maintenanceconfigurations.NewMaintenanceConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "maintenanceConfigurationValue")

payload := maintenanceconfigurations.MaintenanceConfiguration{
	// ...
}


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

ctx := context.TODO()
id := maintenanceconfigurations.NewMaintenanceConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "maintenanceConfigurationValue")

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: MaintenanceConfigurationsClient.ForResourceGroupList

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

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

Example Usage: MaintenanceConfigurationsClient.Get

ctx := context.TODO()
id := maintenanceconfigurations.NewMaintenanceConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "maintenanceConfigurationValue")

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

ctx := context.TODO()
id := commonids.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
}

Example Usage: MaintenanceConfigurationsClient.Update

ctx := context.TODO()
id := maintenanceconfigurations.NewMaintenanceConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "maintenanceConfigurationValue")

payload := maintenanceconfigurations.MaintenanceConfiguration{
	// ...
}


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 PossibleValuesForMaintenanceScope 

func PossibleValuesForMaintenanceScope() []string

func PossibleValuesForRebootOptions 

func PossibleValuesForRebootOptions() []string

func PossibleValuesForVisibility 

func PossibleValuesForVisibility() []string

func ValidateMaintenanceConfigurationID 

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

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

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MaintenanceConfiguration
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MaintenanceConfiguration
}

type ForResourceGroupListOperationResponse 

type ForResourceGroupListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListMaintenanceConfigurationsResult
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	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"`
	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
	OData        *odata.OData
	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 MaintenanceConfigurationId 

type MaintenanceConfigurationId struct {
	SubscriptionId               string
	ResourceGroupName            string
	MaintenanceConfigurationName string
}

MaintenanceConfigurationId is a struct representing the Resource ID for a Maintenance Configuration

func NewMaintenanceConfigurationID 

func NewMaintenanceConfigurationID(subscriptionId string, resourceGroupName string, maintenanceConfigurationName string) MaintenanceConfigurationId

NewMaintenanceConfigurationID returns a new MaintenanceConfigurationId struct

func ParseMaintenanceConfigurationID 

func ParseMaintenanceConfigurationID(input string) (*MaintenanceConfigurationId, error)

ParseMaintenanceConfigurationID parses 'input' into a MaintenanceConfigurationId

func ParseMaintenanceConfigurationIDInsensitively 

func ParseMaintenanceConfigurationIDInsensitively(input string) (*MaintenanceConfigurationId, error)

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

func (*MaintenanceConfigurationId) FromParseResult 

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

func (MaintenanceConfigurationId) ID 

func (id MaintenanceConfigurationId) ID() string

ID returns the formatted Maintenance Configuration ID

func (MaintenanceConfigurationId) Segments 

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

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

func (MaintenanceConfigurationId) String 

func (id MaintenanceConfigurationId) String() string

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

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 MaintenanceConfigurationsClient 

type MaintenanceConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewMaintenanceConfigurationsClientWithBaseURI 

func NewMaintenanceConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*MaintenanceConfigurationsClient, error)

func (MaintenanceConfigurationsClient) CreateOrUpdate 

func (c MaintenanceConfigurationsClient) CreateOrUpdate(ctx context.Context, id MaintenanceConfigurationId, input MaintenanceConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MaintenanceConfigurationsClient) Delete 

func (c MaintenanceConfigurationsClient) Delete(ctx context.Context, id MaintenanceConfigurationId) (result DeleteOperationResponse, err error)

Delete ...

func (MaintenanceConfigurationsClient) ForResourceGroupList 

func (c MaintenanceConfigurationsClient) ForResourceGroupList(ctx context.Context, id commonids.ResourceGroupId) (result ForResourceGroupListOperationResponse, err error)

ForResourceGroupList ...

func (MaintenanceConfigurationsClient) Get 

func (c MaintenanceConfigurationsClient) Get(ctx context.Context, id MaintenanceConfigurationId) (result GetOperationResponse, err error)

Get ...

func (MaintenanceConfigurationsClient) List 

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

List ...

func (MaintenanceConfigurationsClient) Update 

func (c MaintenanceConfigurationsClient) Update(ctx context.Context, id MaintenanceConfigurationId, input MaintenanceConfiguration) (result UpdateOperationResponse, err error)

Update ...

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

func (*MaintenanceScope) UnmarshalJSON added in v0.20240208.1165011 

func (s *MaintenanceScope) UnmarshalJSON(bytes []byte) error

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 RebootOptions 

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

func (*RebootOptions) UnmarshalJSON added in v0.20240208.1165011 

func (s *RebootOptions) UnmarshalJSON(bytes []byte) error

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MaintenanceConfiguration
}

type Visibility 

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

func (*Visibility) UnmarshalJSON added in v0.20240208.1165011 

func (s *Visibility) UnmarshalJSON(bytes []byte) error

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.