machinepools

README

github.com/hashicorp/go-azure-sdk/resource-manager/redhatopenshift/2023-11-22/machinepools Documentation

The machinepools SDK allows for interaction with the Azure Resource Manager Service redhatopenshift (API Version 2023-11-22).

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/redhatopenshift/2023-11-22/machinepools"

Client Initialization

client := machinepools.NewMachinePoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MachinePoolsClient.CreateOrUpdate

ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")

payload := machinepools.MachinePool{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MachinePoolsClient.Delete

ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: MachinePoolsClient.Get

ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")

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

ctx := context.TODO()
id := machinepools.NewOpenShiftClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue")

// 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: MachinePoolsClient.Update

ctx := context.TODO()
id := machinepools.NewMachinePoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "openShiftClusterValue", "machinePoolValue")

payload := machinepools.MachinePoolUpdate{
	// ...
}


read, err := client.Update(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func ValidateMachinePoolID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateOpenShiftClusterID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse
• type MachinePool
• type MachinePoolId
  • func NewMachinePoolID(subscriptionId string, resourceGroupName string, openShiftClusterName string, ...) MachinePoolId
  • func ParseMachinePoolID(input string) (*MachinePoolId, error)
  • func ParseMachinePoolIDInsensitively(input string) (*MachinePoolId, error)
  • func (id *MachinePoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id MachinePoolId) ID() string
  • func (id MachinePoolId) Segments() []resourceids.Segment
  • func (id MachinePoolId) String() string
• type MachinePoolOperationPredicate
  • func (p MachinePoolOperationPredicate) Matches(input MachinePool) bool
• type MachinePoolProperties
• type MachinePoolUpdate
• type MachinePoolsClient
  • func NewMachinePoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*MachinePoolsClient, error)
  • func (c MachinePoolsClient) CreateOrUpdate(ctx context.Context, id MachinePoolId, input MachinePool) (result CreateOrUpdateOperationResponse, err error)
  • func (c MachinePoolsClient) Delete(ctx context.Context, id MachinePoolId) (result DeleteOperationResponse, err error)
  • func (c MachinePoolsClient) Get(ctx context.Context, id MachinePoolId) (result GetOperationResponse, err error)
  • func (c MachinePoolsClient) List(ctx context.Context, id OpenShiftClusterId) (result ListOperationResponse, err error)
  • func (c MachinePoolsClient) ListComplete(ctx context.Context, id OpenShiftClusterId) (ListCompleteResult, error)
  • func (c MachinePoolsClient) ListCompleteMatchingPredicate(ctx context.Context, id OpenShiftClusterId, ...) (result ListCompleteResult, err error)
  • func (c MachinePoolsClient) Update(ctx context.Context, id MachinePoolId, input MachinePoolUpdate) (result UpdateOperationResponse, err error)
• type OpenShiftClusterId
  • func NewOpenShiftClusterID(subscriptionId string, resourceGroupName string, openShiftClusterName string) OpenShiftClusterId
  • func ParseOpenShiftClusterID(input string) (*OpenShiftClusterId, error)
  • func ParseOpenShiftClusterIDInsensitively(input string) (*OpenShiftClusterId, error)
  • func (id *OpenShiftClusterId) FromParseResult(input resourceids.ParseResult) error
  • func (id OpenShiftClusterId) ID() string
  • func (id OpenShiftClusterId) Segments() []resourceids.Segment
  • func (id OpenShiftClusterId) String() string
• type UpdateOperationResponse

Functions

func ValidateMachinePoolID

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

ValidateMachinePoolID checks that 'input' can be parsed as a Machine Pool ID

func ValidateOpenShiftClusterID

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

ValidateOpenShiftClusterID checks that 'input' can be parsed as a Open Shift Cluster ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MachinePool
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type MachinePool

type MachinePool struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *MachinePoolProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type MachinePoolId

type MachinePoolId struct {
	SubscriptionId       string
	ResourceGroupName    string
	OpenShiftClusterName string
	MachinePoolName      string
}

MachinePoolId is a struct representing the Resource ID for a Machine Pool

