maintenanceconfigurations

README

github.com/hashicorp/go-azure-sdk/resource-manager/maintenance/2021-05-01/maintenanceconfigurations Documentation

The maintenanceconfigurations SDK allows for interaction with the Azure Resource Manager Service maintenance (API Version 2021-05-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/maintenance/2021-05-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 := maintenanceconfigurations.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 := maintenanceconfigurations.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

• func PossibleValuesForMaintenanceScope() []string
• func PossibleValuesForVisibility() []string
• func ValidateMaintenanceConfigurationID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type ForResourceGroupListOperationResponse
• type GetOperationResponse
• type ListMaintenanceConfigurationsResult
• type ListOperationResponse
• type MaintenanceConfiguration
• type MaintenanceConfigurationId
  • func NewMaintenanceConfigurationID(subscriptionId string, resourceGroupName string, ...) MaintenanceConfigurationId
  • func ParseMaintenanceConfigurationID(input string) (*MaintenanceConfigurationId, error)
  • func ParseMaintenanceConfigurationIDInsensitively(input string) (*MaintenanceConfigurationId, error)
  • func (id MaintenanceConfigurationId) ID() string
  • func (id MaintenanceConfigurationId) Segments() []resourceids.Segment
  • func (id MaintenanceConfigurationId) String() string
• type MaintenanceConfigurationProperties
• type MaintenanceConfigurationsClient
  • func NewMaintenanceConfigurationsClientWithBaseURI(endpoint string) MaintenanceConfigurationsClient
  • func (c MaintenanceConfigurationsClient) CreateOrUpdate(ctx context.Context, id MaintenanceConfigurationId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c MaintenanceConfigurationsClient) Delete(ctx context.Context, id MaintenanceConfigurationId) (result DeleteOperationResponse, err error)
  • func (c MaintenanceConfigurationsClient) ForResourceGroupList(ctx context.Context, id commonids.ResourceGroupId) (result ForResourceGroupListOperationResponse, err error)
  • func (c MaintenanceConfigurationsClient) Get(ctx context.Context, id MaintenanceConfigurationId) (result GetOperationResponse, err error)
  • func (c MaintenanceConfigurationsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c MaintenanceConfigurationsClient) Update(ctx context.Context, id MaintenanceConfigurationId, ...) (result UpdateOperationResponse, err error)
• type MaintenanceScope
• type MaintenanceWindow
• type UpdateOperationResponse
• type Visibility

Functions

func PossibleValuesForMaintenanceScope

func PossibleValuesForMaintenanceScope() []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
	Model        *MaintenanceConfiguration
}

type DeleteOperationResponse

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

type ForResourceGroupListOperationResponse

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

type GetOperationResponse

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

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 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) 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"`
	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 autorest.Client
	// contains filtered or unexported fields
}

func NewMaintenanceConfigurationsClientWithBaseURI

func NewMaintenanceConfigurationsClientWithBaseURI(endpoint string) MaintenanceConfigurationsClient

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

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

type Visibility

type Visibility string

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