fleetupdatestrategies

package
v0.20240731.1212841 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerservice/2023-10-15/fleetupdatestrategies Documentation

The fleetupdatestrategies SDK allows for interaction with the Azure Resource Manager Service containerservice (API Version 2023-10-15).

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/containerservice/2023-10-15/fleetupdatestrategies"

Client Initialization

client := fleetupdatestrategies.NewFleetUpdateStrategiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FleetUpdateStrategiesClient.CreateOrUpdate

ctx := context.TODO()
id := fleetupdatestrategies.NewUpdateStrategyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fleetValue", "updateStrategyValue")

payload := fleetupdatestrategies.FleetUpdateStrategy{
	// ...
}


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

Example Usage: FleetUpdateStrategiesClient.Delete

ctx := context.TODO()
id := fleetupdatestrategies.NewUpdateStrategyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fleetValue", "updateStrategyValue")

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

Example Usage: FleetUpdateStrategiesClient.Get

ctx := context.TODO()
id := fleetupdatestrategies.NewUpdateStrategyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fleetValue", "updateStrategyValue")

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: FleetUpdateStrategiesClient.ListByFleet

ctx := context.TODO()
id := fleetupdatestrategies.NewFleetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fleetValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForFleetUpdateStrategyProvisioningState 

func PossibleValuesForFleetUpdateStrategyProvisioningState() []string

func ValidateFleetID 

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

ValidateFleetID checks that 'input' can be parsed as a Fleet ID

func ValidateUpdateStrategyID 

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

ValidateUpdateStrategyID checks that 'input' can be parsed as a Update Strategy ID

Types

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20240213.1120950 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData added in v0.20240213.1120950 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20240213.1120950 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FleetUpdateStrategy
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders added in v0.20240213.1120950 

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData added in v0.20240213.1120950 

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery added in v0.20240213.1120950 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type FleetId 

type FleetId struct {
	SubscriptionId    string
	ResourceGroupName string
	FleetName         string
}

FleetId is a struct representing the Resource ID for a Fleet

func NewFleetID 

func NewFleetID(subscriptionId string, resourceGroupName string, fleetName string) FleetId

NewFleetID returns a new FleetId struct

func ParseFleetID 

func ParseFleetID(input string) (*FleetId, error)

ParseFleetID parses 'input' into a FleetId

func ParseFleetIDInsensitively 

func ParseFleetIDInsensitively(input string) (*FleetId, error)

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

func (*FleetId) FromParseResult 

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

func (FleetId) ID 

func (id FleetId) ID() string

ID returns the formatted Fleet ID

func (FleetId) Segments 

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

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

func (FleetId) String 

func (id FleetId) String() string

String returns a human-readable description of this Fleet ID

type FleetUpdateStrategiesClient 

type FleetUpdateStrategiesClient struct {
	Client *resourcemanager.Client
}

func NewFleetUpdateStrategiesClientWithBaseURI 

func NewFleetUpdateStrategiesClientWithBaseURI(sdkApi sdkEnv.Api) (*FleetUpdateStrategiesClient, error)

func (FleetUpdateStrategiesClient) CreateOrUpdate 

