sourcecontrolconfiguration

package
v0.20230525.1191903 Latest Latest
Warning

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

 Go to latest Published: May 25, 2023 License: MPL-2.0 Imports: 14 Imported by: 1

README

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

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

Client Initialization

client := sourcecontrolconfiguration.NewSourceControlConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SourceControlConfigurationClient.CreateOrUpdate

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

payload := sourcecontrolconfiguration.SourceControlConfiguration{
	// ...
}


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

Example Usage: SourceControlConfigurationClient.Delete

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

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

Example Usage: SourceControlConfigurationClient.Get

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

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForComplianceStateType 

func PossibleValuesForComplianceStateType() []string

func PossibleValuesForMessageLevelType 

func PossibleValuesForMessageLevelType() []string

func PossibleValuesForOperatorScopeType 

func PossibleValuesForOperatorScopeType() []string

func PossibleValuesForOperatorType 

func PossibleValuesForOperatorType() []string

func PossibleValuesForProvisioningStateType 

func PossibleValuesForProvisioningStateType() []string

func ValidateProviderID 

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

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

func ValidateSourceControlConfigurationID 

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

ValidateSourceControlConfigurationID checks that 'input' can be parsed as a Source Control Configuration ID

Types

type ComplianceStateType 

type ComplianceStateType string
const (
	ComplianceStateTypeCompliant    ComplianceStateType = "Compliant"
	ComplianceStateTypeFailed       ComplianceStateType = "Failed"
	ComplianceStateTypeInstalled    ComplianceStateType = "Installed"
	ComplianceStateTypeNoncompliant ComplianceStateType = "Noncompliant"
	ComplianceStateTypePending      ComplianceStateType = "Pending"
)

func (*ComplianceStateType) UnmarshalJSON 

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

type ComplianceStatus 

type ComplianceStatus struct {
	ComplianceState   *ComplianceStateType `json:"complianceState,omitempty"`
	LastConfigApplied *string              `json:"lastConfigApplied,omitempty"`
	Message           *string              `json:"message,omitempty"`
	MessageLevel      *MessageLevelType    `json:"messageLevel,omitempty"`
}

func (*ComplianceStatus) GetLastConfigAppliedAsTime 

func (o *ComplianceStatus) GetLastConfigAppliedAsTime() (*time.Time, error)

func (*ComplianceStatus) SetLastConfigAppliedAsTime 

func (o *ComplianceStatus) SetLastConfigAppliedAsTime(input time.Time)

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SourceControlConfiguration
}

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type HelmOperatorProperties 

type HelmOperatorProperties struct {
	ChartValues  *string `json:"chartValues,omitempty"`
	ChartVersion *string `json:"chartVersion,omitempty"`
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []SourceControlConfiguration
}

type ListOperationResponse 

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

type MessageLevelType 

type MessageLevelType string
const (
	MessageLevelTypeError       MessageLevelType = "Error"
	MessageLevelTypeInformation MessageLevelType = "Information"
	MessageLevelTypeWarning     MessageLevelType = "Warning"
)

func (*MessageLevelType) UnmarshalJSON 

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

type OperatorScopeType 

type OperatorScopeType string
const (
	OperatorScopeTypeCluster   OperatorScopeType = "cluster"
	OperatorScopeTypeNamespace OperatorScopeType = "namespace"
)

func (*OperatorScopeType) UnmarshalJSON 

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

type OperatorType 

type OperatorType string
const (
	OperatorTypeFlux OperatorType = "Flux"
)

func (*OperatorType) UnmarshalJSON 

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

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 ProvisioningStateType 

type ProvisioningStateType string
const (
	ProvisioningStateTypeAccepted  ProvisioningStateType = "Accepted"
	ProvisioningStateTypeDeleting  ProvisioningStateType = "Deleting"
	ProvisioningStateTypeFailed    ProvisioningStateType = "Failed"
	ProvisioningStateTypeRunning   ProvisioningStateType = "Running"
	ProvisioningStateTypeSucceeded ProvisioningStateType = "Succeeded"
)

func (*ProvisioningStateType) UnmarshalJSON 

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

type SourceControlConfiguration 

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

type SourceControlConfigurationClient 

type SourceControlConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewSourceControlConfigurationClientWithBaseURI 

