publicmaintenanceconfigurations

README

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

The publicmaintenanceconfigurations 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/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 PossibleValuesForVisibility() []string
• func ValidatePublicMaintenanceConfigurationID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type ListMaintenanceConfigurationsResult
• type ListOperationResponse
• type MaintenanceConfiguration
• type MaintenanceConfigurationProperties
• type MaintenanceScope
  • func (s *MaintenanceScope) UnmarshalJSON(bytes []byte) error
• 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(api environments.Api) (*PublicMaintenanceConfigurationsClient, error)
  • 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 Visibility
  • func (s *Visibility) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForMaintenanceScope

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

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 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 MaintenanceScope

type MaintenanceScope string

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

func (*MaintenanceScope) UnmarshalJSON

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 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 *resourcemanager.Client
}

func NewPublicMaintenanceConfigurationsClientWithBaseURI

func NewPublicMaintenanceConfigurationsClientWithBaseURI(api environments.Api) (*PublicMaintenanceConfigurationsClient, error)

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 Visibility

type Visibility string

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

func (*Visibility) UnmarshalJSON

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