updatesummaries

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2022-10-01/updatesummaries Documentation

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

Client Initialization

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

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
}

Documentation

Index

• func PossibleValuesForProvisioningState() []string
• func PossibleValuesForUpdateSummariesPropertiesState() []string
• func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterId
  • func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId
  • func ParseClusterID(input string) (*ClusterId, error)
  • func ParseClusterIDInsensitively(input string) (*ClusterId, error)
  • func (id ClusterId) ID() string
  • func (id ClusterId) Segments() []resourceids.Segment
  • func (id ClusterId) String() string
• type PackageVersionInfo
  • func (o *PackageVersionInfo) GetLastUpdatedAsTime() (*time.Time, error)
  • func (o *PackageVersionInfo) SetLastUpdatedAsTime(input time.Time)
• type ProvisioningState
• type UpdateSummaries
• type UpdateSummariesClient
  • func NewUpdateSummariesClientWithBaseURI(endpoint string) UpdateSummariesClient
  • func (c UpdateSummariesClient) UpdateSummariesGet(ctx context.Context, id ClusterId) (result UpdateSummariesGetOperationResponse, err error)
  • func (c UpdateSummariesClient) UpdateSummariesList(ctx context.Context, id ClusterId) (resp UpdateSummariesListOperationResponse, err error)
  • func (c UpdateSummariesClient) UpdateSummariesListComplete(ctx context.Context, id ClusterId) (UpdateSummariesListCompleteResult, error)
  • func (c UpdateSummariesClient) UpdateSummariesListCompleteMatchingPredicate(ctx context.Context, id ClusterId, predicate UpdateSummariesOperationPredicate) (resp UpdateSummariesListCompleteResult, err error)
• type UpdateSummariesGetOperationResponse
• type UpdateSummariesListCompleteResult
• type UpdateSummariesListOperationResponse
  • func (r UpdateSummariesListOperationResponse) HasMore() bool
  • func (r UpdateSummariesListOperationResponse) LoadMore(ctx context.Context) (resp UpdateSummariesListOperationResponse, err error)
• type UpdateSummariesOperationPredicate
  • func (p UpdateSummariesOperationPredicate) Matches(input UpdateSummaries) bool
• type UpdateSummariesProperties
• type UpdateSummariesPropertiesState

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []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 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 ProvisioningState

type ProvisioningState string

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

type UpdateSummaries

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

type UpdateSummariesClient

type UpdateSummariesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewUpdateSummariesClientWithBaseURI

func NewUpdateSummariesClientWithBaseURI(endpoint string) UpdateSummariesClient

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) (resp UpdateSummariesListOperationResponse, err error)

UpdateSummariesList ...

func (UpdateSummariesClient) UpdateSummariesListComplete

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

UpdateSummariesListComplete retrieves all of the results into a single object

func (UpdateSummariesClient) UpdateSummariesListCompleteMatchingPredicate

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

UpdateSummariesListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type UpdateSummariesGetOperationResponse

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

type UpdateSummariesListCompleteResult

type UpdateSummariesListCompleteResult struct {
	Items []UpdateSummaries
}

type UpdateSummariesListOperationResponse

type UpdateSummariesListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]UpdateSummaries
	// contains filtered or unexported fields
}

func (UpdateSummariesListOperationResponse) HasMore

func (r UpdateSummariesListOperationResponse) HasMore() bool

func (UpdateSummariesListOperationResponse) LoadMore

func (r UpdateSummariesListOperationResponse) LoadMore(ctx context.Context) (resp UpdateSummariesListOperationResponse, err error)

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"`
	OemFamily         *string                         `json:"oemFamily,omitempty"`
	PackageVersions   *[]PackageVersionInfo           `json:"packageVersions,omitempty"`
	ProvisioningState *ProvisioningState              `json:"provisioningState,omitempty"`
	State             *UpdateSummariesPropertiesState `json:"state,omitempty"`
}

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