flux

package
v0.20230127.1024009 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The flux 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/flux"

Client Initialization

client := flux.NewFluxClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FluxClient.ConfigurationsCreateOrUpdate

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

payload := flux.FluxConfiguration{
	// ...
}


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

Example Usage: FluxClient.ConfigurationsDelete

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

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

Example Usage: FluxClient.ConfigurationsGet

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

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

Example Usage: FluxClient.ConfigurationsList

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

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

Example Usage: FluxClient.ConfigurationsUpdate

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

payload := flux.FluxConfigurationPatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForFluxComplianceState

func PossibleValuesForFluxComplianceState() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForScopeType

func PossibleValuesForScopeType() []string

func PossibleValuesForSourceKindType

func PossibleValuesForSourceKindType() []string

func ValidateFluxConfigurationID

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

ValidateFluxConfigurationID checks that 'input' can be parsed as a Flux Configuration 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 BucketDefinition

type BucketDefinition struct {
	AccessKey             *string `json:"accessKey,omitempty"`
	BucketName            *string `json:"bucketName,omitempty"`
	Insecure              *bool   `json:"insecure,omitempty"`
	LocalAuthRef          *string `json:"localAuthRef,omitempty"`
	SyncIntervalInSeconds *int64  `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds      *int64  `json:"timeoutInSeconds,omitempty"`
	Url                   *string `json:"url,omitempty"`
}

type BucketPatchDefinition

type BucketPatchDefinition struct {
	AccessKey             *string `json:"accessKey,omitempty"`
	BucketName            *string `json:"bucketName,omitempty"`
	Insecure              *bool   `json:"insecure,omitempty"`
	LocalAuthRef          *string `json:"localAuthRef,omitempty"`
	SyncIntervalInSeconds *int64  `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds      *int64  `json:"timeoutInSeconds,omitempty"`
	Url                   *string `json:"url,omitempty"`
}

type ConfigurationsCreateOrUpdateOperationResponse

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

type ConfigurationsDeleteOperationOptions

type ConfigurationsDeleteOperationOptions struct {
	ForceDelete *bool
}

func DefaultConfigurationsDeleteOperationOptions

func DefaultConfigurationsDeleteOperationOptions() ConfigurationsDeleteOperationOptions

type ConfigurationsDeleteOperationResponse

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

type ConfigurationsGetOperationResponse

type ConfigurationsGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *FluxConfiguration
}

type ConfigurationsListCompleteResult

type ConfigurationsListCompleteResult struct {
	Items []FluxConfiguration
}

type ConfigurationsListOperationResponse

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

func (ConfigurationsListOperationResponse) HasMore

func (ConfigurationsListOperationResponse) LoadMore

type ConfigurationsUpdateOperationResponse

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

type FluxClient

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

func NewFluxClientWithBaseURI

func NewFluxClientWithBaseURI(endpoint string) FluxClient

func (FluxClient) ConfigurationsCreateOrUpdate

func (c FluxClient) ConfigurationsCreateOrUpdate(ctx context.Context, id FluxConfigurationId, input FluxConfiguration) (result ConfigurationsCreateOrUpdateOperationResponse, err error)

ConfigurationsCreateOrUpdate ...

func (FluxClient) ConfigurationsCreateOrUpdateThenPoll

func (c FluxClient) ConfigurationsCreateOrUpdateThenPoll(ctx context.Context, id FluxConfigurationId, input FluxConfiguration) error

ConfigurationsCreateOrUpdateThenPoll performs ConfigurationsCreateOrUpdate then polls until it's completed

func (FluxClient) ConfigurationsDelete

ConfigurationsDelete ...

func (FluxClient) ConfigurationsDeleteThenPoll

func (c FluxClient) ConfigurationsDeleteThenPoll(ctx context.Context, id FluxConfigurationId, options ConfigurationsDeleteOperationOptions) error

