clusterextensions

package
v0.20230413.1110635 Latest Latest
Warning

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

 Go to latest Published: Apr 13, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README ¶

github.com/hashicorp/go-azure-sdk/resource-manager/kubernetesconfiguration/2022-03-01/clusterextensions Documentation

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

Client Initialization

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

Example Usage: ClusterExtensionsClient.ExtensionsCreate

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

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


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

Example Usage: ClusterExtensionsClient.ExtensionsDelete

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

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

Example Usage: ClusterExtensionsClient.ExtensionsGet

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

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 := clusterextensions.NewProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "clusterResourceValue", "clusterValue")

// 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.NewExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "providerValue", "clusterResourceValue", "clusterValue", "extensionValue")

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 ValidateExtensionID ¶ 

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

ValidateExtensionID checks that 'input' can be parsed as a Extension ID

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 AKSIdentityType ¶ 

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

type ClusterExtensionsClient ¶ 

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

func NewClusterExtensionsClientWithBaseURI ¶ 

func NewClusterExtensionsClientWithBaseURI(endpoint string) ClusterExtensionsClient

func (ClusterExtensionsClient) ExtensionsCreate ¶ 

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

ExtensionsCreate ...

func (ClusterExtensionsClient) ExtensionsCreateThenPoll ¶ 

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

ExtensionsCreateThenPoll performs ExtensionsCreate then polls until it's completed

func (ClusterExtensionsClient) ExtensionsDelete ¶ 

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

ExtensionsDelete ...

func (ClusterExtensionsClient) ExtensionsDeleteThenPoll ¶ 

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

ExtensionsDeleteThenPoll performs ExtensionsDelete then polls until it's completed

func (ClusterExtensionsClient) ExtensionsGet ¶ 

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

ExtensionsGet ...

func (ClusterExtensionsClient) ExtensionsList ¶ 

func (c ClusterExtensionsClient) ExtensionsList(ctx context.Context, id ProviderId) (resp ExtensionsListOperationResponse, err error)

ExtensionsList ...

func (ClusterExtensionsClient) ExtensionsListComplete ¶ 

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

ExtensionsListComplete retrieves all of the results into a single object

func (ClusterExtensionsClient) ExtensionsListCompleteMatchingPredicate ¶ 

func (c ClusterExtensionsClient) ExtensionsListCompleteMatchingPredicate(ctx context.Context, id ProviderId, predicate ExtensionOperationPredicate) (resp ExtensionsListCompleteResult, err error)

ExtensionsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ClusterExtensionsClient) ExtensionsUpdate ¶ 

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

ExtensionsUpdate ...

func (ClusterExtensionsClient) ExtensionsUpdateThenPoll ¶ 

func (c ClusterExtensionsClient) ExtensionsUpdateThenPoll(ctx context.Context, id ExtensionId, 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"`
	Properties *ExtensionProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type ExtensionId ¶ 

type ExtensionId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ProviderName        string
	ClusterResourceName string
	ClusterName         string
	ExtensionName       string
}

ExtensionId is a struct representing the Resource ID for a Extension

func NewExtensionID ¶ 

func NewExtensionID(subscriptionId string, resourceGroupName string, providerName string, clusterResourceName string, clusterName string, extensionName string) ExtensionId

NewExtensionID returns a new ExtensionId struct

func ParseExtensionID ¶ 

func ParseExtensionID(input string) (*ExtensionId, error)

ParseExtensionID parses 'input' into a ExtensionId

func ParseExtensionIDInsensitively ¶ 

func ParseExtensionIDInsensitively(input string) (*ExtensionId, error)

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

func (ExtensionId) ID ¶ 

func (id ExtensionId) ID() string

ID returns the formatted Extension ID

func (ExtensionId) Segments ¶ 

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

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

func (ExtensionId) String ¶ 

func (id ExtensionId) String() string

String returns a human-readable description of this Extension ID

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"`
	CustomLocationSettings         *map[string]string                      `json:"customLocationSettings,omitempty"`
	ErrorInfo                      *ErrorDetail                            `json:"errorInfo,omitempty"`
	ExtensionType                  *string                                 `json:"extensionType,omitempty"`
	InstalledVersion               *string                                 `json:"installedVersion,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       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ExtensionsDeleteOperationOptions ¶ 

type ExtensionsDeleteOperationOptions struct {
	ForceDelete *bool
}

func DefaultExtensionsDeleteOperationOptions ¶ 

func DefaultExtensionsDeleteOperationOptions() ExtensionsDeleteOperationOptions

type ExtensionsDeleteOperationResponse ¶ 

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

type ExtensionsGetOperationResponse ¶ 

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

type ExtensionsListCompleteResult ¶ 

type ExtensionsListCompleteResult struct {
	Items []Extension
}

type ExtensionsListOperationResponse ¶ 

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

func (ExtensionsListOperationResponse) HasMore ¶ 

func (r ExtensionsListOperationResponse) HasMore() bool

func (ExtensionsListOperationResponse) LoadMore ¶ 

func (r ExtensionsListOperationResponse) LoadMore(ctx context.Context) (resp ExtensionsListOperationResponse, err error)

type ExtensionsUpdateOperationResponse ¶ 

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

type LevelType ¶ 

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

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 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

type ProvisioningState ¶ 

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

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"`
}

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.