connectedclusters

package
v0.20240118.1113719 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/hybridkubernetes/2021-10-01/connectedclusters Documentation

The connectedclusters SDK allows for interaction with the Azure Resource Manager Service hybridkubernetes (API Version 2021-10-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/hybridkubernetes/2021-10-01/connectedclusters"

Client Initialization

client := connectedclusters.NewConnectedClustersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectedClustersClient.ConnectedClusterCreate

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

payload := connectedclusters.ConnectedCluster{
	// ...
}


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

Example Usage: ConnectedClustersClient.ConnectedClusterDelete

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

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

Example Usage: ConnectedClustersClient.ConnectedClusterGet

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

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

Example Usage: ConnectedClustersClient.ConnectedClusterListByResourceGroup

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

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

Example Usage: ConnectedClustersClient.ConnectedClusterListBySubscription

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

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

Example Usage: ConnectedClustersClient.ConnectedClusterListClusterUserCredential

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

payload := connectedclusters.ListClusterUserCredentialProperties{
	// ...
}


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

Example Usage: ConnectedClustersClient.ConnectedClusterUpdate

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

payload := connectedclusters.ConnectedClusterPatch{
	// ...
}


read, err := client.ConnectedClusterUpdate(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 PossibleValuesForAuthenticationMethod

func PossibleValuesForAuthenticationMethod() []string

func PossibleValuesForConnectivityStatus

func PossibleValuesForConnectivityStatus() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateConnectedClusterID

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

ValidateConnectedClusterID checks that 'input' can be parsed as a Connected Cluster ID

Types

type AuthenticationMethod

type AuthenticationMethod string
const (
	AuthenticationMethodAAD   AuthenticationMethod = "AAD"
	AuthenticationMethodToken AuthenticationMethod = "Token"
)

func (*AuthenticationMethod) UnmarshalJSON added in v0.20230804.1074947

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

type ConnectedCluster

type ConnectedCluster struct {
	Id         *string                    `json:"id,omitempty"`
	Identity   identity.SystemAssigned    `json:"identity"`
	Location   string                     `json:"location"`
	Name       *string                    `json:"name,omitempty"`
	Properties ConnectedClusterProperties `json:"properties"`
	SystemData *systemdata.SystemData     `json:"systemData,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type ConnectedClusterCreateOperationResponse

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

type ConnectedClusterDeleteOperationResponse

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

type ConnectedClusterGetOperationResponse

type ConnectedClusterGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectedCluster
}

type ConnectedClusterId

type ConnectedClusterId struct {
	SubscriptionId       string
	ResourceGroupName    string
	ConnectedClusterName string
}

ConnectedClusterId is a struct representing the Resource ID for a Connected Cluster

func NewConnectedClusterID

func NewConnectedClusterID(subscriptionId string, resourceGroupName string, connectedClusterName string) ConnectedClusterId

NewConnectedClusterID returns a new ConnectedClusterId struct

func ParseConnectedClusterID

func ParseConnectedClusterID(input string) (*ConnectedClusterId, error)

ParseConnectedClusterID parses 'input' into a ConnectedClusterId

func ParseConnectedClusterIDInsensitively

func ParseConnectedClusterIDInsensitively(input string) (*ConnectedClusterId, error)

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

func (*ConnectedClusterId) FromParseResult added in v0.20231127.1171502

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

func (ConnectedClusterId) ID

func (id ConnectedClusterId) ID() string

ID returns the formatted Connected Cluster ID

func (ConnectedClusterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Connected Cluster ID

func (ConnectedClusterId) String

func (id ConnectedClusterId) String() string

String returns a human-readable description of this Connected Cluster ID

type ConnectedClusterListByResourceGroupCompleteResult

type ConnectedClusterListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ConnectedCluster
}

type ConnectedClusterListByResourceGroupOperationResponse

type ConnectedClusterListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConnectedCluster
}

type ConnectedClusterListBySubscriptionCompleteResult

type ConnectedClusterListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ConnectedCluster
}

type ConnectedClusterListBySubscriptionOperationResponse

type ConnectedClusterListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConnectedCluster
}

type ConnectedClusterListClusterUserCredentialOperationResponse

type ConnectedClusterListClusterUserCredentialOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CredentialResults
}

type ConnectedClusterOperationPredicate

type ConnectedClusterOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ConnectedClusterOperationPredicate) Matches

type ConnectedClusterPatch

type ConnectedClusterPatch struct {
	Properties *interface{}       `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
}

type ConnectedClusterProperties

type ConnectedClusterProperties struct {
	AgentPublicKeyCertificate                string              `json:"agentPublicKeyCertificate"`
	AgentVersion                             *string             `json:"agentVersion,omitempty"`
	ConnectivityStatus                       *ConnectivityStatus `json:"connectivityStatus,omitempty"`
	Distribution                             *string             `json:"distribution,omitempty"`
	Infrastructure                           *string             `json:"infrastructure,omitempty"`
	KubernetesVersion                        *string             `json:"kubernetesVersion,omitempty"`
	LastConnectivityTime                     *string             `json:"lastConnectivityTime,omitempty"`
	ManagedIdentityCertificateExpirationTime *string             `json:"managedIdentityCertificateExpirationTime,omitempty"`
	Offering                                 *string             `json:"offering,omitempty"`
	ProvisioningState                        *ProvisioningState  `json:"provisioningState,omitempty"`
	TotalCoreCount                           *int64              `json:"totalCoreCount,omitempty"`
	TotalNodeCount                           *int64              `json:"totalNodeCount,omitempty"`
}

func (*ConnectedClusterProperties) GetLastConnectivityTimeAsTime

func (o *ConnectedClusterProperties) GetLastConnectivityTimeAsTime() (*time.Time, error)

func (*ConnectedClusterProperties) GetManagedIdentityCertificateExpirationTimeAsTime

func (o *ConnectedClusterProperties) GetManagedIdentityCertificateExpirationTimeAsTime() (*time.Time, error)

func (*ConnectedClusterProperties) SetLastConnectivityTimeAsTime

func (o *ConnectedClusterProperties) SetLastConnectivityTimeAsTime(input time.Time)

func (*ConnectedClusterProperties) SetManagedIdentityCertificateExpirationTimeAsTime

func (o *ConnectedClusterProperties) SetManagedIdentityCertificateExpirationTimeAsTime(input time.Time)

type ConnectedClusterUpdateOperationResponse

type ConnectedClusterUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectedCluster
}

type ConnectedClustersClient

type ConnectedClustersClient struct {
	Client *resourcemanager.Client
}

func NewConnectedClustersClientWithBaseURI

func NewConnectedClustersClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectedClustersClient, error)

