operationsinacluster

README

github.com/hashicorp/go-azure-sdk/resource-manager/kubernetesconfiguration/2023-05-01/operationsinacluster Documentation

The operationsinacluster SDK allows for interaction with the Azure Resource Manager Service kubernetesconfiguration (API Version 2023-05-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/kubernetesconfiguration/2023-05-01/operationsinacluster"

Client Initialization

client := operationsinacluster.NewOperationsInAClusterClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OperationsInAClusterClient.OperationStatusList

ctx := context.TODO()
id := operationsinacluster.NewProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "clusterResourceValue", "clusterValue")

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

Documentation

Index

• func ValidateProviderID(input interface{}, key string) (warnings []string, errors []error)
• type ErrorAdditionalInfo
• type ErrorDetail
• type OperationStatusListCompleteResult
• type OperationStatusListOperationResponse
• type OperationStatusResult
• type OperationStatusResultOperationPredicate
  • func (p OperationStatusResultOperationPredicate) Matches(input OperationStatusResult) bool
• type OperationsInAClusterClient
  • func NewOperationsInAClusterClientWithBaseURI(api environments.Api) (*OperationsInAClusterClient, error)
  • func (c OperationsInAClusterClient) OperationStatusList(ctx context.Context, id ProviderId) (result OperationStatusListOperationResponse, err error)
  • func (c OperationsInAClusterClient) OperationStatusListComplete(ctx context.Context, id ProviderId) (OperationStatusListCompleteResult, error)
  • func (c OperationsInAClusterClient) OperationStatusListCompleteMatchingPredicate(ctx context.Context, id ProviderId, ...) (result OperationStatusListCompleteResult, err error)
• type ProviderId
  • func NewProviderID(subscriptionId string, resourceGroupName string, providerName string, ...) ProviderId
  • func ParseProviderID(input string) (*ProviderId, error)
  • func ParseProviderIDInsensitively(input string) (*ProviderId, error)
  • func (id ProviderId) ID() string
  • func (id ProviderId) Segments() []resourceids.Segment
  • func (id ProviderId) String() string

Functions

func ValidateProviderID

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

ValidateProviderID checks that 'input' can be parsed as a Provider ID

Types

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type OperationStatusListCompleteResult

type OperationStatusListCompleteResult struct {
	Items []OperationStatusResult
}

type OperationStatusListOperationResponse

type OperationStatusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]OperationStatusResult
}

type OperationStatusResult

type OperationStatusResult struct {
	Error      *ErrorDetail       `json:"error,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *map[string]string `json:"properties,omitempty"`
	Status     string             `json:"status"`
}

type OperationStatusResultOperationPredicate

type OperationStatusResultOperationPredicate struct {
	Id     *string
	Name   *string
	Status *string
}

func (OperationStatusResultOperationPredicate) Matches

func (p OperationStatusResultOperationPredicate) Matches(input OperationStatusResult) bool

type OperationsInAClusterClient

type OperationsInAClusterClient struct {
	Client *resourcemanager.Client
}

func NewOperationsInAClusterClientWithBaseURI

func NewOperationsInAClusterClientWithBaseURI(api environments.Api) (*OperationsInAClusterClient, error)

func (OperationsInAClusterClient) OperationStatusList

func (c OperationsInAClusterClient) OperationStatusList(ctx context.Context, id ProviderId) (result OperationStatusListOperationResponse, err error)

OperationStatusList ...

func (OperationsInAClusterClient) OperationStatusListComplete

func (c OperationsInAClusterClient) OperationStatusListComplete(ctx context.Context, id ProviderId) (OperationStatusListCompleteResult, error)

OperationStatusListComplete retrieves all the results into a single object

func (OperationsInAClusterClient) OperationStatusListCompleteMatchingPredicate

func (c OperationsInAClusterClient) OperationStatusListCompleteMatchingPredicate(ctx context.Context, id ProviderId, predicate OperationStatusResultOperationPredicate) (result OperationStatusListCompleteResult, err error)

OperationStatusListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ProviderId

type ProviderId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ProviderName        string
	ClusterResourceName string
	ClusterName         string
}

ProviderId is a struct representing the Resource ID for a Provider

func NewProviderID

func NewProviderID(subscriptionId string, resourceGroupName string, providerName string, clusterResourceName string, clusterName string) ProviderId

NewProviderID returns a new ProviderId struct

func ParseProviderID

func ParseProviderID(input string) (*ProviderId, error)

ParseProviderID parses 'input' into a ProviderId

func ParseProviderIDInsensitively

func ParseProviderIDInsensitively(input string) (*ProviderId, error)

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

func (ProviderId) ID

func (id ProviderId) ID() string

ID returns the formatted Provider ID

func (ProviderId) Segments

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

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

func (ProviderId) String

func (id ProviderId) String() string

String returns a human-readable description of this Provider ID