updatesummaries

package
v0.20240110.1102249 Latest Latest
Warning

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

 Go to latest Published: Jan 10, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

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

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

Client Initialization

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

Example Usage: UpdateSummariesClient.Delete

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

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

Example Usage: UpdateSummariesClient.Get

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

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

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

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

Example Usage: UpdateSummariesClient.Put

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

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


read, err := client.Put(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) FromParseResult added in v0.20231127.1171502 

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

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 DeleteOperationResponse 

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

type GetOperationResponse 

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

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 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []UpdateSummaries
}

type ListOperationResponse 

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

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 

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

type PutOperationResponse 

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

type Severity 

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

func (*Severity) UnmarshalJSON 

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 

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

func (c UpdateSummariesClient) Delete(ctx context.Context, id ClusterId) (result DeleteOperationResponse, err error)

Delete ...

func (UpdateSummariesClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (UpdateSummariesClient) Get 

func (c UpdateSummariesClient) Get(ctx context.Context, id ClusterId) (result GetOperationResponse, err error)

Get ...

func (UpdateSummariesClient) List 

func (c UpdateSummariesClient) List(ctx context.Context, id ClusterId) (result ListOperationResponse, err error)

List ...

func (UpdateSummariesClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (UpdateSummariesClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (UpdateSummariesClient) Put 

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

Put ...

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 

func (s *UpdateSummariesPropertiesState) 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.