func NewSourceControlConfigurationClientWithBaseURI(api environments.Api) (*SourceControlConfigurationClient, error)

func (SourceControlConfigurationClient) CreateOrUpdate 

func (c SourceControlConfigurationClient) CreateOrUpdate(ctx context.Context, id SourceControlConfigurationId, input SourceControlConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (SourceControlConfigurationClient) Delete 

func (c SourceControlConfigurationClient) Delete(ctx context.Context, id SourceControlConfigurationId) (result DeleteOperationResponse, err error)

Delete ...

func (SourceControlConfigurationClient) DeleteThenPoll 

func (c SourceControlConfigurationClient) DeleteThenPoll(ctx context.Context, id SourceControlConfigurationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SourceControlConfigurationClient) Get 

func (c SourceControlConfigurationClient) Get(ctx context.Context, id SourceControlConfigurationId) (result GetOperationResponse, err error)

Get ...

func (SourceControlConfigurationClient) List 

func (c SourceControlConfigurationClient) List(ctx context.Context, id ProviderId) (result ListOperationResponse, err error)

List ...

func (SourceControlConfigurationClient) ListComplete 

func (c SourceControlConfigurationClient) ListComplete(ctx context.Context, id ProviderId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SourceControlConfigurationClient) ListCompleteMatchingPredicate 

func (c SourceControlConfigurationClient) ListCompleteMatchingPredicate(ctx context.Context, id ProviderId, predicate SourceControlConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SourceControlConfigurationId 

type SourceControlConfigurationId struct {
	SubscriptionId                 string
	ResourceGroupName              string
	ProviderName                   string
	ClusterResourceName            string
	ClusterName                    string
	SourceControlConfigurationName string
}

SourceControlConfigurationId is a struct representing the Resource ID for a Source Control Configuration

func NewSourceControlConfigurationID 

func NewSourceControlConfigurationID(subscriptionId string, resourceGroupName string, providerName string, clusterResourceName string, clusterName string, sourceControlConfigurationName string) SourceControlConfigurationId

NewSourceControlConfigurationID returns a new SourceControlConfigurationId struct

func ParseSourceControlConfigurationID 

func ParseSourceControlConfigurationID(input string) (*SourceControlConfigurationId, error)

ParseSourceControlConfigurationID parses 'input' into a SourceControlConfigurationId

func ParseSourceControlConfigurationIDInsensitively 

func ParseSourceControlConfigurationIDInsensitively(input string) (*SourceControlConfigurationId, error)

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

func (SourceControlConfigurationId) ID 

func (id SourceControlConfigurationId) ID() string

ID returns the formatted Source Control Configuration ID

func (SourceControlConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Source Control Configuration ID

func (SourceControlConfigurationId) String 

func (id SourceControlConfigurationId) String() string

String returns a human-readable description of this Source Control Configuration ID

type SourceControlConfigurationOperationPredicate 

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

func (SourceControlConfigurationOperationPredicate) Matches 

func (p SourceControlConfigurationOperationPredicate) Matches(input SourceControlConfiguration) bool

type SourceControlConfigurationProperties 

type SourceControlConfigurationProperties struct {
	ComplianceStatus               *ComplianceStatus       `json:"complianceStatus,omitempty"`
	ConfigurationProtectedSettings *map[string]string      `json:"configurationProtectedSettings,omitempty"`
	EnableHelmOperator             *bool                   `json:"enableHelmOperator,omitempty"`
	HelmOperatorProperties         *HelmOperatorProperties `json:"helmOperatorProperties,omitempty"`
	OperatorInstanceName           *string                 `json:"operatorInstanceName,omitempty"`
	OperatorNamespace              *string                 `json:"operatorNamespace,omitempty"`
	OperatorParams                 *string                 `json:"operatorParams,omitempty"`
	OperatorScope                  *OperatorScopeType      `json:"operatorScope,omitempty"`
	OperatorType                   *OperatorType           `json:"operatorType,omitempty"`
	ProvisioningState              *ProvisioningStateType  `json:"provisioningState,omitempty"`
	RepositoryPublicKey            *string                 `json:"repositoryPublicKey,omitempty"`
	RepositoryUrl                  *string                 `json:"repositoryUrl,omitempty"`
	SshKnownHostsContents          *string                 `json:"sshKnownHostsContents,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.