func (c FleetUpdateStrategiesClient) CreateOrUpdate(ctx context.Context, id UpdateStrategyId, input FleetUpdateStrategy, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (FleetUpdateStrategiesClient) CreateOrUpdateThenPoll 

func (c FleetUpdateStrategiesClient) CreateOrUpdateThenPoll(ctx context.Context, id UpdateStrategyId, input FleetUpdateStrategy, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (FleetUpdateStrategiesClient) Delete 

func (c FleetUpdateStrategiesClient) Delete(ctx context.Context, id UpdateStrategyId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (FleetUpdateStrategiesClient) DeleteThenPoll 

func (c FleetUpdateStrategiesClient) DeleteThenPoll(ctx context.Context, id UpdateStrategyId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (FleetUpdateStrategiesClient) Get 

func (c FleetUpdateStrategiesClient) Get(ctx context.Context, id UpdateStrategyId) (result GetOperationResponse, err error)

Get ...

func (FleetUpdateStrategiesClient) ListByFleet 

func (c FleetUpdateStrategiesClient) ListByFleet(ctx context.Context, id FleetId) (result ListByFleetOperationResponse, err error)

ListByFleet ...

func (FleetUpdateStrategiesClient) ListByFleetComplete 

func (c FleetUpdateStrategiesClient) ListByFleetComplete(ctx context.Context, id FleetId) (ListByFleetCompleteResult, error)

ListByFleetComplete retrieves all the results into a single object

func (FleetUpdateStrategiesClient) ListByFleetCompleteMatchingPredicate 

func (c FleetUpdateStrategiesClient) ListByFleetCompleteMatchingPredicate(ctx context.Context, id FleetId, predicate FleetUpdateStrategyOperationPredicate) (result ListByFleetCompleteResult, err error)

ListByFleetCompleteMatchingPredicate retrieves all the results and then applies the predicate

type FleetUpdateStrategy 

type FleetUpdateStrategy struct {
	ETag       *string                        `json:"eTag,omitempty"`
	Id         *string                        `json:"id,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *FleetUpdateStrategyProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData         `json:"systemData,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type FleetUpdateStrategyOperationPredicate 

type FleetUpdateStrategyOperationPredicate struct {
	ETag *string
	Id   *string
	Name *string
	Type *string
}

func (FleetUpdateStrategyOperationPredicate) Matches 

func (p FleetUpdateStrategyOperationPredicate) Matches(input FleetUpdateStrategy) bool

type FleetUpdateStrategyProperties 

type FleetUpdateStrategyProperties struct {
	ProvisioningState *FleetUpdateStrategyProvisioningState `json:"provisioningState,omitempty"`
	Strategy          UpdateRunStrategy                     `json:"strategy"`
}

type FleetUpdateStrategyProvisioningState 

type FleetUpdateStrategyProvisioningState string
const (
	FleetUpdateStrategyProvisioningStateCanceled  FleetUpdateStrategyProvisioningState = "Canceled"
	FleetUpdateStrategyProvisioningStateFailed    FleetUpdateStrategyProvisioningState = "Failed"
	FleetUpdateStrategyProvisioningStateSucceeded FleetUpdateStrategyProvisioningState = "Succeeded"
)

func (*FleetUpdateStrategyProvisioningState) UnmarshalJSON added in v0.20240213.1120950 

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

type GetOperationResponse 

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

type ListByFleetCompleteResult 

type ListByFleetCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []FleetUpdateStrategy
}

type ListByFleetCustomPager added in v0.20240628.1153531 

type ListByFleetCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByFleetCustomPager) NextPageLink() *odata.Link

type ListByFleetOperationResponse 

type ListByFleetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FleetUpdateStrategy
}

type UpdateGroup 

type UpdateGroup struct {
	Name string `json:"name"`
}

type UpdateRunStrategy 

type UpdateRunStrategy struct {
	Stages []UpdateStage `json:"stages"`
}

type UpdateStage 

type UpdateStage struct {
	AfterStageWaitInSeconds *int64         `json:"afterStageWaitInSeconds,omitempty"`
	Groups                  *[]UpdateGroup `json:"groups,omitempty"`
	Name                    string         `json:"name"`
}

type UpdateStrategyId 

type UpdateStrategyId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FleetName          string
	UpdateStrategyName string
}

UpdateStrategyId is a struct representing the Resource ID for a Update Strategy

func NewUpdateStrategyID 

func NewUpdateStrategyID(subscriptionId string, resourceGroupName string, fleetName string, updateStrategyName string) UpdateStrategyId

NewUpdateStrategyID returns a new UpdateStrategyId struct

func ParseUpdateStrategyID 

func ParseUpdateStrategyID(input string) (*UpdateStrategyId, error)

ParseUpdateStrategyID parses 'input' into a UpdateStrategyId

func ParseUpdateStrategyIDInsensitively 

func ParseUpdateStrategyIDInsensitively(input string) (*UpdateStrategyId, error)

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

func (*UpdateStrategyId) FromParseResult 

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

func (UpdateStrategyId) ID 

func (id UpdateStrategyId) ID() string

ID returns the formatted Update Strategy ID

func (UpdateStrategyId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Update Strategy ID

func (UpdateStrategyId) String 

func (id UpdateStrategyId) String() string

String returns a human-readable description of this Update Strategy ID

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.