README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/containerservice/2023-10-15/fleetmembers
Documentation
The fleetmembers
SDK allows for interaction with Azure Resource Manager 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/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", "fleetName", "memberName")
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", "fleetName", "memberName")
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", "fleetName", "memberName")
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", "fleetName")
// 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
}
Example Usage: FleetMembersClient.Update
ctx := context.TODO()
id := fleetmembers.NewMemberID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fleetName", "memberName")
payload := fleetmembers.FleetMemberUpdate{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload, fleetmembers.DefaultUpdateOperationOptions()); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForFleetMemberProvisioningState() []string
- func ValidateFleetID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateMemberID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOperationOptions
- type CreateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type FleetId
- type FleetMember
- type FleetMemberOperationPredicate
- type FleetMemberProperties
- type FleetMemberProvisioningState
- type FleetMemberUpdate
- type FleetMemberUpdateProperties
- type FleetMembersClient
- func (c FleetMembersClient) Create(ctx context.Context, id MemberId, input FleetMember, ...) (result CreateOperationResponse, err error)
- func (c FleetMembersClient) CreateThenPoll(ctx context.Context, id MemberId, input FleetMember, ...) error
- func (c FleetMembersClient) Delete(ctx context.Context, id MemberId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c FleetMembersClient) DeleteThenPoll(ctx context.Context, id MemberId, options DeleteOperationOptions) error
- func (c FleetMembersClient) Get(ctx context.Context, id MemberId) (result GetOperationResponse, err error)
- func (c FleetMembersClient) ListByFleet(ctx context.Context, id FleetId) (result ListByFleetOperationResponse, err error)
- func (c FleetMembersClient) ListByFleetComplete(ctx context.Context, id FleetId) (ListByFleetCompleteResult, error)
- func (c FleetMembersClient) ListByFleetCompleteMatchingPredicate(ctx context.Context, id FleetId, predicate FleetMemberOperationPredicate) (result ListByFleetCompleteResult, err error)
- func (c FleetMembersClient) Update(ctx context.Context, id MemberId, input FleetMemberUpdate, ...) (result UpdateOperationResponse, err error)
- func (c FleetMembersClient) UpdateThenPoll(ctx context.Context, id MemberId, input FleetMemberUpdate, ...) error
- type GetOperationResponse
- type ListByFleetCompleteResult
- type ListByFleetCustomPager
- type ListByFleetOperationResponse
- type MemberId
- type UpdateOperationOptions
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForFleetMemberProvisioningState ¶
func PossibleValuesForFleetMemberProvisioningState() []string
func ValidateFleetID ¶
ValidateFleetID checks that 'input' can be parsed as a Fleet ID
func ValidateMemberID ¶
ValidateMemberID checks that 'input' can be parsed as a Member ID
Types ¶
type CreateOperationOptions ¶
func DefaultCreateOperationOptions ¶
func DefaultCreateOperationOptions() CreateOperationOptions
func (CreateOperationOptions) ToHeaders ¶ added in v0.20240213.1120950
func (o CreateOperationOptions) ToHeaders() *client.Headers
func (CreateOperationOptions) ToOData ¶ added in v0.20240213.1120950
func (o CreateOperationOptions) ToOData() *odata.Query
func (CreateOperationOptions) ToQuery ¶ added in v0.20240213.1120950
func (o CreateOperationOptions) ToQuery() *client.QueryParams
type CreateOperationResponse ¶
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 FleetId ¶
FleetId is a struct representing the Resource ID for a Fleet
func NewFleetID ¶
NewFleetID returns a new FleetId struct
func ParseFleetID ¶
ParseFleetID parses 'input' into a FleetId
func ParseFleetIDInsensitively ¶
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) Segments ¶
func (id FleetId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise 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 ¶
func (FleetMemberOperationPredicate) Matches ¶
func (p FleetMemberOperationPredicate) Matches(input FleetMember) bool
type FleetMemberProperties ¶
type FleetMemberProperties struct { ClusterResourceId string `json:"clusterResourceId"` Group *string `json:"group,omitempty"` 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" )
func (*FleetMemberProvisioningState) UnmarshalJSON ¶ added in v0.20240213.1120950
func (s *FleetMemberProvisioningState) UnmarshalJSON(bytes []byte) error
type FleetMemberUpdate ¶
type FleetMemberUpdate struct {
Properties *FleetMemberUpdateProperties `json:"properties,omitempty"`
}
type FleetMemberUpdateProperties ¶
type FleetMemberUpdateProperties struct {
Group *string `json:"group,omitempty"`
}
type FleetMembersClient ¶
type FleetMembersClient struct {
Client *resourcemanager.Client
}
func NewFleetMembersClientWithBaseURI ¶
func NewFleetMembersClientWithBaseURI(sdkApi sdkEnv.Api) (*FleetMembersClient, error)
func (FleetMembersClient) Create ¶
func (c FleetMembersClient) Create(ctx context.Context, id MemberId, input FleetMember, options CreateOperationOptions) (result CreateOperationResponse, err error)
Create ...
func (FleetMembersClient) CreateThenPoll ¶
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 ¶
func (c FleetMembersClient) Delete(ctx context.Context, id MemberId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
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 ¶
func (c FleetMembersClient) Get(ctx context.Context, id MemberId) (result GetOperationResponse, err error)
Get ...
func (FleetMembersClient) ListByFleet ¶
func (c FleetMembersClient) ListByFleet(ctx context.Context, id FleetId) (result ListByFleetOperationResponse, err error)
ListByFleet ...
func (FleetMembersClient) ListByFleetComplete ¶
func (c FleetMembersClient) ListByFleetComplete(ctx context.Context, id FleetId) (ListByFleetCompleteResult, error)
ListByFleetComplete retrieves all the results into a single object
func (FleetMembersClient) ListByFleetCompleteMatchingPredicate ¶
func (c FleetMembersClient) ListByFleetCompleteMatchingPredicate(ctx context.Context, id FleetId, predicate FleetMemberOperationPredicate) (result ListByFleetCompleteResult, err error)
ListByFleetCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (FleetMembersClient) Update ¶
func (c FleetMembersClient) Update(ctx context.Context, id MemberId, input FleetMemberUpdate, options UpdateOperationOptions) (result UpdateOperationResponse, err error)
Update ...
func (FleetMembersClient) UpdateThenPoll ¶
func (c FleetMembersClient) UpdateThenPoll(ctx context.Context, id MemberId, input FleetMemberUpdate, options UpdateOperationOptions) error
UpdateThenPoll performs Update then polls until it's completed
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *FleetMember }
type ListByFleetCompleteResult ¶
type ListByFleetCompleteResult struct { LatestHttpResponse *http.Response Items []FleetMember }
type ListByFleetCustomPager ¶ added in v0.20240628.1153531
func (*ListByFleetCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListByFleetCustomPager) NextPageLink() *odata.Link
type ListByFleetOperationResponse ¶
type ListByFleetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]FleetMember }
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 ¶
ParseMemberID parses 'input' into a MemberId
func ParseMemberIDInsensitively ¶
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 ¶
func (id *MemberId) FromParseResult(input resourceids.ParseResult) error
func (MemberId) Segments ¶
func (id MemberId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Member ID
type UpdateOperationOptions ¶
type UpdateOperationOptions struct {
IfMatch *string
}
func DefaultUpdateOperationOptions ¶
func DefaultUpdateOperationOptions() UpdateOperationOptions
func (UpdateOperationOptions) ToHeaders ¶ added in v0.20240213.1120950
func (o UpdateOperationOptions) ToHeaders() *client.Headers
func (UpdateOperationOptions) ToOData ¶ added in v0.20240213.1120950
func (o UpdateOperationOptions) ToOData() *odata.Query
func (UpdateOperationOptions) ToQuery ¶ added in v0.20240213.1120950
func (o UpdateOperationOptions) ToQuery() *client.QueryParams