fleetmembers

package
v0.20240122.1052955 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerservice/2022-09-02-preview/fleetmembers Documentation

The fleetmembers SDK allows for interaction with the Azure Resource Manager Service containerservice (API Version 2022-09-02-preview).

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/2022-09-02-preview/fleetmembers"

Client Initialization

client := fleetmembers.NewFleetMembersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FleetMembersClient.Create

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

payload := fleetmembers.FleetMember{
	// ...
}


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

Example Usage: FleetMembersClient.Delete

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

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

Example Usage: FleetMembersClient.Get

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

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

ctx := context.TODO()
id := fleetmembers.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 PossibleValuesForFleetMemberProvisioningState

func PossibleValuesForFleetMemberProvisioningState() []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 ValidateMemberID

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

ValidateMemberID checks that 'input' can be parsed as a Member ID

Types

type CreateOperationOptions added in v0.20230518.1152641

type CreateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOperationOptions added in v0.20230518.1152641

func DefaultCreateOperationOptions() CreateOperationOptions

type CreateOperationResponse added in v0.20230518.1152641

type CreateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationOptions

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

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 added in v0.20231127.1171502

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 FleetMember

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

type FleetMemberOperationPredicate

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

func (FleetMemberOperationPredicate) Matches

type FleetMemberProperties

type FleetMemberProperties struct {
	ClusterResourceId string                        `json:"clusterResourceId"`
	ProvisioningState *FleetMemberProvisioningState `json:"provisioningState,omitempty"`
}

type FleetMemberProvisioningState

type FleetMemberProvisioningState string
const (
	FleetMemberProvisioningStateCanceled  FleetMemberProvisioningState = "Canceled"
	FleetMemberProvisioningStateFailed    FleetMemberProvisioningState = "Failed"
	FleetMemberProvisioningStateJoining   FleetMemberProvisioningState = "Joining"
	FleetMemberProvisioningStateLeaving   FleetMemberProvisioningState = "Leaving"
	FleetMemberProvisioningStateSucceeded FleetMemberProvisioningState = "Succeeded"
	FleetMemberProvisioningStateUpdating  FleetMemberProvisioningState = "Updating"
)

type FleetMembersClient

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

func NewFleetMembersClientWithBaseURI

func NewFleetMembersClientWithBaseURI(endpoint string) FleetMembersClient

func (FleetMembersClient) Create added in v0.20230518.1152641

Create ...

func (FleetMembersClient) CreateThenPoll added in v0.20230518.1152641

func (c FleetMembersClient) CreateThenPoll(ctx context.Context, id MemberId, input FleetMember, options CreateOperationOptions) error

CreateThenPoll performs Create then polls until it's completed

func (FleetMembersClient) Delete

Delete ...

func (FleetMembersClient) DeleteThenPoll

func (c FleetMembersClient) DeleteThenPoll(ctx context.Context, id MemberId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (FleetMembersClient) Get

Get ...

func (FleetMembersClient) ListByFleet

func (c FleetMembersClient) ListByFleet(ctx context.Context, id FleetId) (resp ListByFleetOperationResponse, err error)

ListByFleet ...

func (FleetMembersClient) ListByFleetComplete

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

ListByFleetComplete retrieves all of the results into a single object

func (FleetMembersClient) ListByFleetCompleteMatchingPredicate

func (c FleetMembersClient) ListByFleetCompleteMatchingPredicate(ctx context.Context, id FleetId, predicate FleetMemberOperationPredicate) (resp ListByFleetCompleteResult, err error)

ListByFleetCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *FleetMember
}

type ListByFleetCompleteResult

type ListByFleetCompleteResult struct {
	Items []FleetMember
}

type ListByFleetOperationResponse

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

func (ListByFleetOperationResponse) HasMore

func (r ListByFleetOperationResponse) HasMore() bool

func (ListByFleetOperationResponse) LoadMore

type MemberId

type MemberId struct {
	SubscriptionId    string
	ResourceGroupName string
	FleetName         string
	MemberName        string
}

MemberId is a struct representing the Resource ID for a Member

func NewMemberID

func NewMemberID(subscriptionId string, resourceGroupName string, fleetName string, memberName string) MemberId

NewMemberID returns a new MemberId struct

func ParseMemberID

func ParseMemberID(input string) (*MemberId, error)

ParseMemberID parses 'input' into a MemberId

func ParseMemberIDInsensitively

func ParseMemberIDInsensitively(input string) (*MemberId, error)

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

func (*MemberId) FromParseResult added in v0.20231127.1171502

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

func (MemberId) ID

func (id MemberId) ID() string

ID returns the formatted Member ID

func (MemberId) Segments

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

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

func (MemberId) String

func (id MemberId) String() string

String returns a human-readable description of this Member ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL