clusterextensions

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

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

The clusterextensions SDK allows for interaction with Azure Resource Manager 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/kubernetesconfiguration/2023-05-01/clusterextensions"

Client Initialization

client := clusterextensions.NewClusterExtensionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClusterExtensionsClient.ExtensionsCreate

ctx := context.TODO()
id := clusterextensions.NewScopedExtensionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "extensionName")

payload := clusterextensions.Extension{
	// ...
}


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

Example Usage: ClusterExtensionsClient.ExtensionsDelete

ctx := context.TODO()
id := clusterextensions.NewScopedExtensionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "extensionName")

if err := client.ExtensionsDeleteThenPoll(ctx, id, clusterextensions.DefaultExtensionsDeleteOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ClusterExtensionsClient.ExtensionsGet

ctx := context.TODO()
id := clusterextensions.NewScopedExtensionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "extensionName")

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

Example Usage: ClusterExtensionsClient.ExtensionsList

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: ClusterExtensionsClient.ExtensionsUpdate

ctx := context.TODO()
id := clusterextensions.NewScopedExtensionID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "extensionName")

payload := clusterextensions.PatchExtension{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAKSIdentityType 

func PossibleValuesForAKSIdentityType() []string

func PossibleValuesForLevelType 

func PossibleValuesForLevelType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateScopedExtensionID 

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

ValidateScopedExtensionID checks that 'input' can be parsed as a Scoped Extension ID

Types

type AKSIdentityType 

type AKSIdentityType string
const (
	AKSIdentityTypeSystemAssigned AKSIdentityType = "SystemAssigned"
	AKSIdentityTypeUserAssigned   AKSIdentityType = "UserAssigned"
)

func (*AKSIdentityType) UnmarshalJSON 

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

type ClusterExtensionsClient 

type ClusterExtensionsClient struct {
	Client *resourcemanager.Client
}

func NewClusterExtensionsClientWithBaseURI 

func NewClusterExtensionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterExtensionsClient, error)

func (ClusterExtensionsClient) ExtensionsCreate 

func (c ClusterExtensionsClient) ExtensionsCreate(ctx context.Context, id ScopedExtensionId, input Extension) (result ExtensionsCreateOperationResponse, err error)

ExtensionsCreate ...

func (ClusterExtensionsClient) ExtensionsCreateThenPoll 

func (c ClusterExtensionsClient) ExtensionsCreateThenPoll(ctx context.Context, id ScopedExtensionId, input Extension) error

ExtensionsCreateThenPoll performs ExtensionsCreate then polls until it's completed

func (ClusterExtensionsClient) ExtensionsDelete 

func (c ClusterExtensionsClient) ExtensionsDelete(ctx context.Context, id ScopedExtensionId, options ExtensionsDeleteOperationOptions) (result ExtensionsDeleteOperationResponse, err error)

ExtensionsDelete ...

func (ClusterExtensionsClient) ExtensionsDeleteThenPoll 

func (c ClusterExtensionsClient) ExtensionsDeleteThenPoll(ctx context.Context, id ScopedExtensionId, options ExtensionsDeleteOperationOptions) error

ExtensionsDeleteThenPoll performs ExtensionsDelete then polls until it's completed

func (ClusterExtensionsClient) ExtensionsGet 

func (c ClusterExtensionsClient) ExtensionsGet(ctx context.Context, id ScopedExtensionId) (result ExtensionsGetOperationResponse, err error)

ExtensionsGet ...

func (ClusterExtensionsClient) ExtensionsList 

func (c ClusterExtensionsClient) ExtensionsList(ctx context.Context, id commonids.ScopeId) (result ExtensionsListOperationResponse, err error)

ExtensionsList ...

func (ClusterExtensionsClient) ExtensionsListComplete 

func (c ClusterExtensionsClient) ExtensionsListComplete(ctx context.Context, id commonids.ScopeId) (ExtensionsListCompleteResult, error)

ExtensionsListComplete retrieves all the results into a single object

func (ClusterExtensionsClient) ExtensionsListCompleteMatchingPredicate 

func (c ClusterExtensionsClient) ExtensionsListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate ExtensionOperationPredicate) (result ExtensionsListCompleteResult, err error)

ExtensionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ClusterExtensionsClient) ExtensionsUpdate 

func (c ClusterExtensionsClient) ExtensionsUpdate(ctx context.Context, id ScopedExtensionId, input PatchExtension) (result ExtensionsUpdateOperationResponse, err error)

ExtensionsUpdate ...

func (ClusterExtensionsClient) ExtensionsUpdateThenPoll 

func (c ClusterExtensionsClient) ExtensionsUpdateThenPoll(ctx context.Context, id ScopedExtensionId, input PatchExtension) error

ExtensionsUpdateThenPoll performs ExtensionsUpdate then polls until it's completed

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 Extension 