func NewMachinePoolID

func NewMachinePoolID(subscriptionId string, resourceGroupName string, openShiftClusterName string, machinePoolName string) MachinePoolId

NewMachinePoolID returns a new MachinePoolId struct

func ParseMachinePoolID

func ParseMachinePoolID(input string) (*MachinePoolId, error)

ParseMachinePoolID parses 'input' into a MachinePoolId

func ParseMachinePoolIDInsensitively

func ParseMachinePoolIDInsensitively(input string) (*MachinePoolId, error)

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

func (*MachinePoolId) FromParseResult

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

func (MachinePoolId) ID

func (id MachinePoolId) ID() string

ID returns the formatted Machine Pool ID

func (MachinePoolId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Machine Pool ID

func (MachinePoolId) String

func (id MachinePoolId) String() string

String returns a human-readable description of this Machine Pool ID

type MachinePoolOperationPredicate

type MachinePoolOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (MachinePoolOperationPredicate) Matches

func (p MachinePoolOperationPredicate) Matches(input MachinePool) bool

type MachinePoolProperties

type MachinePoolProperties struct {
	Resources *string `json:"resources,omitempty"`
}

type MachinePoolUpdate

type MachinePoolUpdate struct {
	Properties *MachinePoolProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
}

type MachinePoolsClient

type MachinePoolsClient struct {
	Client *resourcemanager.Client
}

func NewMachinePoolsClientWithBaseURI

func NewMachinePoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*MachinePoolsClient, error)

func (MachinePoolsClient) CreateOrUpdate

func (c MachinePoolsClient) CreateOrUpdate(ctx context.Context, id MachinePoolId, input MachinePool) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MachinePoolsClient) Delete

func (c MachinePoolsClient) Delete(ctx context.Context, id MachinePoolId) (result DeleteOperationResponse, err error)

Delete ...

func (MachinePoolsClient) Get

func (c MachinePoolsClient) Get(ctx context.Context, id MachinePoolId) (result GetOperationResponse, err error)

Get ...

func (MachinePoolsClient) List

func (c MachinePoolsClient) List(ctx context.Context, id OpenShiftClusterId) (result ListOperationResponse, err error)

List ...

func (MachinePoolsClient) ListComplete

func (c MachinePoolsClient) ListComplete(ctx context.Context, id OpenShiftClusterId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (MachinePoolsClient) ListCompleteMatchingPredicate

func (c MachinePoolsClient) ListCompleteMatchingPredicate(ctx context.Context, id OpenShiftClusterId, predicate MachinePoolOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MachinePoolsClient) Update

func (c MachinePoolsClient) Update(ctx context.Context, id MachinePoolId, input MachinePoolUpdate) (result UpdateOperationResponse, err error)

Update ...

type OpenShiftClusterId

type OpenShiftClusterId struct {
	SubscriptionId       string
	ResourceGroupName    string
	OpenShiftClusterName string
}

OpenShiftClusterId is a struct representing the Resource ID for a Open Shift Cluster

func NewOpenShiftClusterID

func NewOpenShiftClusterID(subscriptionId string, resourceGroupName string, openShiftClusterName string) OpenShiftClusterId

NewOpenShiftClusterID returns a new OpenShiftClusterId struct

func ParseOpenShiftClusterID

func ParseOpenShiftClusterID(input string) (*OpenShiftClusterId, error)

ParseOpenShiftClusterID parses 'input' into a OpenShiftClusterId

func ParseOpenShiftClusterIDInsensitively

func ParseOpenShiftClusterIDInsensitively(input string) (*OpenShiftClusterId, error)

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

func (*OpenShiftClusterId) FromParseResult

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

func (OpenShiftClusterId) ID

func (id OpenShiftClusterId) ID() string

ID returns the formatted Open Shift Cluster ID

func (OpenShiftClusterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Open Shift Cluster ID

func (OpenShiftClusterId) String

func (id OpenShiftClusterId) String() string

String returns a human-readable description of this Open Shift Cluster ID

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MachinePool
}