ConfigurationsDeleteThenPoll performs ConfigurationsDelete then polls until it's completed

func (FluxClient) ConfigurationsGet

func (c FluxClient) ConfigurationsGet(ctx context.Context, id FluxConfigurationId) (result ConfigurationsGetOperationResponse, err error)

ConfigurationsGet ...

func (FluxClient) ConfigurationsList

func (c FluxClient) ConfigurationsList(ctx context.Context, id ProviderId) (resp ConfigurationsListOperationResponse, err error)

ConfigurationsList ...

func (FluxClient) ConfigurationsListComplete

func (c FluxClient) ConfigurationsListComplete(ctx context.Context, id ProviderId) (ConfigurationsListCompleteResult, error)

ConfigurationsListComplete retrieves all of the results into a single object

func (FluxClient) ConfigurationsListCompleteMatchingPredicate

func (c FluxClient) ConfigurationsListCompleteMatchingPredicate(ctx context.Context, id ProviderId, predicate FluxConfigurationOperationPredicate) (resp ConfigurationsListCompleteResult, err error)

ConfigurationsListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (FluxClient) ConfigurationsUpdate

ConfigurationsUpdate ...

func (FluxClient) ConfigurationsUpdateThenPoll

func (c FluxClient) ConfigurationsUpdateThenPoll(ctx context.Context, id FluxConfigurationId, input FluxConfigurationPatch) error

ConfigurationsUpdateThenPoll performs ConfigurationsUpdate then polls until it's completed

type FluxComplianceState

type FluxComplianceState string
const (
	FluxComplianceStateCompliant            FluxComplianceState = "Compliant"
	FluxComplianceStateNonNegativeCompliant FluxComplianceState = "Non-Compliant"
	FluxComplianceStatePending              FluxComplianceState = "Pending"
	FluxComplianceStateSuspended            FluxComplianceState = "Suspended"
	FluxComplianceStateUnknown              FluxComplianceState = "Unknown"
)

type FluxConfiguration

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

type FluxConfigurationId

type FluxConfigurationId struct {
	SubscriptionId        string
	ResourceGroupName     string
	ProviderName          string
	ClusterResourceName   string
	ClusterName           string
	FluxConfigurationName string
}

FluxConfigurationId is a struct representing the Resource ID for a Flux Configuration

func NewFluxConfigurationID

func NewFluxConfigurationID(subscriptionId string, resourceGroupName string, providerName string, clusterResourceName string, clusterName string, fluxConfigurationName string) FluxConfigurationId

NewFluxConfigurationID returns a new FluxConfigurationId struct

func ParseFluxConfigurationID

func ParseFluxConfigurationID(input string) (*FluxConfigurationId, error)

ParseFluxConfigurationID parses 'input' into a FluxConfigurationId

func ParseFluxConfigurationIDInsensitively

func ParseFluxConfigurationIDInsensitively(input string) (*FluxConfigurationId, error)

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

func (FluxConfigurationId) ID

func (id FluxConfigurationId) ID() string

ID returns the formatted Flux Configuration ID