type Extension struct {
	Id         *string                  `json:"id,omitempty"`
	Identity   *identity.SystemAssigned `json:"identity,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Plan       *Plan                    `json:"plan,omitempty"`
	Properties *ExtensionProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type ExtensionOperationPredicate 

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

func (ExtensionOperationPredicate) Matches 

func (p ExtensionOperationPredicate) Matches(input Extension) bool

type ExtensionProperties 

type ExtensionProperties struct {
	AksAssignedIdentity            *ExtensionPropertiesAksAssignedIdentity `json:"aksAssignedIdentity,omitempty"`
	AutoUpgradeMinorVersion        *bool                                   `json:"autoUpgradeMinorVersion,omitempty"`
	ConfigurationProtectedSettings *map[string]string                      `json:"configurationProtectedSettings,omitempty"`
	ConfigurationSettings          *map[string]string                      `json:"configurationSettings,omitempty"`
	CurrentVersion                 *string                                 `json:"currentVersion,omitempty"`
	CustomLocationSettings         *map[string]string                      `json:"customLocationSettings,omitempty"`
	ErrorInfo                      *ErrorDetail                            `json:"errorInfo,omitempty"`
	ExtensionType                  *string                                 `json:"extensionType,omitempty"`
	IsSystemExtension              *bool                                   `json:"isSystemExtension,omitempty"`
	PackageUri                     *string                                 `json:"packageUri,omitempty"`
	ProvisioningState              *ProvisioningState                      `json:"provisioningState,omitempty"`
	ReleaseTrain                   *string                                 `json:"releaseTrain,omitempty"`
	Scope                          *Scope                                  `json:"scope,omitempty"`
	Statuses                       *[]ExtensionStatus                      `json:"statuses,omitempty"`
	Version                        *string                                 `json:"version,omitempty"`
}

type ExtensionPropertiesAksAssignedIdentity 

type ExtensionPropertiesAksAssignedIdentity struct {
	PrincipalId *string          `json:"principalId,omitempty"`
	TenantId    *string          `json:"tenantId,omitempty"`
	Type        *AKSIdentityType `json:"type,omitempty"`
}

type ExtensionStatus 

type ExtensionStatus struct {
	Code          *string    `json:"code,omitempty"`
	DisplayStatus *string    `json:"displayStatus,omitempty"`
	Level         *LevelType `json:"level,omitempty"`
	Message       *string    `json:"message,omitempty"`
	Time          *string    `json:"time,omitempty"`
}

type ExtensionsCreateOperationResponse 

type ExtensionsCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Extension
}

type ExtensionsDeleteOperationOptions 

type ExtensionsDeleteOperationOptions struct {
	ForceDelete *bool
}

func DefaultExtensionsDeleteOperationOptions 

func DefaultExtensionsDeleteOperationOptions() ExtensionsDeleteOperationOptions

func (ExtensionsDeleteOperationOptions) ToHeaders 

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

func (ExtensionsDeleteOperationOptions) ToOData 

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

func (ExtensionsDeleteOperationOptions) ToQuery 

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

type ExtensionsDeleteOperationResponse 

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

type ExtensionsGetOperationResponse 

type ExtensionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Extension
}

type ExtensionsListCompleteResult 

type ExtensionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Extension
}

type ExtensionsListCustomPager added in v0.20240628.1153531 

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

type ExtensionsListOperationResponse 

type ExtensionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Extension
}

type ExtensionsUpdateOperationResponse 

type ExtensionsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Extension
}

type LevelType 

type LevelType string
const (
	LevelTypeError       LevelType = "Error"
	LevelTypeInformation LevelType = "Information"
	LevelTypeWarning     LevelType = "Warning"
)

func (*LevelType) UnmarshalJSON 

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

type PatchExtension 

type PatchExtension struct {
	Properties *PatchExtensionProperties `json:"properties,omitempty"`
}

type PatchExtensionProperties 

type PatchExtensionProperties struct {
	AutoUpgradeMinorVersion        *bool              `json:"autoUpgradeMinorVersion,omitempty"`
	ConfigurationProtectedSettings *map[string]string `json:"configurationProtectedSettings,omitempty"`
	ConfigurationSettings          *map[string]string `json:"configurationSettings,omitempty"`
	ReleaseTrain                   *string            `json:"releaseTrain,omitempty"`
	Version                        *string            `json:"version,omitempty"`
}

type Plan 

type Plan struct {
	Name          string  `json:"name"`
	Product       string  `json:"product"`
	PromotionCode *string `json:"promotionCode,omitempty"`
	Publisher     string  `json:"publisher"`
	Version       *string `json:"version,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type Scope 

type Scope struct {
	Cluster   *ScopeCluster   `json:"cluster,omitempty"`
	Namespace *ScopeNamespace `json:"namespace,omitempty"`
}

type ScopeCluster 

type ScopeCluster struct {
	ReleaseNamespace *string `json:"releaseNamespace,omitempty"`
}

type ScopeNamespace 

type ScopeNamespace struct {
	TargetNamespace *string `json:"targetNamespace,omitempty"`
}

type ScopedExtensionId 

type ScopedExtensionId struct {
	Scope         string
	ExtensionName string
}

ScopedExtensionId is a struct representing the Resource ID for a Scoped Extension

func NewScopedExtensionID 

func NewScopedExtensionID(scope string, extensionName string) ScopedExtensionId

NewScopedExtensionID returns a new ScopedExtensionId struct

func ParseScopedExtensionID 

func ParseScopedExtensionID(input string) (*ScopedExtensionId, error)

ParseScopedExtensionID parses 'input' into a ScopedExtensionId

func ParseScopedExtensionIDInsensitively 

func ParseScopedExtensionIDInsensitively(input string) (*ScopedExtensionId, error)

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

func (*ScopedExtensionId) FromParseResult 

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

func (ScopedExtensionId) ID 

func (id ScopedExtensionId) ID() string

ID returns the formatted Scoped Extension ID

func (ScopedExtensionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Scoped Extension ID

func (ScopedExtensionId) String 

func (id ScopedExtensionId) String() string

String returns a human-readable description of this Scoped Extension 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.