func (ConnectedClustersClient) ConnectedClusterCreate

ConnectedClusterCreate ...

func (ConnectedClustersClient) ConnectedClusterCreateThenPoll

func (c ConnectedClustersClient) ConnectedClusterCreateThenPoll(ctx context.Context, id ConnectedClusterId, input ConnectedCluster) error

ConnectedClusterCreateThenPoll performs ConnectedClusterCreate then polls until it's completed

func (ConnectedClustersClient) ConnectedClusterDelete

ConnectedClusterDelete ...

func (ConnectedClustersClient) ConnectedClusterDeleteThenPoll

func (c ConnectedClustersClient) ConnectedClusterDeleteThenPoll(ctx context.Context, id ConnectedClusterId) error

ConnectedClusterDeleteThenPoll performs ConnectedClusterDelete then polls until it's completed

func (ConnectedClustersClient) ConnectedClusterGet

ConnectedClusterGet ...

func (ConnectedClustersClient) ConnectedClusterListByResourceGroup

ConnectedClusterListByResourceGroup ...

func (ConnectedClustersClient) ConnectedClusterListByResourceGroupComplete

ConnectedClusterListByResourceGroupComplete retrieves all the results into a single object

func (ConnectedClustersClient) ConnectedClusterListByResourceGroupCompleteMatchingPredicate

func (c ConnectedClustersClient) ConnectedClusterListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ConnectedClusterOperationPredicate) (result ConnectedClusterListByResourceGroupCompleteResult, err error)

ConnectedClusterListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectedClustersClient) ConnectedClusterListBySubscription

ConnectedClusterListBySubscription ...

func (ConnectedClustersClient) ConnectedClusterListBySubscriptionComplete

ConnectedClusterListBySubscriptionComplete retrieves all the results into a single object

func (ConnectedClustersClient) ConnectedClusterListBySubscriptionCompleteMatchingPredicate

func (c ConnectedClustersClient) ConnectedClusterListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ConnectedClusterOperationPredicate) (result ConnectedClusterListBySubscriptionCompleteResult, err error)

ConnectedClusterListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConnectedClustersClient) ConnectedClusterListClusterUserCredential

ConnectedClusterListClusterUserCredential ...

func (ConnectedClustersClient) ConnectedClusterUpdate

ConnectedClusterUpdate ...

type ConnectivityStatus

type ConnectivityStatus string
const (
	ConnectivityStatusConnected  ConnectivityStatus = "Connected"
	ConnectivityStatusConnecting ConnectivityStatus = "Connecting"
	ConnectivityStatusExpired    ConnectivityStatus = "Expired"
	ConnectivityStatusOffline    ConnectivityStatus = "Offline"
)

func (*ConnectivityStatus) UnmarshalJSON added in v0.20230804.1074947

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

type CredentialResult

type CredentialResult struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type CredentialResults

type CredentialResults struct {
	HybridConnectionConfig *HybridConnectionConfig `json:"hybridConnectionConfig,omitempty"`
	Kubeconfigs            *[]CredentialResult     `json:"kubeconfigs,omitempty"`
}

type HybridConnectionConfig

type HybridConnectionConfig struct {
	ExpirationTime       *int64  `json:"expirationTime,omitempty"`
	HybridConnectionName *string `json:"hybridConnectionName,omitempty"`
	Relay                *string `json:"relay,omitempty"`
	Token                *string `json:"token,omitempty"`
}

type ListClusterUserCredentialProperties

type ListClusterUserCredentialProperties struct {
	AuthenticationMethod AuthenticationMethod `json:"authenticationMethod"`
	ClientProxy          bool                 `json:"clientProxy"`
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230804.1074947

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

Jump to

Keyboard shortcuts

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