func (FluxConfigurationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Flux Configuration ID

func (FluxConfigurationId) String

func (id FluxConfigurationId) String() string

String returns a human-readable description of this Flux Configuration ID

type FluxConfigurationOperationPredicate

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

func (FluxConfigurationOperationPredicate) Matches

type FluxConfigurationPatch

type FluxConfigurationPatch struct {
	Properties *FluxConfigurationPatchProperties `json:"properties,omitempty"`
}

type FluxConfigurationPatchProperties

type FluxConfigurationPatchProperties struct {
	Bucket                         *BucketPatchDefinition                   `json:"bucket,omitempty"`
	ConfigurationProtectedSettings *map[string]string                       `json:"configurationProtectedSettings,omitempty"`
	GitRepository                  *GitRepositoryPatchDefinition            `json:"gitRepository,omitempty"`
	Kustomizations                 *map[string]KustomizationPatchDefinition `json:"kustomizations,omitempty"`
	SourceKind                     *SourceKindType                          `json:"sourceKind,omitempty"`
	Suspend                        *bool                                    `json:"suspend,omitempty"`
}

type FluxConfigurationProperties

type FluxConfigurationProperties struct {
	Bucket                         *BucketDefinition                   `json:"bucket,omitempty"`
	ComplianceState                *FluxComplianceState                `json:"complianceState,omitempty"`
	ConfigurationProtectedSettings *map[string]string                  `json:"configurationProtectedSettings,omitempty"`
	ErrorMessage                   *string                             `json:"errorMessage,omitempty"`
	GitRepository                  *GitRepositoryDefinition            `json:"gitRepository,omitempty"`
	Kustomizations                 *map[string]KustomizationDefinition `json:"kustomizations,omitempty"`
	Namespace                      *string                             `json:"namespace,omitempty"`
	ProvisioningState              *ProvisioningState                  `json:"provisioningState,omitempty"`
	RepositoryPublicKey            *string                             `json:"repositoryPublicKey,omitempty"`
	Scope                          *ScopeType                          `json:"scope,omitempty"`
	SourceKind                     *SourceKindType                     `json:"sourceKind,omitempty"`
	SourceSyncedCommitId           *string                             `json:"sourceSyncedCommitId,omitempty"`
	SourceUpdatedAt                *string                             `json:"sourceUpdatedAt,omitempty"`
	StatusUpdatedAt                *string                             `json:"statusUpdatedAt,omitempty"`
	Statuses                       *[]ObjectStatusDefinition           `json:"statuses,omitempty"`
	Suspend                        *bool                               `json:"suspend,omitempty"`
}

func (*FluxConfigurationProperties) GetSourceUpdatedAtAsTime

func (o *FluxConfigurationProperties) GetSourceUpdatedAtAsTime() (*time.Time, error)

func (*FluxConfigurationProperties) GetStatusUpdatedAtAsTime

func (o *FluxConfigurationProperties) GetStatusUpdatedAtAsTime() (*time.Time, error)

func (*FluxConfigurationProperties) SetSourceUpdatedAtAsTime

func (o *FluxConfigurationProperties) SetSourceUpdatedAtAsTime(input time.Time)

func (*FluxConfigurationProperties) SetStatusUpdatedAtAsTime

func (o *FluxConfigurationProperties) SetStatusUpdatedAtAsTime(input time.Time)

type GitRepositoryDefinition

type GitRepositoryDefinition struct {
	HTTPSCACert           *string                  `json:"httpsCACert,omitempty"`
	HTTPSUser             *string                  `json:"httpsUser,omitempty"`
	LocalAuthRef          *string                  `json:"localAuthRef,omitempty"`
	RepositoryRef         *RepositoryRefDefinition `json:"repositoryRef,omitempty"`
	SshKnownHosts         *string                  `json:"sshKnownHosts,omitempty"`
	SyncIntervalInSeconds *int64                   `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds      *int64                   `json:"timeoutInSeconds,omitempty"`
	Url                   *string                  `json:"url,omitempty"`
}

type GitRepositoryPatchDefinition

type GitRepositoryPatchDefinition struct {
	HTTPSCACert           *string                  `json:"httpsCACert,omitempty"`
	HTTPSUser             *string                  `json:"httpsUser,omitempty"`
	LocalAuthRef          *string                  `json:"localAuthRef,omitempty"`
	RepositoryRef         *RepositoryRefDefinition `json:"repositoryRef,omitempty"`
	SshKnownHosts         *string                  `json:"sshKnownHosts,omitempty"`
	SyncIntervalInSeconds *int64                   `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds      *int64                   `json:"timeoutInSeconds,omitempty"`
	Url                   *string                  `json:"url,omitempty"`
}

type HelmReleasePropertiesDefinition

type HelmReleasePropertiesDefinition struct {
	FailureCount        *int64                     `json:"failureCount,omitempty"`
	HelmChartRef        *ObjectReferenceDefinition `json:"helmChartRef,omitempty"`
	InstallFailureCount *int64                     `json:"installFailureCount,omitempty"`
	LastRevisionApplied *int64                     `json:"lastRevisionApplied,omitempty"`
	UpgradeFailureCount *int64                     `json:"upgradeFailureCount,omitempty"`
}

type KustomizationDefinition

type KustomizationDefinition struct {
	DependsOn              *[]string `json:"dependsOn,omitempty"`
	Force                  *bool     `json:"force,omitempty"`
	Name                   *string   `json:"name,omitempty"`
	Path                   *string   `json:"path,omitempty"`
	Prune                  *bool     `json:"prune,omitempty"`
	RetryIntervalInSeconds *int64    `json:"retryIntervalInSeconds,omitempty"`
	SyncIntervalInSeconds  *int64    `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds       *int64    `json:"timeoutInSeconds,omitempty"`
}

type KustomizationPatchDefinition

type KustomizationPatchDefinition struct {
	DependsOn              *[]string `json:"dependsOn,omitempty"`
	Force                  *bool     `json:"force,omitempty"`
	Path                   *string   `json:"path,omitempty"`
	Prune                  *bool     `json:"prune,omitempty"`
	RetryIntervalInSeconds *int64    `json:"retryIntervalInSeconds,omitempty"`
	SyncIntervalInSeconds  *int64    `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds       *int64    `json:"timeoutInSeconds,omitempty"`
}

type ObjectReferenceDefinition

type ObjectReferenceDefinition struct {
	Name      *string `json:"name,omitempty"`
	Namespace *string `json:"namespace,omitempty"`
}

type ObjectStatusConditionDefinition

type ObjectStatusConditionDefinition struct {
	LastTransitionTime *string `json:"lastTransitionTime,omitempty"`
	Message            *string `json:"message,omitempty"`
	Reason             *string `json:"reason,omitempty"`
	Status             *string `json:"status,omitempty"`
	Type               *string `json:"type,omitempty"`
}

func (*ObjectStatusConditionDefinition) GetLastTransitionTimeAsTime

func (o *ObjectStatusConditionDefinition) GetLastTransitionTimeAsTime() (*time.Time, error)

func (*ObjectStatusConditionDefinition) SetLastTransitionTimeAsTime

func (o *ObjectStatusConditionDefinition) SetLastTransitionTimeAsTime(input time.Time)

type ObjectStatusDefinition

type ObjectStatusDefinition struct {
	AppliedBy             *ObjectReferenceDefinition         `json:"appliedBy,omitempty"`
	ComplianceState       *FluxComplianceState               `json:"complianceState,omitempty"`
	HelmReleaseProperties *HelmReleasePropertiesDefinition   `json:"helmReleaseProperties,omitempty"`
	Kind                  *string                            `json:"kind,omitempty"`
	Name                  *string                            `json:"name,omitempty"`
	Namespace             *string                            `json:"namespace,omitempty"`
	StatusConditions      *[]ObjectStatusConditionDefinition `json:"statusConditions,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 RepositoryRefDefinition

type RepositoryRefDefinition struct {
	Branch *string `json:"branch,omitempty"`
	Commit *string `json:"commit,omitempty"`
	Semver *string `json:"semver,omitempty"`
	Tag    *string `json:"tag,omitempty"`
}

type ScopeType

type ScopeType string
const (
	ScopeTypeCluster   ScopeType = "cluster"
	ScopeTypeNamespace ScopeType = "namespace"
)

type SourceKindType

type SourceKindType string
const (
	SourceKindTypeBucket        SourceKindType = "Bucket"
	SourceKindTypeGitRepository SourceKindType = "GitRepository"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL