updatesummaries

package
v0.20230809.1073815 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-03-01/updatesummaries Documentation

The updatesummaries SDK allows for interaction with the Azure Resource Manager Service azurestackhci (API Version 2023-03-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/azurestackhci/2023-03-01/updatesummaries"

Client Initialization

client := updatesummaries.NewUpdateSummariesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UpdateSummariesClient.UpdateSummariesDelete

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

if err := client.UpdateSummariesDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: UpdateSummariesClient.UpdateSummariesGet

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

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

Example Usage: UpdateSummariesClient.UpdateSummariesList

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

// alternatively `client.UpdateSummariesList(ctx, id)` can be used to do batched pagination
items, err := client.UpdateSummariesListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: UpdateSummariesClient.UpdateSummariesPut

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

payload := updatesummaries.UpdateSummaries{
	// ...
}


read, err := client.UpdateSummariesPut(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 PossibleValuesForHealthState 

func PossibleValuesForHealthState() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSeverity 

func PossibleValuesForSeverity() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func PossibleValuesForUpdateSummariesPropertiesState 

func PossibleValuesForUpdateSummariesPropertiesState() []string

func ValidateClusterID 

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

Types

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Cluster ID

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type HealthState 

type HealthState string
const (
	HealthStateError      HealthState = "Error"
	HealthStateFailure    HealthState = "Failure"
	HealthStateInProgress HealthState = "InProgress"
	HealthStateSuccess    HealthState = "Success"
	HealthStateUnknown    HealthState = "Unknown"
	HealthStateWarning    HealthState = "Warning"
)

func (*HealthState) UnmarshalJSON added in v0.20230731.1080956 

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

type PackageVersionInfo 

type PackageVersionInfo struct {
	LastUpdated *string `json:"lastUpdated,omitempty"`
	PackageType *string `json:"packageType,omitempty"`
	Version     *string `json:"version,omitempty"`
}

func (*PackageVersionInfo) GetLastUpdatedAsTime 

func (o *PackageVersionInfo) GetLastUpdatedAsTime() (*time.Time, error)

func (*PackageVersionInfo) SetLastUpdatedAsTime 

func (o *PackageVersionInfo) SetLastUpdatedAsTime(input time.Time)

type PrecheckResult 

type PrecheckResult struct {
	AdditionalData     *string             `json:"additionalData,omitempty"`
	Description        *string             `json:"description,omitempty"`
	HealthCheckSource  *string             `json:"healthCheckSource,omitempty"`
	Name               *string             `json:"name,omitempty"`
	Remediation        *string             `json:"remediation,omitempty"`
	Severity           *Severity           `json:"severity,omitempty"`
	Status             *Status             `json:"status,omitempty"`
	Tags               *PrecheckResultTags `json:"tags,omitempty"`
	TargetResourceID   *string             `json:"targetResourceID,omitempty"`
	TargetResourceName *string             `json:"targetResourceName,omitempty"`
	Timestamp          *string             `json:"timestamp,omitempty"`
	Title              *string             `json:"title,omitempty"`
}

func (*PrecheckResult) GetTimestampAsTime 

func (o *PrecheckResult) GetTimestampAsTime() (*time.Time, error)

func (*PrecheckResult) SetTimestampAsTime 

func (o *PrecheckResult) SetTimestampAsTime(input time.Time)

type PrecheckResultTags 

type PrecheckResultTags struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230731.1080956 

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

type Severity 

type Severity string
const (
	SeverityCritical      Severity = "Critical"
	SeverityHidden        Severity = "Hidden"
	SeverityInformational Severity = "Informational"
	SeverityWarning       Severity = "Warning"
)

func (*Severity) UnmarshalJSON added in v0.20230731.1080956 

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

type Status 

type Status string
const (
	StatusFailed     Status = "Failed"
	StatusInProgress Status = "InProgress"
	StatusSucceeded  Status = "Succeeded"
)

func (*Status) UnmarshalJSON added in v0.20230731.1080956 

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

type UpdateSummaries 

type UpdateSummaries struct {
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *UpdateSummariesProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData     `json:"systemData,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type UpdateSummariesClient 

type UpdateSummariesClient struct {
	Client *resourcemanager.Client
}

func NewUpdateSummariesClientWithBaseURI 

func NewUpdateSummariesClientWithBaseURI(sdkApi sdkEnv.Api) (*UpdateSummariesClient, error)

func (UpdateSummariesClient) UpdateSummariesDelete 

func (c UpdateSummariesClient) UpdateSummariesDelete(ctx context.Context, id ClusterId) (result UpdateSummariesDeleteOperationResponse, err error)

UpdateSummariesDelete ...

func (UpdateSummariesClient) UpdateSummariesDeleteThenPoll 

func (c UpdateSummariesClient) UpdateSummariesDeleteThenPoll(ctx context.Context, id ClusterId) error

UpdateSummariesDeleteThenPoll performs UpdateSummariesDelete then polls until it's completed

func (UpdateSummariesClient) UpdateSummariesGet 

func (c UpdateSummariesClient) UpdateSummariesGet(ctx context.Context, id ClusterId) (result UpdateSummariesGetOperationResponse, err error)

UpdateSummariesGet ...

func (UpdateSummariesClient) UpdateSummariesList 

func (c UpdateSummariesClient) UpdateSummariesList(ctx context.Context, id ClusterId) (result UpdateSummariesListOperationResponse, err error)

UpdateSummariesList ...

func (UpdateSummariesClient) UpdateSummariesListComplete 

func (c UpdateSummariesClient) UpdateSummariesListComplete(ctx context.Context, id ClusterId) (UpdateSummariesListCompleteResult, error)

UpdateSummariesListComplete retrieves all the results into a single object

func (UpdateSummariesClient) UpdateSummariesListCompleteMatchingPredicate 

func (c UpdateSummariesClient) UpdateSummariesListCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate UpdateSummariesOperationPredicate) (result UpdateSummariesListCompleteResult, err error)

UpdateSummariesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (UpdateSummariesClient) UpdateSummariesPut 

func (c UpdateSummariesClient) UpdateSummariesPut(ctx context.Context, id ClusterId, input UpdateSummaries) (result UpdateSummariesPutOperationResponse, err error)

UpdateSummariesPut ...

type UpdateSummariesDeleteOperationResponse 

type UpdateSummariesDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type UpdateSummariesGetOperationResponse 

type UpdateSummariesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UpdateSummaries
}

type UpdateSummariesListCompleteResult 

type UpdateSummariesListCompleteResult struct {
	Items []UpdateSummaries
}

type UpdateSummariesListOperationResponse 

type UpdateSummariesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]UpdateSummaries
}

type UpdateSummariesOperationPredicate 

type UpdateSummariesOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (UpdateSummariesOperationPredicate) Matches 

func (p UpdateSummariesOperationPredicate) Matches(input UpdateSummaries) bool

type UpdateSummariesProperties 

type UpdateSummariesProperties struct {
	CurrentVersion    *string                         `json:"currentVersion,omitempty"`
	HardwareModel     *string                         `json:"hardwareModel,omitempty"`
	HealthCheckDate   *string                         `json:"healthCheckDate,omitempty"`
	HealthCheckResult *[]PrecheckResult               `json:"healthCheckResult,omitempty"`
	HealthState       *HealthState                    `json:"healthState,omitempty"`
	LastChecked       *string                         `json:"lastChecked,omitempty"`
	LastUpdated       *string                         `json:"lastUpdated,omitempty"`
	OemFamily         *string                         `json:"oemFamily,omitempty"`
	PackageVersions   *[]PackageVersionInfo           `json:"packageVersions,omitempty"`
	ProvisioningState *ProvisioningState              `json:"provisioningState,omitempty"`
	State             *UpdateSummariesPropertiesState `json:"state,omitempty"`
}

func (*UpdateSummariesProperties) GetHealthCheckDateAsTime 

func (o *UpdateSummariesProperties) GetHealthCheckDateAsTime() (*time.Time, error)

func (*UpdateSummariesProperties) GetLastCheckedAsTime 

func (o *UpdateSummariesProperties) GetLastCheckedAsTime() (*time.Time, error)

func (*UpdateSummariesProperties) GetLastUpdatedAsTime 

func (o *UpdateSummariesProperties) GetLastUpdatedAsTime() (*time.Time, error)

func (*UpdateSummariesProperties) SetHealthCheckDateAsTime 

func (o *UpdateSummariesProperties) SetHealthCheckDateAsTime(input time.Time)

func (*UpdateSummariesProperties) SetLastCheckedAsTime 

func (o *UpdateSummariesProperties) SetLastCheckedAsTime(input time.Time)

func (*UpdateSummariesProperties) SetLastUpdatedAsTime 

func (o *UpdateSummariesProperties) SetLastUpdatedAsTime(input time.Time)

type UpdateSummariesPropertiesState 

type UpdateSummariesPropertiesState string
const (
	UpdateSummariesPropertiesStateAppliedSuccessfully   UpdateSummariesPropertiesState = "AppliedSuccessfully"
	UpdateSummariesPropertiesStateNeedsAttention        UpdateSummariesPropertiesState = "NeedsAttention"
	UpdateSummariesPropertiesStatePreparationFailed     UpdateSummariesPropertiesState = "PreparationFailed"
	UpdateSummariesPropertiesStatePreparationInProgress UpdateSummariesPropertiesState = "PreparationInProgress"
	UpdateSummariesPropertiesStateUnknown               UpdateSummariesPropertiesState = "Unknown"
	UpdateSummariesPropertiesStateUpdateAvailable       UpdateSummariesPropertiesState = "UpdateAvailable"
	UpdateSummariesPropertiesStateUpdateFailed          UpdateSummariesPropertiesState = "UpdateFailed"
	UpdateSummariesPropertiesStateUpdateInProgress      UpdateSummariesPropertiesState = "UpdateInProgress"
)

func (*UpdateSummariesPropertiesState) UnmarshalJSON added in v0.20230731.1080956 

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

type UpdateSummariesPutOperationResponse 

type UpdateSummariesPutOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UpdateSummaries
}

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.