fluxconfiguration

package
v0.20240527.1094340 Latest Latest
Warning

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

 Go to latest Published: May 27, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/kubernetesconfiguration/2022-11-01/fluxconfiguration Documentation

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

Client Initialization

client := fluxconfiguration.NewFluxConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FluxConfigurationClient.CreateOrUpdate

ctx := context.TODO()
id := fluxconfiguration.NewScopedFluxConfigurationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "fluxConfigurationValue")

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


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

Example Usage: FluxConfigurationClient.Delete

ctx := context.TODO()
id := fluxconfiguration.NewScopedFluxConfigurationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "fluxConfigurationValue")

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

Example Usage: FluxConfigurationClient.Get

ctx := context.TODO()
id := fluxconfiguration.NewScopedFluxConfigurationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "fluxConfigurationValue")

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

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

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

ctx := context.TODO()
id := fluxconfiguration.NewScopedFluxConfigurationID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "fluxConfigurationValue")

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


if err := client.UpdateThenPoll(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 ValidateScopedFluxConfigurationID 

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

ValidateScopedFluxConfigurationID checks that 'input' can be parsed as a Scoped Flux Configuration ID

Types

type AzureBlobDefinition 

type AzureBlobDefinition struct {
	AccountKey            *string                     `json:"accountKey,omitempty"`
	ContainerName         *string                     `json:"containerName,omitempty"`
	LocalAuthRef          *string                     `json:"localAuthRef,omitempty"`
	ManagedIdentity       *ManagedIdentityDefinition  `json:"managedIdentity,omitempty"`
	SasToken              *string                     `json:"sasToken,omitempty"`
	ServicePrincipal      *ServicePrincipalDefinition `json:"servicePrincipal,omitempty"`
	SyncIntervalInSeconds *int64                      `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds      *int64                      `json:"timeoutInSeconds,omitempty"`
	Url                   *string                     `json:"url,omitempty"`
}

type AzureBlobPatchDefinition 

type AzureBlobPatchDefinition struct {
	AccountKey            *string                          `json:"accountKey,omitempty"`
	ContainerName         *string                          `json:"containerName,omitempty"`
	LocalAuthRef          *string                          `json:"localAuthRef,omitempty"`
	ManagedIdentity       *ManagedIdentityPatchDefinition  `json:"managedIdentity,omitempty"`
	SasToken              *string                          `json:"sasToken,omitempty"`
	ServicePrincipal      *ServicePrincipalPatchDefinition `json:"servicePrincipal,omitempty"`
	SyncIntervalInSeconds *int64                           `json:"syncIntervalInSeconds,omitempty"`
	TimeoutInSeconds      *int64                           `json:"timeoutInSeconds,omitempty"`
	Url                   *string                          `json:"url,omitempty"`
}

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 CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FluxConfiguration
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	ForceDelete *bool
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

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

type DeleteOperationResponse 

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

type FluxComplianceState 

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

func (*FluxComplianceState) UnmarshalJSON 

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

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 FluxConfigurationClient 

type FluxConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewFluxConfigurationClientWithBaseURI 

func NewFluxConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*FluxConfigurationClient, error)

func (FluxConfigurationClient) CreateOrUpdate 

func (c FluxConfigurationClient) CreateOrUpdate(ctx context.Context, id ScopedFluxConfigurationId, input FluxConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (FluxConfigurationClient) CreateOrUpdateThenPoll 

func (c FluxConfigurationClient) CreateOrUpdateThenPoll(ctx context.Context, id ScopedFluxConfigurationId, input FluxConfiguration) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (FluxConfigurationClient) Delete 

func (c FluxConfigurationClient) Delete(ctx context.Context, id ScopedFluxConfigurationId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (FluxConfigurationClient) DeleteThenPoll 

func (c FluxConfigurationClient) DeleteThenPoll(ctx context.Context, id ScopedFluxConfigurationId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (FluxConfigurationClient) Get 

func (c FluxConfigurationClient) Get(ctx context.Context, id ScopedFluxConfigurationId) (result GetOperationResponse, err error)

Get ...

func (FluxConfigurationClient) List 

func (c FluxConfigurationClient) List(ctx context.Context, id commonids.ScopeId) (result ListOperationResponse, err error)

List ...

func (FluxConfigurationClient) ListComplete 

func (c FluxConfigurationClient) ListComplete(ctx context.Context, id commonids.ScopeId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (FluxConfigurationClient) ListCompleteMatchingPredicate 

func (c FluxConfigurationClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, predicate FluxConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FluxConfigurationClient) Update 

func (c FluxConfigurationClient) Update(ctx context.Context, id ScopedFluxConfigurationId, input FluxConfigurationPatch) (result UpdateOperationResponse, err error)

Update ...

func (FluxConfigurationClient) UpdateThenPoll 

func (c FluxConfigurationClient) UpdateThenPoll(ctx context.Context, id ScopedFluxConfigurationId, input FluxConfigurationPatch) error

UpdateThenPoll performs Update then polls until it's completed

type FluxConfigurationOperationPredicate 

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

func (FluxConfigurationOperationPredicate) Matches 

func (p FluxConfigurationOperationPredicate) Matches(input FluxConfiguration) bool

type FluxConfigurationPatch 

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

type FluxConfigurationPatchProperties 

type FluxConfigurationPatchProperties struct {
	AzureBlob                      *AzureBlobPatchDefinition                `json:"azureBlob,omitempty"`
	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 {
	AzureBlob                      *AzureBlobDefinition                `json:"azureBlob,omitempty"`
	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 GetOperationResponse 

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

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 ListCompleteResult 

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

type ListOperationResponse 

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

type ManagedIdentityDefinition 

type ManagedIdentityDefinition struct {
	ClientId *string `json:"clientId,omitempty"`
}

type ManagedIdentityPatchDefinition 

type ManagedIdentityPatchDefinition struct {
	ClientId *string `json:"clientId,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 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 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"
)

func (*ScopeType) UnmarshalJSON 

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

type ScopedFluxConfigurationId 

type ScopedFluxConfigurationId struct {
	Scope                 string
	FluxConfigurationName string
}

ScopedFluxConfigurationId is a struct representing the Resource ID for a Scoped Flux Configuration

func NewScopedFluxConfigurationID 

func NewScopedFluxConfigurationID(scope string, fluxConfigurationName string) ScopedFluxConfigurationId

NewScopedFluxConfigurationID returns a new ScopedFluxConfigurationId struct

func ParseScopedFluxConfigurationID 

func ParseScopedFluxConfigurationID(input string) (*ScopedFluxConfigurationId, error)

ParseScopedFluxConfigurationID parses 'input' into a ScopedFluxConfigurationId

func ParseScopedFluxConfigurationIDInsensitively 

func ParseScopedFluxConfigurationIDInsensitively(input string) (*ScopedFluxConfigurationId, error)

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

func (*ScopedFluxConfigurationId) FromParseResult 

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

func (ScopedFluxConfigurationId) ID 

func (id ScopedFluxConfigurationId) ID() string

ID returns the formatted Scoped Flux Configuration ID

func (ScopedFluxConfigurationId) Segments 

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

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

func (ScopedFluxConfigurationId) String 

func (id ScopedFluxConfigurationId) String() string

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

type ServicePrincipalDefinition 

type ServicePrincipalDefinition struct {
	ClientCertificate          *string `json:"clientCertificate,omitempty"`
	ClientCertificatePassword  *string `json:"clientCertificatePassword,omitempty"`
	ClientCertificateSendChain *bool   `json:"clientCertificateSendChain,omitempty"`
	ClientId                   *string `json:"clientId,omitempty"`
	ClientSecret               *string `json:"clientSecret,omitempty"`
	TenantId                   *string `json:"tenantId,omitempty"`
}

type ServicePrincipalPatchDefinition 

type ServicePrincipalPatchDefinition struct {
	ClientCertificate          *string `json:"clientCertificate,omitempty"`
	ClientCertificatePassword  *string `json:"clientCertificatePassword,omitempty"`
	ClientCertificateSendChain *bool   `json:"clientCertificateSendChain,omitempty"`
	ClientId                   *string `json:"clientId,omitempty"`
	ClientSecret               *string `json:"clientSecret,omitempty"`
	TenantId                   *string `json:"tenantId,omitempty"`
}

type SourceKindType 

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

func (*SourceKindType) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FluxConfiguration
}

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.