kubeenvironments

package
v0.20240320.1000025 Latest Latest
Warning

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

 Go to latest Published: Mar 20, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2022-09-01/kubeenvironments Documentation

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

Client Initialization

client := kubeenvironments.NewKubeEnvironmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: KubeEnvironmentsClient.CreateOrUpdate

ctx := context.TODO()
id := kubeenvironments.NewKubeEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "kubeEnvironmentValue")

payload := kubeenvironments.KubeEnvironment{
	// ...
}


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

Example Usage: KubeEnvironmentsClient.Delete

ctx := context.TODO()
id := kubeenvironments.NewKubeEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "kubeEnvironmentValue")

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

Example Usage: KubeEnvironmentsClient.Get

ctx := context.TODO()
id := kubeenvironments.NewKubeEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "kubeEnvironmentValue")

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: KubeEnvironmentsClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: KubeEnvironmentsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: KubeEnvironmentsClient.Update

ctx := context.TODO()
id := kubeenvironments.NewKubeEnvironmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "kubeEnvironmentValue")

payload := kubeenvironments.KubeEnvironmentPatchResource{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForFrontEndServiceType 

func PossibleValuesForFrontEndServiceType() []string

func PossibleValuesForKubeEnvironmentProvisioningState 

func PossibleValuesForKubeEnvironmentProvisioningState() []string

func PossibleValuesForStorageType 

func PossibleValuesForStorageType() []string

func ValidateKubeEnvironmentID 

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

ValidateKubeEnvironmentID checks that 'input' can be parsed as a Kube Environment ID

Types

type AppLogsConfiguration 

type AppLogsConfiguration struct {
	Destination               *string                    `json:"destination,omitempty"`
	LogAnalyticsConfiguration *LogAnalyticsConfiguration `json:"logAnalyticsConfiguration,omitempty"`
}

type ArcConfiguration 

type ArcConfiguration struct {
	ArtifactStorageAccessMode    *string                `json:"artifactStorageAccessMode,omitempty"`
	ArtifactStorageClassName     *string                `json:"artifactStorageClassName,omitempty"`
	ArtifactStorageMountPath     *string                `json:"artifactStorageMountPath,omitempty"`
	ArtifactStorageNodeName      *string                `json:"artifactStorageNodeName,omitempty"`
	ArtifactsStorageType         *StorageType           `json:"artifactsStorageType,omitempty"`
	FrontEndServiceConfiguration *FrontEndConfiguration `json:"frontEndServiceConfiguration,omitempty"`
	KubeConfig                   *string                `json:"kubeConfig,omitempty"`
}

type ContainerAppsConfiguration 

type ContainerAppsConfiguration struct {
	AppSubnetResourceId          *string `json:"appSubnetResourceId,omitempty"`
	ControlPlaneSubnetResourceId *string `json:"controlPlaneSubnetResourceId,omitempty"`
	DaprAIInstrumentationKey     *string `json:"daprAIInstrumentationKey,omitempty"`
	DockerBridgeCidr             *string `json:"dockerBridgeCidr,omitempty"`
	PlatformReservedCidr         *string `json:"platformReservedCidr,omitempty"`
	PlatformReservedDnsIP        *string `json:"platformReservedDnsIP,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type ExtendedLocation 

type ExtendedLocation struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type FrontEndConfiguration 

type FrontEndConfiguration struct {
	Kind *FrontEndServiceType `json:"kind,omitempty"`
}

type FrontEndServiceType 

type FrontEndServiceType string
const (
	FrontEndServiceTypeLoadBalancer FrontEndServiceType = "LoadBalancer"
	FrontEndServiceTypeNodePort     FrontEndServiceType = "NodePort"
)

func (*FrontEndServiceType) UnmarshalJSON 

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

type GetOperationResponse 

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

type KubeEnvironment 

type KubeEnvironment struct {
	ExtendedLocation *ExtendedLocation          `json:"extendedLocation,omitempty"`
	Id               *string                    `json:"id,omitempty"`
	Kind             *string                    `json:"kind,omitempty"`
	Location         string                     `json:"location"`
	Name             *string                    `json:"name,omitempty"`
	Properties       *KubeEnvironmentProperties `json:"properties,omitempty"`
	Tags             *map[string]string         `json:"tags,omitempty"`
	Type             *string                    `json:"type,omitempty"`
}

type KubeEnvironmentId 

type KubeEnvironmentId struct {
	SubscriptionId      string
	ResourceGroupName   string
	KubeEnvironmentName string
}

KubeEnvironmentId is a struct representing the Resource ID for a Kube Environment

func NewKubeEnvironmentID 

func NewKubeEnvironmentID(subscriptionId string, resourceGroupName string, kubeEnvironmentName string) KubeEnvironmentId

NewKubeEnvironmentID returns a new KubeEnvironmentId struct

func ParseKubeEnvironmentID 

func ParseKubeEnvironmentID(input string) (*KubeEnvironmentId, error)

ParseKubeEnvironmentID parses 'input' into a KubeEnvironmentId

func ParseKubeEnvironmentIDInsensitively 

func ParseKubeEnvironmentIDInsensitively(input string) (*KubeEnvironmentId, error)

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

func (*KubeEnvironmentId) FromParseResult 

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

func (KubeEnvironmentId) ID 

func (id KubeEnvironmentId) ID() string

ID returns the formatted Kube Environment ID

func (KubeEnvironmentId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Kube Environment ID

func (KubeEnvironmentId) String 

func (id KubeEnvironmentId) String() string

String returns a human-readable description of this Kube Environment ID

type KubeEnvironmentOperationPredicate 

type KubeEnvironmentOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (KubeEnvironmentOperationPredicate) Matches 

func (p KubeEnvironmentOperationPredicate) Matches(input KubeEnvironment) bool

type KubeEnvironmentPatchResource 

type KubeEnvironmentPatchResource struct {
	Id         *string                                 `json:"id,omitempty"`
	Kind       *string                                 `json:"kind,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *KubeEnvironmentPatchResourceProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type KubeEnvironmentPatchResourceProperties 

type KubeEnvironmentPatchResourceProperties struct {
	AksResourceID               *string                           `json:"aksResourceID,omitempty"`
	AppLogsConfiguration        *AppLogsConfiguration             `json:"appLogsConfiguration,omitempty"`
	ArcConfiguration            *ArcConfiguration                 `json:"arcConfiguration,omitempty"`
	ContainerAppsConfiguration  *ContainerAppsConfiguration       `json:"containerAppsConfiguration,omitempty"`
	DefaultDomain               *string                           `json:"defaultDomain,omitempty"`
	DeploymentErrors            *string                           `json:"deploymentErrors,omitempty"`
	InternalLoadBalancerEnabled *bool                             `json:"internalLoadBalancerEnabled,omitempty"`
	ProvisioningState           *KubeEnvironmentProvisioningState `json:"provisioningState,omitempty"`
	StaticIP                    *string                           `json:"staticIp,omitempty"`
}

type KubeEnvironmentProperties 

type KubeEnvironmentProperties struct {
	AksResourceID               *string                           `json:"aksResourceID,omitempty"`
	AppLogsConfiguration        *AppLogsConfiguration             `json:"appLogsConfiguration,omitempty"`
	ArcConfiguration            *ArcConfiguration                 `json:"arcConfiguration,omitempty"`
	ContainerAppsConfiguration  *ContainerAppsConfiguration       `json:"containerAppsConfiguration,omitempty"`
	DefaultDomain               *string                           `json:"defaultDomain,omitempty"`
	DeploymentErrors            *string                           `json:"deploymentErrors,omitempty"`
	EnvironmentType             *string                           `json:"environmentType,omitempty"`
	InternalLoadBalancerEnabled *bool                             `json:"internalLoadBalancerEnabled,omitempty"`
	ProvisioningState           *KubeEnvironmentProvisioningState `json:"provisioningState,omitempty"`
	StaticIP                    *string                           `json:"staticIp,omitempty"`
}

type KubeEnvironmentProvisioningState 

type KubeEnvironmentProvisioningState string
const (
	KubeEnvironmentProvisioningStateCanceled                      KubeEnvironmentProvisioningState = "Canceled"
	KubeEnvironmentProvisioningStateFailed                        KubeEnvironmentProvisioningState = "Failed"
	KubeEnvironmentProvisioningStateInfrastructureSetupComplete   KubeEnvironmentProvisioningState = "InfrastructureSetupComplete"
	KubeEnvironmentProvisioningStateInfrastructureSetupInProgress KubeEnvironmentProvisioningState = "InfrastructureSetupInProgress"
	KubeEnvironmentProvisioningStateInitializationInProgress      KubeEnvironmentProvisioningState = "InitializationInProgress"
	KubeEnvironmentProvisioningStateScheduledForDelete            KubeEnvironmentProvisioningState = "ScheduledForDelete"
	KubeEnvironmentProvisioningStateSucceeded                     KubeEnvironmentProvisioningState = "Succeeded"
	KubeEnvironmentProvisioningStateUpgradeFailed                 KubeEnvironmentProvisioningState = "UpgradeFailed"
	KubeEnvironmentProvisioningStateUpgradeRequested              KubeEnvironmentProvisioningState = "UpgradeRequested"
	KubeEnvironmentProvisioningStateWaiting                       KubeEnvironmentProvisioningState = "Waiting"
)

func (*KubeEnvironmentProvisioningState) UnmarshalJSON 

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

type KubeEnvironmentsClient 

type KubeEnvironmentsClient struct {
	Client *resourcemanager.Client
}

func NewKubeEnvironmentsClientWithBaseURI 

func NewKubeEnvironmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*KubeEnvironmentsClient, error)

func (KubeEnvironmentsClient) CreateOrUpdate 

func (c KubeEnvironmentsClient) CreateOrUpdate(ctx context.Context, id KubeEnvironmentId, input KubeEnvironment) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (KubeEnvironmentsClient) CreateOrUpdateThenPoll 

func (c KubeEnvironmentsClient) CreateOrUpdateThenPoll(ctx context.Context, id KubeEnvironmentId, input KubeEnvironment) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (KubeEnvironmentsClient) Delete 

func (c KubeEnvironmentsClient) Delete(ctx context.Context, id KubeEnvironmentId) (result DeleteOperationResponse, err error)

Delete ...

func (KubeEnvironmentsClient) DeleteThenPoll 

func (c KubeEnvironmentsClient) DeleteThenPoll(ctx context.Context, id KubeEnvironmentId) error

DeleteThenPoll performs Delete then polls until it's completed

func (KubeEnvironmentsClient) Get 

func (c KubeEnvironmentsClient) Get(ctx context.Context, id KubeEnvironmentId) (result GetOperationResponse, err error)

Get ...

func (KubeEnvironmentsClient) ListByResourceGroup 

func (c KubeEnvironmentsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (KubeEnvironmentsClient) ListByResourceGroupComplete 

func (c KubeEnvironmentsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (KubeEnvironmentsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c KubeEnvironmentsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate KubeEnvironmentOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (KubeEnvironmentsClient) ListBySubscription 

func (c KubeEnvironmentsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (KubeEnvironmentsClient) ListBySubscriptionComplete 

func (c KubeEnvironmentsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (KubeEnvironmentsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c KubeEnvironmentsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate KubeEnvironmentOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (KubeEnvironmentsClient) Update 

func (c KubeEnvironmentsClient) Update(ctx context.Context, id KubeEnvironmentId, input KubeEnvironmentPatchResource) (result UpdateOperationResponse, err error)

Update ...

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []KubeEnvironment
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]KubeEnvironment
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []KubeEnvironment
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]KubeEnvironment
}

type LogAnalyticsConfiguration 

type LogAnalyticsConfiguration struct {
	CustomerId *string `json:"customerId,omitempty"`
	SharedKey  *string `json:"sharedKey,omitempty"`
}

type StorageType 

type StorageType string
const (
	StorageTypeLocalNode         StorageType = "LocalNode"
	StorageTypeNetworkFileSystem StorageType = "NetworkFileSystem"
)

func (*StorageType) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *KubeEnvironment
}

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.