armkubernetesconfiguration

package module
v0.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2022 License: MIT Imports: 15 Imported by: 6

README

Azure Kubernetes Configuration Module for Go

PkgGoDev

The armkubernetesconfiguration module provides operations for working with Azure Kubernetes Configuration.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Kubernetes Configuration module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Kubernetes Configuration. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Kubernetes Configuration modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armkubernetesconfiguration.NewClusterExtensionTypeClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armkubernetesconfiguration.NewClusterExtensionTypeClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Kubernetes Configuration label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BucketDefinition 

type BucketDefinition struct {
	// Plaintext access key used to securely access the S3 bucket
	AccessKey *string `json:"accessKey,omitempty"`

	// The bucket name to sync from the url endpoint for the flux configuration.
	BucketName *string `json:"bucketName,omitempty"`

	// Specify whether to use insecure communication when puling data from the S3 bucket.
	Insecure *bool `json:"insecure,omitempty"`

	// Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided
	// configuration secrets.
	LocalAuthRef *string `json:"localAuthRef,omitempty"`

	// The interval at which to re-reconcile the cluster git repository source with the remote.
	SyncIntervalInSeconds *int64 `json:"syncIntervalInSeconds,omitempty"`

	// The maximum time to attempt to reconcile the cluster git repository source with the remote.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`

	// The URL to sync for the flux configuration S3 bucket.
	URL *string `json:"url,omitempty"`
}

BucketDefinition - Parameters to reconcile to the GitRepository source kind type.

type BucketPatchDefinition 

type BucketPatchDefinition struct {
	// Plaintext access key used to securely access the S3 bucket
	AccessKey *string `json:"accessKey,omitempty"`

	// The bucket name to sync from the url endpoint for the flux configuration.
	BucketName *string `json:"bucketName,omitempty"`

	// Specify whether to use insecure communication when puling data from the S3 bucket.
	Insecure *bool `json:"insecure,omitempty"`

	// Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided
	// configuration secrets.
	LocalAuthRef *string `json:"localAuthRef,omitempty"`

	// The interval at which to re-reconcile the cluster git repository source with the remote.
	SyncIntervalInSeconds *int64 `json:"syncIntervalInSeconds,omitempty"`

	// The maximum time to attempt to reconcile the cluster git repository source with the remote.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`

	// The URL to sync for the flux configuration S3 bucket.
	URL *string `json:"url,omitempty"`
}

BucketPatchDefinition - Parameters to reconcile to the GitRepository source kind type.

type ClusterExtensionTypeClient 

type ClusterExtensionTypeClient struct {
	// contains filtered or unexported fields
}

ClusterExtensionTypeClient contains the methods for the ClusterExtensionType group. Don't use this type directly, use NewClusterExtensionTypeClient() instead.

func NewClusterExtensionTypeClient 

func NewClusterExtensionTypeClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ClusterExtensionTypeClient

NewClusterExtensionTypeClient creates a new instance of ClusterExtensionTypeClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ClusterExtensionTypeClient) Get 

func (client *ClusterExtensionTypeClient) Get(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, extensionTypeName string, options *ClusterExtensionTypeClientGetOptions) (ClusterExtensionTypeClientGetResponse, error)

Get - Get Extension Type details If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. extensionTypeName - Extension type name options - ClusterExtensionTypeClientGetOptions contains the optional parameters for the ClusterExtensionTypeClient.Get method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ClusterExtensionType_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewClusterExtensionTypeClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.ContainerService"),
		armkubernetesconfiguration.Enum1("managedClusters"),
		"<cluster-name>",
		"<extension-type-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ClusterExtensionTypeClientGetResult)
}

Output:

type ClusterExtensionTypeClientGetOptions added in v0.2.0 

type ClusterExtensionTypeClientGetOptions struct {
}

ClusterExtensionTypeClientGetOptions contains the optional parameters for the ClusterExtensionTypeClient.Get method.

type ClusterExtensionTypeClientGetResponse added in v0.2.0 

type ClusterExtensionTypeClientGetResponse struct {
	ClusterExtensionTypeClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClusterExtensionTypeClientGetResponse contains the response from method ClusterExtensionTypeClient.Get.

type ClusterExtensionTypeClientGetResult added in v0.2.0 

type ClusterExtensionTypeClientGetResult struct {
	ExtensionType
}

ClusterExtensionTypeClientGetResult contains the result from method ClusterExtensionTypeClient.Get.

type ClusterExtensionTypesClient 

type ClusterExtensionTypesClient struct {
	// contains filtered or unexported fields
}

ClusterExtensionTypesClient contains the methods for the ClusterExtensionTypes group. Don't use this type directly, use NewClusterExtensionTypesClient() instead.

func NewClusterExtensionTypesClient 

func NewClusterExtensionTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ClusterExtensionTypesClient

NewClusterExtensionTypesClient creates a new instance of ClusterExtensionTypesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ClusterExtensionTypesClient) List 

func (client *ClusterExtensionTypesClient) List(resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, options *ClusterExtensionTypesClientListOptions) *ClusterExtensionTypesClientListPager

List - Get Extension Types If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. options - ClusterExtensionTypesClientListOptions contains the optional parameters for the ClusterExtensionTypesClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ClusterExtensionTypes_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewClusterExtensionTypesClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.ContainerService"),
		armkubernetesconfiguration.Enum1("managedClusters"),
		"<cluster-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ClusterExtensionTypesClientListOptions added in v0.2.0 

type ClusterExtensionTypesClientListOptions struct {
}

ClusterExtensionTypesClientListOptions contains the optional parameters for the ClusterExtensionTypesClient.List method.

type ClusterExtensionTypesClientListPager added in v0.2.0 

type ClusterExtensionTypesClientListPager struct {
	// contains filtered or unexported fields
}

ClusterExtensionTypesClientListPager provides operations for iterating over paged responses.

func (*ClusterExtensionTypesClientListPager) Err added in v0.2.0 

func (p *ClusterExtensionTypesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ClusterExtensionTypesClientListPager) NextPage added in v0.2.0 

func (p *ClusterExtensionTypesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ClusterExtensionTypesClientListPager) PageResponse added in v0.2.0 

func (p *ClusterExtensionTypesClientListPager) PageResponse() ClusterExtensionTypesClientListResponse

PageResponse returns the current ClusterExtensionTypesClientListResponse page.

type ClusterExtensionTypesClientListResponse added in v0.2.0 

type ClusterExtensionTypesClientListResponse struct {
	ClusterExtensionTypesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ClusterExtensionTypesClientListResponse contains the response from method ClusterExtensionTypesClient.List.

type ClusterExtensionTypesClientListResult added in v0.2.0 

type ClusterExtensionTypesClientListResult struct {
	ExtensionTypeList
}

ClusterExtensionTypesClientListResult contains the result from method ClusterExtensionTypesClient.List.

type ClusterScopeSettings 

type ClusterScopeSettings struct {
	// Extension scope settings
	Properties *ClusterScopeSettingsProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ClusterScopeSettings - Extension scope settings

type ClusterScopeSettingsProperties 

type ClusterScopeSettingsProperties struct {
	// Describes if multiple instances of the extension are allowed
	AllowMultipleInstances *bool `json:"allowMultipleInstances,omitempty"`

	// Default extension release namespace
	DefaultReleaseNamespace *string `json:"defaultReleaseNamespace,omitempty"`
}

ClusterScopeSettingsProperties - Extension scope settings

type ClusterTypes 

type ClusterTypes string

ClusterTypes - Cluster types 

const (
	ClusterTypesConnectedClusters ClusterTypes = "connectedClusters"
	ClusterTypesManagedClusters   ClusterTypes = "managedClusters"
)

func PossibleClusterTypesValues 

func PossibleClusterTypesValues() []ClusterTypes

PossibleClusterTypesValues returns the possible values for the ClusterTypes const type.

func (ClusterTypes) ToPtr 

func (c ClusterTypes) ToPtr() *ClusterTypes

ToPtr returns a *ClusterTypes pointing to the current value.

type ComplianceStateType 

type ComplianceStateType string

ComplianceStateType - The compliance state of the configuration. 

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

func PossibleComplianceStateTypeValues 

func PossibleComplianceStateTypeValues() []ComplianceStateType

PossibleComplianceStateTypeValues returns the possible values for the ComplianceStateType const type.

func (ComplianceStateType) ToPtr 

func (c ComplianceStateType) ToPtr() *ComplianceStateType

ToPtr returns a *ComplianceStateType pointing to the current value.

type ComplianceStatus 

type ComplianceStatus struct {
	// Datetime the configuration was last applied.
	LastConfigApplied *time.Time `json:"lastConfigApplied,omitempty"`

	// Message from when the configuration was applied.
	Message *string `json:"message,omitempty"`

	// Level of the message.
	MessageLevel *MessageLevelType `json:"messageLevel,omitempty"`

	// READ-ONLY; The compliance state of the configuration.
	ComplianceState *ComplianceStateType `json:"complianceState,omitempty" azure:"ro"`
}

ComplianceStatus - Compliance Status details

func (ComplianceStatus) MarshalJSON 

func (c ComplianceStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComplianceStatus.

func (*ComplianceStatus) UnmarshalJSON 

func (c *ComplianceStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComplianceStatus.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

func (CreatedByType) ToPtr 

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type DependsOnDefinition 

type DependsOnDefinition struct {
	// Name of the kustomization to claim dependency on
	KustomizationName *string `json:"kustomizationName,omitempty"`
}

DependsOnDefinition - Specify which kustomizations must succeed reconciliation on the cluster prior to reconciling this kustomization

type Enum0 

type Enum0 string
const (
	Enum0MicrosoftContainerService Enum0 = "Microsoft.ContainerService"
	Enum0MicrosoftKubernetes       Enum0 = "Microsoft.Kubernetes"
)

func PossibleEnum0Values 

func PossibleEnum0Values() []Enum0

PossibleEnum0Values returns the possible values for the Enum0 const type.

func (Enum0) ToPtr 

func (c Enum0) ToPtr() *Enum0

ToPtr returns a *Enum0 pointing to the current value.

type Enum1 

type Enum1 string
const (
	Enum1ConnectedClusters Enum1 = "connectedClusters"
	Enum1ManagedClusters   Enum1 = "managedClusters"
)

func PossibleEnum1Values 

func PossibleEnum1Values() []Enum1

PossibleEnum1Values returns the possible values for the Enum1 const type.

func (Enum1) ToPtr 

func (c Enum1) ToPtr() *Enum1

ToPtr returns a *Enum1 pointing to the current value.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

type Extension 

type Extension struct {
	// Identity of the Extension resource
	Identity *Identity `json:"identity,omitempty"`

	// Properties of an Extension resource
	Properties *ExtensionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Extension - The Extension object.

type ExtensionProperties 

type ExtensionProperties struct {
	// Identity of the Extension resource in an AKS cluster
	AksAssignedIdentity *ExtensionPropertiesAksAssignedIdentity `json:"aksAssignedIdentity,omitempty"`

	// Flag to note if this extension participates in auto upgrade of minor version, or not.
	AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`

	// Configuration settings that are sensitive, as name-value pairs for configuring this extension.
	ConfigurationProtectedSettings map[string]*string `json:"configurationProtectedSettings,omitempty"`

	// Configuration settings, as name-value pairs for configuring this extension.
	ConfigurationSettings map[string]*string `json:"configurationSettings,omitempty"`

	// Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with
	// Microsoft.KubernetesConfiguration by the Extension publisher.
	ExtensionType *string `json:"extensionType,omitempty"`

	// ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion
	// is 'true'.
	ReleaseTrain *string `json:"releaseTrain,omitempty"`

	// Scope at which the extension is installed.
	Scope *Scope `json:"scope,omitempty"`

	// Status from this extension.
	Statuses []*ExtensionStatus `json:"statuses,omitempty"`

	// Version of the extension for this extension, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.
	Version *string `json:"version,omitempty"`

	// READ-ONLY; Custom Location settings properties.
	CustomLocationSettings map[string]*string `json:"customLocationSettings,omitempty" azure:"ro"`

	// READ-ONLY; Error information from the Agent - e.g. errors during installation.
	ErrorInfo *ErrorDetail `json:"errorInfo,omitempty" azure:"ro"`

	// READ-ONLY; Uri of the Helm package
	PackageURI *string `json:"packageUri,omitempty" azure:"ro"`

	// READ-ONLY; Status of installation of this extension.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ExtensionProperties - Properties of an Extension resource

func (ExtensionProperties) MarshalJSON 

func (e ExtensionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionProperties.

type ExtensionPropertiesAksAssignedIdentity 

type ExtensionPropertiesAksAssignedIdentity struct {
	// The identity type.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ExtensionPropertiesAksAssignedIdentity - Identity of the Extension resource in an AKS cluster

type ExtensionStatus 

type ExtensionStatus struct {
	// Status code provided by the Extension
	Code *string `json:"code,omitempty"`

	// Short description of status of the extension.
	DisplayStatus *string `json:"displayStatus,omitempty"`

	// Level of the status.
	Level *LevelType `json:"level,omitempty"`

	// Detailed message of the status from the Extension.
	Message *string `json:"message,omitempty"`

	// DateLiteral (per ISO8601) noting the time of installation status.
	Time *string `json:"time,omitempty"`
}

ExtensionStatus - Status from the extension.

type ExtensionType 

type ExtensionType struct {
	// REQUIRED; Describes the Resource Type properties.
	Properties *ExtensionTypeProperties `json:"properties,omitempty"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`
}

ExtensionType - Represents an Extension Type.

type ExtensionTypeList 

type ExtensionTypeList struct {
	// The link to fetch the next page of Extension Types
	NextLink *string `json:"nextLink,omitempty"`

	// The list of Extension Types
	Value []*ExtensionType `json:"value,omitempty"`
}

ExtensionTypeList - List Extension Types

func (ExtensionTypeList) MarshalJSON 

func (e ExtensionTypeList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionTypeList.

type ExtensionTypeProperties 

type ExtensionTypeProperties struct {
	// READ-ONLY; Cluster types
	ClusterTypes *ClusterTypes `json:"clusterTypes,omitempty" azure:"ro"`

	// READ-ONLY; Extension release train: preview or stable
	ReleaseTrains []*string `json:"releaseTrains,omitempty" azure:"ro"`

	// READ-ONLY; Extension scopes
	SupportedScopes *SupportedScopes `json:"supportedScopes,omitempty" azure:"ro"`
}

ExtensionTypeProperties - Properties of the connected cluster.

func (ExtensionTypeProperties) MarshalJSON 

func (e ExtensionTypeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionTypeProperties.

type ExtensionTypeVersionsClient 

type ExtensionTypeVersionsClient struct {
	// contains filtered or unexported fields
}

ExtensionTypeVersionsClient contains the methods for the ExtensionTypeVersions group. Don't use this type directly, use NewExtensionTypeVersionsClient() instead.

func NewExtensionTypeVersionsClient 

func NewExtensionTypeVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExtensionTypeVersionsClient

NewExtensionTypeVersionsClient creates a new instance of ExtensionTypeVersionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExtensionTypeVersionsClient) List 

func (client *ExtensionTypeVersionsClient) List(location string, extensionTypeName string, options *ExtensionTypeVersionsClientListOptions) *ExtensionTypeVersionsClientListPager

List - List available versions for an Extension Type If the operation fails it returns an *azcore.ResponseError type. location - extension location extensionTypeName - Extension type name options - ExtensionTypeVersionsClientListOptions contains the optional parameters for the ExtensionTypeVersionsClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ExtensionTypeVersions_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewExtensionTypeVersionsClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		"<extension-type-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Versions {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExtensionTypeVersionsClientListOptions added in v0.2.0 

type ExtensionTypeVersionsClientListOptions struct {
}

ExtensionTypeVersionsClientListOptions contains the optional parameters for the ExtensionTypeVersionsClient.List method.

type ExtensionTypeVersionsClientListPager added in v0.2.0 

type ExtensionTypeVersionsClientListPager struct {
	// contains filtered or unexported fields
}

ExtensionTypeVersionsClientListPager provides operations for iterating over paged responses.

func (*ExtensionTypeVersionsClientListPager) Err added in v0.2.0 

func (p *ExtensionTypeVersionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExtensionTypeVersionsClientListPager) NextPage added in v0.2.0 

func (p *ExtensionTypeVersionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExtensionTypeVersionsClientListPager) PageResponse added in v0.2.0 

func (p *ExtensionTypeVersionsClientListPager) PageResponse() ExtensionTypeVersionsClientListResponse

PageResponse returns the current ExtensionTypeVersionsClientListResponse page.

type ExtensionTypeVersionsClientListResponse added in v0.2.0 

type ExtensionTypeVersionsClientListResponse struct {
	ExtensionTypeVersionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionTypeVersionsClientListResponse contains the response from method ExtensionTypeVersionsClient.List.

type ExtensionTypeVersionsClientListResult added in v0.2.0 

type ExtensionTypeVersionsClientListResult struct {
	ExtensionVersionList
}

ExtensionTypeVersionsClientListResult contains the result from method ExtensionTypeVersionsClient.List.

type ExtensionVersionList 

type ExtensionVersionList struct {
	// The link to fetch the next page of Extension Types
	NextLink *string `json:"nextLink,omitempty"`

	// Versions available for this Extension Type
	Versions []*ExtensionVersionListVersionsItem `json:"versions,omitempty"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`
}

ExtensionVersionList - List versions for an Extension

func (ExtensionVersionList) MarshalJSON 

func (e ExtensionVersionList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionVersionList.

type ExtensionVersionListVersionsItem 

type ExtensionVersionListVersionsItem struct {
	// The release train for this Extension Type
	ReleaseTrain *string `json:"releaseTrain,omitempty"`

	// Versions available for this Extension Type and release train
	Versions []*string `json:"versions,omitempty"`
}

func (ExtensionVersionListVersionsItem) MarshalJSON 

func (e ExtensionVersionListVersionsItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionVersionListVersionsItem.

type ExtensionsClient 

type ExtensionsClient struct {
	// contains filtered or unexported fields
}

ExtensionsClient contains the methods for the Extensions group. Don't use this type directly, use NewExtensionsClient() instead.

func NewExtensionsClient 

func NewExtensionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ExtensionsClient

NewExtensionsClient creates a new instance of ExtensionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ExtensionsClient) BeginCreate 

func (client *ExtensionsClient) BeginCreate(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, extensionName string, extension Extension, options *ExtensionsClientBeginCreateOptions) (ExtensionsClientCreatePollerResponse, error)

BeginCreate - Create a new Kubernetes Cluster Extension. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. extensionName - Name of the Extension. extension - Properties necessary to Create an Extension. options - ExtensionsClientBeginCreateOptions contains the optional parameters for the ExtensionsClient.BeginCreate method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/CreateExtension.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewExtensionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<extension-name>",
		armkubernetesconfiguration.Extension{
			Properties: &armkubernetesconfiguration.ExtensionProperties{
				AutoUpgradeMinorVersion: to.BoolPtr(true),
				ConfigurationProtectedSettings: map[string]*string{
					"omsagent.secret.key": to.StringPtr("secretKeyValue01"),
				},
				ConfigurationSettings: map[string]*string{
					"omsagent.env.clusterName": to.StringPtr("clusterName1"),
					"omsagent.secret.wsid":     to.StringPtr("a38cef99-5a89-52ed-b6db-22095c23664b"),
				},
				ExtensionType: to.StringPtr("<extension-type>"),
				ReleaseTrain:  to.StringPtr("<release-train>"),
				Scope: &armkubernetesconfiguration.Scope{
					Cluster: &armkubernetesconfiguration.ScopeCluster{
						ReleaseNamespace: to.StringPtr("<release-namespace>"),
					},
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExtensionsClientCreateResult)
}

Output:

func (*ExtensionsClient) BeginDelete 

func (client *ExtensionsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, extensionName string, options *ExtensionsClientBeginDeleteOptions) (ExtensionsClientDeletePollerResponse, error)

BeginDelete - Delete a Kubernetes Cluster Extension. This will cause the Agent to Uninstall the extension from the cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. extensionName - Name of the Extension. options - ExtensionsClientBeginDeleteOptions contains the optional parameters for the ExtensionsClient.BeginDelete method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/DeleteExtension.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewExtensionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<extension-name>",
		&armkubernetesconfiguration.ExtensionsClientBeginDeleteOptions{ForceDelete: nil})
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExtensionsClient) BeginUpdate 

func (client *ExtensionsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, extensionName string, patchExtension PatchExtension, options *ExtensionsClientBeginUpdateOptions) (ExtensionsClientUpdatePollerResponse, error)

BeginUpdate - Patch an existing Kubernetes Cluster Extension. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. extensionName - Name of the Extension. patchExtension - Properties to Patch in an existing Extension. options - ExtensionsClientBeginUpdateOptions contains the optional parameters for the ExtensionsClient.BeginUpdate method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/PatchExtension.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewExtensionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<extension-name>",
		armkubernetesconfiguration.PatchExtension{
			Properties: &armkubernetesconfiguration.PatchExtensionProperties{
				AutoUpgradeMinorVersion: to.BoolPtr(true),
				ConfigurationProtectedSettings: map[string]*string{
					"omsagent.secret.key": to.StringPtr("secretKeyValue01"),
				},
				ConfigurationSettings: map[string]*string{
					"omsagent.env.clusterName": to.StringPtr("clusterName1"),
					"omsagent.secret.wsid":     to.StringPtr("a38cef99-5a89-52ed-b6db-22095c23664b"),
				},
				ReleaseTrain: to.StringPtr("<release-train>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ExtensionsClient) Get 

func (client *ExtensionsClient) Get(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, extensionName string, options *ExtensionsClientGetOptions) (ExtensionsClientGetResponse, error)

Get - Gets Kubernetes Cluster Extension. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. extensionName - Name of the Extension. options - ExtensionsClientGetOptions contains the optional parameters for the ExtensionsClient.Get method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/GetExtension.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewExtensionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<extension-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ExtensionsClientGetResult)
}

Output:

func (*ExtensionsClient) List 

func (client *ExtensionsClient) List(resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, options *ExtensionsClientListOptions) *ExtensionsClientListPager

List - List all Extensions in the cluster. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. options - ExtensionsClientListOptions contains the optional parameters for the ExtensionsClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ListExtensions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewExtensionsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ExtensionsClientBeginCreateOptions added in v0.2.0 

type ExtensionsClientBeginCreateOptions struct {
}

ExtensionsClientBeginCreateOptions contains the optional parameters for the ExtensionsClient.BeginCreate method.

type ExtensionsClientBeginDeleteOptions added in v0.2.0 

type ExtensionsClientBeginDeleteOptions struct {
	// Delete the extension resource in Azure - not the normal asynchronous delete.
	ForceDelete *bool
}

ExtensionsClientBeginDeleteOptions contains the optional parameters for the ExtensionsClient.BeginDelete method.

type ExtensionsClientBeginUpdateOptions added in v0.2.0 

type ExtensionsClientBeginUpdateOptions struct {
}

ExtensionsClientBeginUpdateOptions contains the optional parameters for the ExtensionsClient.BeginUpdate method.

type ExtensionsClientCreatePoller added in v0.2.0 

type ExtensionsClientCreatePoller struct {
	// contains filtered or unexported fields
}

ExtensionsClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExtensionsClientCreatePoller) Done added in v0.2.0 

func (p *ExtensionsClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExtensionsClientCreatePoller) FinalResponse added in v0.2.0 

func (p *ExtensionsClientCreatePoller) FinalResponse(ctx context.Context) (ExtensionsClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExtensionsClientCreateResponse will be returned.

func (*ExtensionsClientCreatePoller) Poll added in v0.2.0 

func (p *ExtensionsClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExtensionsClientCreatePoller) ResumeToken added in v0.2.0 

func (p *ExtensionsClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExtensionsClientCreatePollerResponse added in v0.2.0 

type ExtensionsClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExtensionsClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientCreatePollerResponse contains the response from method ExtensionsClient.Create.

func (ExtensionsClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l ExtensionsClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExtensionsClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExtensionsClientCreatePollerResponse) Resume added in v0.2.0 

func (l *ExtensionsClientCreatePollerResponse) Resume(ctx context.Context, client *ExtensionsClient, token string) error

Resume rehydrates a ExtensionsClientCreatePollerResponse from the provided client and resume token.

type ExtensionsClientCreateResponse added in v0.2.0 

type ExtensionsClientCreateResponse struct {
	ExtensionsClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientCreateResponse contains the response from method ExtensionsClient.Create.

type ExtensionsClientCreateResult added in v0.2.0 

type ExtensionsClientCreateResult struct {
	Extension
}

ExtensionsClientCreateResult contains the result from method ExtensionsClient.Create.

type ExtensionsClientDeletePoller added in v0.2.0 

type ExtensionsClientDeletePoller struct {
	// contains filtered or unexported fields
}

ExtensionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ExtensionsClientDeletePoller) Done added in v0.2.0 

func (p *ExtensionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExtensionsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *ExtensionsClientDeletePoller) FinalResponse(ctx context.Context) (ExtensionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExtensionsClientDeleteResponse will be returned.

func (*ExtensionsClientDeletePoller) Poll added in v0.2.0 

func (p *ExtensionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExtensionsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *ExtensionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExtensionsClientDeletePollerResponse added in v0.2.0 

type ExtensionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExtensionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientDeletePollerResponse contains the response from method ExtensionsClient.Delete.

func (ExtensionsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l ExtensionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExtensionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExtensionsClientDeletePollerResponse) Resume added in v0.2.0 

func (l *ExtensionsClientDeletePollerResponse) Resume(ctx context.Context, client *ExtensionsClient, token string) error

Resume rehydrates a ExtensionsClientDeletePollerResponse from the provided client and resume token.

type ExtensionsClientDeleteResponse added in v0.2.0 

type ExtensionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientDeleteResponse contains the response from method ExtensionsClient.Delete.

type ExtensionsClientGetOptions added in v0.2.0 

type ExtensionsClientGetOptions struct {
}

ExtensionsClientGetOptions contains the optional parameters for the ExtensionsClient.Get method.

type ExtensionsClientGetResponse added in v0.2.0 

type ExtensionsClientGetResponse struct {
	ExtensionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientGetResponse contains the response from method ExtensionsClient.Get.

type ExtensionsClientGetResult added in v0.2.0 

type ExtensionsClientGetResult struct {
	Extension
}

ExtensionsClientGetResult contains the result from method ExtensionsClient.Get.

type ExtensionsClientListOptions added in v0.2.0 

type ExtensionsClientListOptions struct {
}

ExtensionsClientListOptions contains the optional parameters for the ExtensionsClient.List method.

type ExtensionsClientListPager added in v0.2.0 

type ExtensionsClientListPager struct {
	// contains filtered or unexported fields
}

ExtensionsClientListPager provides operations for iterating over paged responses.

func (*ExtensionsClientListPager) Err added in v0.2.0 

func (p *ExtensionsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*ExtensionsClientListPager) NextPage added in v0.2.0 

func (p *ExtensionsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ExtensionsClientListPager) PageResponse added in v0.2.0 

func (p *ExtensionsClientListPager) PageResponse() ExtensionsClientListResponse

PageResponse returns the current ExtensionsClientListResponse page.

type ExtensionsClientListResponse added in v0.2.0 

type ExtensionsClientListResponse struct {
	ExtensionsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientListResponse contains the response from method ExtensionsClient.List.

type ExtensionsClientListResult added in v0.2.0 

type ExtensionsClientListResult struct {
	ExtensionsList
}

ExtensionsClientListResult contains the result from method ExtensionsClient.List.

type ExtensionsClientUpdatePoller added in v0.2.0 

type ExtensionsClientUpdatePoller struct {
	// contains filtered or unexported fields
}

ExtensionsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ExtensionsClientUpdatePoller) Done added in v0.2.0 

func (p *ExtensionsClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ExtensionsClientUpdatePoller) FinalResponse added in v0.2.0 

func (p *ExtensionsClientUpdatePoller) FinalResponse(ctx context.Context) (ExtensionsClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ExtensionsClientUpdateResponse will be returned.

func (*ExtensionsClientUpdatePoller) Poll added in v0.2.0 

func (p *ExtensionsClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ExtensionsClientUpdatePoller) ResumeToken added in v0.2.0 

func (p *ExtensionsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ExtensionsClientUpdatePollerResponse added in v0.2.0 

type ExtensionsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ExtensionsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientUpdatePollerResponse contains the response from method ExtensionsClient.Update.

func (ExtensionsClientUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l ExtensionsClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ExtensionsClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ExtensionsClientUpdatePollerResponse) Resume added in v0.2.0 

func (l *ExtensionsClientUpdatePollerResponse) Resume(ctx context.Context, client *ExtensionsClient, token string) error

Resume rehydrates a ExtensionsClientUpdatePollerResponse from the provided client and resume token.

type ExtensionsClientUpdateResponse added in v0.2.0 

type ExtensionsClientUpdateResponse struct {
	ExtensionsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ExtensionsClientUpdateResponse contains the response from method ExtensionsClient.Update.

type ExtensionsClientUpdateResult added in v0.2.0 

type ExtensionsClientUpdateResult struct {
	Extension
}

ExtensionsClientUpdateResult contains the result from method ExtensionsClient.Update.

type ExtensionsList 

type ExtensionsList struct {
	// READ-ONLY; URL to get the next set of extension objects, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of Extensions within a Kubernetes cluster.
	Value []*Extension `json:"value,omitempty" azure:"ro"`
}

ExtensionsList - Result of the request to list Extensions. It contains a list of Extension objects and a URL link to get the next set of results.

func (ExtensionsList) MarshalJSON 

func (e ExtensionsList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExtensionsList.

type FluxComplianceState 

type FluxComplianceState string

FluxComplianceState - Compliance state of the cluster object. 

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

func PossibleFluxComplianceStateValues 

func PossibleFluxComplianceStateValues() []FluxComplianceState

PossibleFluxComplianceStateValues returns the possible values for the FluxComplianceState const type.

func (FluxComplianceState) ToPtr 

func (c FluxComplianceState) ToPtr() *FluxComplianceState

ToPtr returns a *FluxComplianceState pointing to the current value.

type FluxConfigOperationStatusClient 

type FluxConfigOperationStatusClient struct {
	// contains filtered or unexported fields
}

FluxConfigOperationStatusClient contains the methods for the FluxConfigOperationStatus group. Don't use this type directly, use NewFluxConfigOperationStatusClient() instead.

func NewFluxConfigOperationStatusClient 

func NewFluxConfigOperationStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FluxConfigOperationStatusClient

NewFluxConfigOperationStatusClient creates a new instance of FluxConfigOperationStatusClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FluxConfigOperationStatusClient) Get 

func (client *FluxConfigOperationStatusClient) Get(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, fluxConfigurationName string, operationID string, options *FluxConfigOperationStatusClientGetOptions) (FluxConfigOperationStatusClientGetResponse, error)

Get - Get Async Operation status If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. fluxConfigurationName - Name of the Flux Configuration. operationID - operation Id options - FluxConfigOperationStatusClientGetOptions contains the optional parameters for the FluxConfigOperationStatusClient.Get method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/GetFluxConfigurationAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewFluxConfigOperationStatusClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<flux-configuration-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FluxConfigOperationStatusClientGetResult)
}

Output:

type FluxConfigOperationStatusClientGetOptions added in v0.2.0 

type FluxConfigOperationStatusClientGetOptions struct {
}

FluxConfigOperationStatusClientGetOptions contains the optional parameters for the FluxConfigOperationStatusClient.Get method.

type FluxConfigOperationStatusClientGetResponse added in v0.2.0 

type FluxConfigOperationStatusClientGetResponse struct {
	FluxConfigOperationStatusClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigOperationStatusClientGetResponse contains the response from method FluxConfigOperationStatusClient.Get.

type FluxConfigOperationStatusClientGetResult added in v0.2.0 

type FluxConfigOperationStatusClientGetResult struct {
	OperationStatusResult
}

FluxConfigOperationStatusClientGetResult contains the result from method FluxConfigOperationStatusClient.Get.

type FluxConfiguration 

type FluxConfiguration struct {
	// Properties to create a Flux Configuration resource
	Properties *FluxConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

FluxConfiguration - The Flux Configuration object returned in Get & Put response.

type FluxConfigurationPatch 

type FluxConfigurationPatch struct {
	// Updatable properties of an Flux Configuration Patch Request
	Properties *FluxConfigurationPatchProperties `json:"properties,omitempty"`
}

FluxConfigurationPatch - The Flux Configuration Patch Request object.

func (FluxConfigurationPatch) MarshalJSON 

func (f FluxConfigurationPatch) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FluxConfigurationPatch.

type FluxConfigurationPatchProperties 

type FluxConfigurationPatchProperties struct {
	// Parameters to reconcile to the Bucket source kind type.
	Bucket *BucketDefinition `json:"bucket,omitempty"`

	// Key-value pairs of protected configuration settings for the configuration
	ConfigurationProtectedSettings map[string]*string `json:"configurationProtectedSettings,omitempty"`

	// Parameters to reconcile to the GitRepository source kind type.
	GitRepository *GitRepositoryPatchDefinition `json:"gitRepository,omitempty"`

	// Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.
	Kustomizations map[string]*KustomizationPatchDefinition `json:"kustomizations,omitempty"`

	// Source Kind to pull the configuration data from.
	SourceKind *SourceKindType `json:"sourceKind,omitempty"`

	// Whether this configuration should suspend its reconciliation of its kustomizations and sources.
	Suspend *bool `json:"suspend,omitempty"`
}

FluxConfigurationPatchProperties - Updatable properties of an Flux Configuration Patch Request

func (FluxConfigurationPatchProperties) MarshalJSON 

func (f FluxConfigurationPatchProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FluxConfigurationPatchProperties.

type FluxConfigurationProperties 

type FluxConfigurationProperties struct {
	// Parameters to reconcile to the Bucket source kind type.
	Bucket *BucketDefinition `json:"bucket,omitempty"`

	// Key-value pairs of protected configuration settings for the configuration
	ConfigurationProtectedSettings map[string]*string `json:"configurationProtectedSettings,omitempty"`

	// Parameters to reconcile to the GitRepository source kind type.
	GitRepository *GitRepositoryDefinition `json:"gitRepository,omitempty"`

	// Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.
	Kustomizations map[string]*KustomizationDefinition `json:"kustomizations,omitempty"`

	// The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and
	// period only.
	Namespace *string `json:"namespace,omitempty"`

	// Scope at which the operator will be installed.
	Scope *ScopeType `json:"scope,omitempty"`

	// Source Kind to pull the configuration data from.
	SourceKind *SourceKindType `json:"sourceKind,omitempty"`

	// Whether this configuration should suspend its reconciliation of its kustomizations and sources.
	Suspend *bool `json:"suspend,omitempty"`

	// READ-ONLY; Combined status of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed
	// objects.
	ComplianceState *FluxComplianceState `json:"complianceState,omitempty" azure:"ro"`

	// READ-ONLY; Error message returned to the user in the case of provisioning failure.
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Datetime the fluxConfiguration last synced its source on the cluster.
	LastSourceUpdatedAt *time.Time `json:"lastSourceUpdatedAt,omitempty" azure:"ro"`

	// READ-ONLY; Branch and SHA of the last source commit synced with the cluster.
	LastSourceUpdatedCommitID *string `json:"lastSourceUpdatedCommitId,omitempty" azure:"ro"`

	// READ-ONLY; Status of the creation of the fluxConfiguration.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Public Key associated with this fluxConfiguration (either generated within the cluster or provided by the user).
	RepositoryPublicKey *string `json:"repositoryPublicKey,omitempty" azure:"ro"`

	// READ-ONLY; Statuses of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects
	// provisioned by the fluxConfiguration.
	Statuses []*ObjectStatusDefinition `json:"statuses,omitempty" azure:"ro"`
}

FluxConfigurationProperties - Properties to create a Flux Configuration resource

func (FluxConfigurationProperties) MarshalJSON 

func (f FluxConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FluxConfigurationProperties.

func (*FluxConfigurationProperties) UnmarshalJSON 

func (f *FluxConfigurationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FluxConfigurationProperties.

type FluxConfigurationsClient 

type FluxConfigurationsClient struct {
	// contains filtered or unexported fields
}

FluxConfigurationsClient contains the methods for the FluxConfigurations group. Don't use this type directly, use NewFluxConfigurationsClient() instead.

func NewFluxConfigurationsClient 

func NewFluxConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *FluxConfigurationsClient

NewFluxConfigurationsClient creates a new instance of FluxConfigurationsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*FluxConfigurationsClient) BeginCreateOrUpdate 

func (client *FluxConfigurationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, fluxConfigurationName string, fluxConfiguration FluxConfiguration, options *FluxConfigurationsClientBeginCreateOrUpdateOptions) (FluxConfigurationsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create a new Kubernetes Flux Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. fluxConfigurationName - Name of the Flux Configuration. fluxConfiguration - Properties necessary to Create a FluxConfiguration. options - FluxConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the FluxConfigurationsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/CreateFluxConfiguration.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewFluxConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<flux-configuration-name>",
		armkubernetesconfiguration.FluxConfiguration{
			Properties: &armkubernetesconfiguration.FluxConfigurationProperties{
				GitRepository: &armkubernetesconfiguration.GitRepositoryDefinition{
					HTTPSCACert: to.StringPtr("<httpscacert>"),
					RepositoryRef: &armkubernetesconfiguration.RepositoryRefDefinition{
						Branch: to.StringPtr("<branch>"),
					},
					SyncIntervalInSeconds: to.Int64Ptr(600),
					TimeoutInSeconds:      to.Int64Ptr(600),
					URL:                   to.StringPtr("<url>"),
				},
				Kustomizations: map[string]*armkubernetesconfiguration.KustomizationDefinition{
					"srs-kustomization1": {
						Path:                  to.StringPtr("<path>"),
						DependsOn:             []*armkubernetesconfiguration.DependsOnDefinition{},
						SyncIntervalInSeconds: to.Int64Ptr(600),
						TimeoutInSeconds:      to.Int64Ptr(600),
					},
					"srs-kustomization2": {
						Path: to.StringPtr("<path>"),
						DependsOn: []*armkubernetesconfiguration.DependsOnDefinition{
							{
								KustomizationName: to.StringPtr("<kustomization-name>"),
							}},
						Prune:                  to.BoolPtr(false),
						RetryIntervalInSeconds: to.Int64Ptr(600),
						SyncIntervalInSeconds:  to.Int64Ptr(600),
						TimeoutInSeconds:       to.Int64Ptr(600),
					},
				},
				Namespace:  to.StringPtr("<namespace>"),
				Scope:      armkubernetesconfiguration.ScopeType("cluster").ToPtr(),
				SourceKind: armkubernetesconfiguration.SourceKindType("GitRepository").ToPtr(),
				Suspend:    to.BoolPtr(false),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FluxConfigurationsClientCreateOrUpdateResult)
}

Output:

func (*FluxConfigurationsClient) BeginDelete 

func (client *FluxConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, fluxConfigurationName string, options *FluxConfigurationsClientBeginDeleteOptions) (FluxConfigurationsClientDeletePollerResponse, error)

BeginDelete - This will delete the YAML file used to set up the Flux Configuration, thus stopping future sync from the source repo. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. fluxConfigurationName - Name of the Flux Configuration. options - FluxConfigurationsClientBeginDeleteOptions contains the optional parameters for the FluxConfigurationsClient.BeginDelete method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/DeleteFluxConfiguration.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewFluxConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<flux-configuration-name>",
		&armkubernetesconfiguration.FluxConfigurationsClientBeginDeleteOptions{ForceDelete: nil})
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*FluxConfigurationsClient) BeginUpdate 

func (client *FluxConfigurationsClient) BeginUpdate(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, fluxConfigurationName string, fluxConfigurationPatch FluxConfigurationPatch, options *FluxConfigurationsClientBeginUpdateOptions) (FluxConfigurationsClientUpdatePollerResponse, error)

BeginUpdate - Update an existing Kubernetes Flux Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. fluxConfigurationName - Name of the Flux Configuration. fluxConfigurationPatch - Properties to Patch in an existing Flux Configuration. options - FluxConfigurationsClientBeginUpdateOptions contains the optional parameters for the FluxConfigurationsClient.BeginUpdate method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/PatchFluxConfiguration.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewFluxConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<flux-configuration-name>",
		armkubernetesconfiguration.FluxConfigurationPatch{
			Properties: &armkubernetesconfiguration.FluxConfigurationPatchProperties{
				GitRepository: &armkubernetesconfiguration.GitRepositoryPatchDefinition{
					URL: to.StringPtr("<url>"),
				},
				Kustomizations: map[string]*armkubernetesconfiguration.KustomizationPatchDefinition{
					"srs-kustomization1": nil,
					"srs-kustomization2": {
						Path:                  to.StringPtr("<path>"),
						SyncIntervalInSeconds: to.Int64Ptr(300),
					},
					"srs-kustomization3": {
						Path:                  to.StringPtr("<path>"),
						SyncIntervalInSeconds: to.Int64Ptr(300),
					},
				},
				Suspend: to.BoolPtr(true),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*FluxConfigurationsClient) Get 

func (client *FluxConfigurationsClient) Get(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, fluxConfigurationName string, options *FluxConfigurationsClientGetOptions) (FluxConfigurationsClientGetResponse, error)

Get - Gets details of the Flux Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. fluxConfigurationName - Name of the Flux Configuration. options - FluxConfigurationsClientGetOptions contains the optional parameters for the FluxConfigurationsClient.Get method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/GetFluxConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewFluxConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<flux-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.FluxConfigurationsClientGetResult)
}

Output:

func (*FluxConfigurationsClient) List 

func (client *FluxConfigurationsClient) List(resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, options *FluxConfigurationsClientListOptions) *FluxConfigurationsClientListPager

List - List all Flux Configurations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. options - FluxConfigurationsClientListOptions contains the optional parameters for the FluxConfigurationsClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ListFluxConfigurations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewFluxConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type FluxConfigurationsClientBeginCreateOrUpdateOptions added in v0.2.0 

type FluxConfigurationsClientBeginCreateOrUpdateOptions struct {
}

FluxConfigurationsClientBeginCreateOrUpdateOptions contains the optional parameters for the FluxConfigurationsClient.BeginCreateOrUpdate method.

type FluxConfigurationsClientBeginDeleteOptions added in v0.2.0 

type FluxConfigurationsClientBeginDeleteOptions struct {
	// Delete the extension resource in Azure - not the normal asynchronous delete.
	ForceDelete *bool
}

FluxConfigurationsClientBeginDeleteOptions contains the optional parameters for the FluxConfigurationsClient.BeginDelete method.

type FluxConfigurationsClientBeginUpdateOptions added in v0.2.0 

type FluxConfigurationsClientBeginUpdateOptions struct {
}

FluxConfigurationsClientBeginUpdateOptions contains the optional parameters for the FluxConfigurationsClient.BeginUpdate method.

type FluxConfigurationsClientCreateOrUpdatePoller added in v0.2.0 

type FluxConfigurationsClientCreateOrUpdatePoller struct {
	// contains filtered or unexported fields
}

FluxConfigurationsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*FluxConfigurationsClientCreateOrUpdatePoller) Done added in v0.2.0 

func (p *FluxConfigurationsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FluxConfigurationsClientCreateOrUpdatePoller) FinalResponse added in v0.2.0 

func (p *FluxConfigurationsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (FluxConfigurationsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FluxConfigurationsClientCreateOrUpdateResponse will be returned.

func (*FluxConfigurationsClientCreateOrUpdatePoller) Poll added in v0.2.0 

func (p *FluxConfigurationsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FluxConfigurationsClientCreateOrUpdatePoller) ResumeToken added in v0.2.0 

func (p *FluxConfigurationsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FluxConfigurationsClientCreateOrUpdatePollerResponse added in v0.2.0 

type FluxConfigurationsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FluxConfigurationsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientCreateOrUpdatePollerResponse contains the response from method FluxConfigurationsClient.CreateOrUpdate.

func (FluxConfigurationsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l FluxConfigurationsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FluxConfigurationsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FluxConfigurationsClientCreateOrUpdatePollerResponse) Resume added in v0.2.0 

func (l *FluxConfigurationsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *FluxConfigurationsClient, token string) error

Resume rehydrates a FluxConfigurationsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type FluxConfigurationsClientCreateOrUpdateResponse added in v0.2.0 

type FluxConfigurationsClientCreateOrUpdateResponse struct {
	FluxConfigurationsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientCreateOrUpdateResponse contains the response from method FluxConfigurationsClient.CreateOrUpdate.

type FluxConfigurationsClientCreateOrUpdateResult added in v0.2.0 

type FluxConfigurationsClientCreateOrUpdateResult struct {
	FluxConfiguration
}

FluxConfigurationsClientCreateOrUpdateResult contains the result from method FluxConfigurationsClient.CreateOrUpdate.

type FluxConfigurationsClientDeletePoller added in v0.2.0 

type FluxConfigurationsClientDeletePoller struct {
	// contains filtered or unexported fields
}

FluxConfigurationsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*FluxConfigurationsClientDeletePoller) Done added in v0.2.0 

func (p *FluxConfigurationsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FluxConfigurationsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *FluxConfigurationsClientDeletePoller) FinalResponse(ctx context.Context) (FluxConfigurationsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FluxConfigurationsClientDeleteResponse will be returned.

func (*FluxConfigurationsClientDeletePoller) Poll added in v0.2.0 

func (p *FluxConfigurationsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FluxConfigurationsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *FluxConfigurationsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FluxConfigurationsClientDeletePollerResponse added in v0.2.0 

type FluxConfigurationsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FluxConfigurationsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientDeletePollerResponse contains the response from method FluxConfigurationsClient.Delete.

func (FluxConfigurationsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l FluxConfigurationsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FluxConfigurationsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FluxConfigurationsClientDeletePollerResponse) Resume added in v0.2.0 

func (l *FluxConfigurationsClientDeletePollerResponse) Resume(ctx context.Context, client *FluxConfigurationsClient, token string) error

Resume rehydrates a FluxConfigurationsClientDeletePollerResponse from the provided client and resume token.

type FluxConfigurationsClientDeleteResponse added in v0.2.0 

type FluxConfigurationsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientDeleteResponse contains the response from method FluxConfigurationsClient.Delete.

type FluxConfigurationsClientGetOptions added in v0.2.0 

type FluxConfigurationsClientGetOptions struct {
}

FluxConfigurationsClientGetOptions contains the optional parameters for the FluxConfigurationsClient.Get method.

type FluxConfigurationsClientGetResponse added in v0.2.0 

type FluxConfigurationsClientGetResponse struct {
	FluxConfigurationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientGetResponse contains the response from method FluxConfigurationsClient.Get.

type FluxConfigurationsClientGetResult added in v0.2.0 

type FluxConfigurationsClientGetResult struct {
	FluxConfiguration
}

FluxConfigurationsClientGetResult contains the result from method FluxConfigurationsClient.Get.

type FluxConfigurationsClientListOptions added in v0.2.0 

type FluxConfigurationsClientListOptions struct {
}

FluxConfigurationsClientListOptions contains the optional parameters for the FluxConfigurationsClient.List method.

type FluxConfigurationsClientListPager added in v0.2.0 

type FluxConfigurationsClientListPager struct {
	// contains filtered or unexported fields
}

FluxConfigurationsClientListPager provides operations for iterating over paged responses.

func (*FluxConfigurationsClientListPager) Err added in v0.2.0 

func (p *FluxConfigurationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*FluxConfigurationsClientListPager) NextPage added in v0.2.0 

func (p *FluxConfigurationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*FluxConfigurationsClientListPager) PageResponse added in v0.2.0 

func (p *FluxConfigurationsClientListPager) PageResponse() FluxConfigurationsClientListResponse

PageResponse returns the current FluxConfigurationsClientListResponse page.

type FluxConfigurationsClientListResponse added in v0.2.0 

type FluxConfigurationsClientListResponse struct {
	FluxConfigurationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientListResponse contains the response from method FluxConfigurationsClient.List.

type FluxConfigurationsClientListResult added in v0.2.0 

type FluxConfigurationsClientListResult struct {
	FluxConfigurationsList
}

FluxConfigurationsClientListResult contains the result from method FluxConfigurationsClient.List.

type FluxConfigurationsClientUpdatePoller added in v0.2.0 

type FluxConfigurationsClientUpdatePoller struct {
	// contains filtered or unexported fields
}

FluxConfigurationsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*FluxConfigurationsClientUpdatePoller) Done added in v0.2.0 

func (p *FluxConfigurationsClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*FluxConfigurationsClientUpdatePoller) FinalResponse added in v0.2.0 

func (p *FluxConfigurationsClientUpdatePoller) FinalResponse(ctx context.Context) (FluxConfigurationsClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final FluxConfigurationsClientUpdateResponse will be returned.

func (*FluxConfigurationsClientUpdatePoller) Poll added in v0.2.0 

func (p *FluxConfigurationsClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*FluxConfigurationsClientUpdatePoller) ResumeToken added in v0.2.0 

func (p *FluxConfigurationsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type FluxConfigurationsClientUpdatePollerResponse added in v0.2.0 

type FluxConfigurationsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *FluxConfigurationsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientUpdatePollerResponse contains the response from method FluxConfigurationsClient.Update.

func (FluxConfigurationsClientUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l FluxConfigurationsClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (FluxConfigurationsClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*FluxConfigurationsClientUpdatePollerResponse) Resume added in v0.2.0 

func (l *FluxConfigurationsClientUpdatePollerResponse) Resume(ctx context.Context, client *FluxConfigurationsClient, token string) error

Resume rehydrates a FluxConfigurationsClientUpdatePollerResponse from the provided client and resume token.

type FluxConfigurationsClientUpdateResponse added in v0.2.0 

type FluxConfigurationsClientUpdateResponse struct {
	FluxConfigurationsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

FluxConfigurationsClientUpdateResponse contains the response from method FluxConfigurationsClient.Update.

type FluxConfigurationsClientUpdateResult added in v0.2.0 

type FluxConfigurationsClientUpdateResult struct {
	FluxConfiguration
}

FluxConfigurationsClientUpdateResult contains the result from method FluxConfigurationsClient.Update.

type FluxConfigurationsList 

type FluxConfigurationsList struct {
	// READ-ONLY; URL to get the next set of configuration objects, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of Flux Configurations within a Kubernetes cluster.
	Value []*FluxConfiguration `json:"value,omitempty" azure:"ro"`
}

FluxConfigurationsList - Result of the request to list Flux Configurations. It contains a list of FluxConfiguration objects and a URL link to get the next set of results.

func (FluxConfigurationsList) MarshalJSON 

func (f FluxConfigurationsList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FluxConfigurationsList.

type GitRepositoryDefinition 

type GitRepositoryDefinition struct {
	// Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS
	HTTPSCACert *string `json:"httpsCACert,omitempty"`

	// Plaintext HTTPS username used to access private git repositories over HTTPS
	HTTPSUser *string `json:"httpsUser,omitempty"`

	// Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided
	// configuration secrets.
	LocalAuthRef *string `json:"localAuthRef,omitempty"`

	// The source reference for the GitRepository object.
	RepositoryRef *RepositoryRefDefinition `json:"repositoryRef,omitempty"`

	// Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH
	SSHKnownHosts *string `json:"sshKnownHosts,omitempty"`

	// The interval at which to re-reconcile the cluster git repository source with the remote.
	SyncIntervalInSeconds *int64 `json:"syncIntervalInSeconds,omitempty"`

	// The maximum time to attempt to reconcile the cluster git repository source with the remote.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`

	// The URL to sync for the flux configuration git repository.
	URL *string `json:"url,omitempty"`
}

GitRepositoryDefinition - Parameters to reconcile to the GitRepository source kind type.

type GitRepositoryPatchDefinition 

type GitRepositoryPatchDefinition struct {
	// Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS
	HTTPSCACert *string `json:"httpsCACert,omitempty"`

	// Plaintext HTTPS username used to access private git repositories over HTTPS
	HTTPSUser *string `json:"httpsUser,omitempty"`

	// Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided
	// configuration secrets.
	LocalAuthRef *string `json:"localAuthRef,omitempty"`

	// The source reference for the GitRepository object.
	RepositoryRef *RepositoryRefDefinition `json:"repositoryRef,omitempty"`

	// Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH
	SSHKnownHosts *string `json:"sshKnownHosts,omitempty"`

	// The interval at which to re-reconcile the cluster git repository source with the remote.
	SyncIntervalInSeconds *int64 `json:"syncIntervalInSeconds,omitempty"`

	// The maximum time to attempt to reconcile the cluster git repository source with the remote.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`

	// The URL to sync for the flux configuration git repository.
	URL *string `json:"url,omitempty"`
}

GitRepositoryPatchDefinition - Parameters to reconcile to the GitRepository source kind type.

type HelmOperatorProperties 

type HelmOperatorProperties struct {
	// Values override for the operator Helm chart.
	ChartValues *string `json:"chartValues,omitempty"`

	// Version of the operator Helm chart.
	ChartVersion *string `json:"chartVersion,omitempty"`
}

HelmOperatorProperties - Properties for Helm operator.

type HelmReleasePropertiesDefinition 

type HelmReleasePropertiesDefinition struct {
	// Total number of times that the HelmRelease failed to install or upgrade
	FailureCount *int64 `json:"failureCount,omitempty"`

	// The reference to the HelmChart object used as the source to this HelmRelease
	HelmChartRef *ObjectReferenceDefinition `json:"helmChartRef,omitempty"`

	// Number of times that the HelmRelease failed to install
	InstallFailureCount *int64 `json:"installFailureCount,omitempty"`

	// The revision number of the last released object change
	LastRevisionApplied *int64 `json:"lastRevisionApplied,omitempty"`

	// Number of times that the HelmRelease failed to upgrade
	UpgradeFailureCount *int64 `json:"upgradeFailureCount,omitempty"`
}

type Identity 

type Identity struct {
	// The identity type.
	Type *string `json:"type,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource.

type KustomizationDefinition 

type KustomizationDefinition struct {
	// Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies
	// have completed their reconciliation.
	DependsOn []*DependsOnDefinition `json:"dependsOn,omitempty"`

	// Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change.
	Force *bool `json:"force,omitempty"`

	// The path in the source reference to reconcile on the cluster.
	Path *string `json:"path,omitempty"`

	// Enable/disable garbage collections of Kubernetes objects created by this Kustomization.
	Prune *bool `json:"prune,omitempty"`

	// The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation.
	RetryIntervalInSeconds *int64 `json:"retryIntervalInSeconds,omitempty"`

	// The interval at which to re-reconcile the Kustomization on the cluster.
	SyncIntervalInSeconds *int64 `json:"syncIntervalInSeconds,omitempty"`

	// The maximum time to attempt to reconcile the Kustomization on the cluster.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`
}

KustomizationDefinition - The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.

func (KustomizationDefinition) MarshalJSON 

func (k KustomizationDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustomizationDefinition.

type KustomizationPatchDefinition 

type KustomizationPatchDefinition struct {
	// Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies
	// have completed their reconciliation.
	DependsOn []*DependsOnDefinition `json:"dependsOn,omitempty"`

	// Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change.
	Force *bool `json:"force,omitempty"`

	// The path in the source reference to reconcile on the cluster.
	Path *string `json:"path,omitempty"`

	// Enable/disable garbage collections of Kubernetes objects created by this Kustomization.
	Prune *bool `json:"prune,omitempty"`

	// The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation.
	RetryIntervalInSeconds *int64 `json:"retryIntervalInSeconds,omitempty"`

	// The interval at which to re-reconcile the Kustomization on the cluster.
	SyncIntervalInSeconds *int64 `json:"syncIntervalInSeconds,omitempty"`

	// The maximum time to attempt to reconcile the Kustomization on the cluster.
	TimeoutInSeconds *int64 `json:"timeoutInSeconds,omitempty"`
}

KustomizationPatchDefinition - The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster.

func (KustomizationPatchDefinition) MarshalJSON 

func (k KustomizationPatchDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KustomizationPatchDefinition.

type KustomizationValidationType 

type KustomizationValidationType string

KustomizationValidationType - Specify whether to validate the Kubernetes objects referenced in the Kustomization before applying them to the cluster. 

const (
	KustomizationValidationTypeClient KustomizationValidationType = "client"
	KustomizationValidationTypeNone   KustomizationValidationType = "none"
	KustomizationValidationTypeServer KustomizationValidationType = "server"
)

func PossibleKustomizationValidationTypeValues 

func PossibleKustomizationValidationTypeValues() []KustomizationValidationType

PossibleKustomizationValidationTypeValues returns the possible values for the KustomizationValidationType const type.

func (KustomizationValidationType) ToPtr 

func (c KustomizationValidationType) ToPtr() *KustomizationValidationType

ToPtr returns a *KustomizationValidationType pointing to the current value.

type LevelType 

type LevelType string

LevelType - Level of the status. 

const (
	LevelTypeError       LevelType = "Error"
	LevelTypeInformation LevelType = "Information"
	LevelTypeWarning     LevelType = "Warning"
)

func PossibleLevelTypeValues 

func PossibleLevelTypeValues() []LevelType

PossibleLevelTypeValues returns the possible values for the LevelType const type.

func (LevelType) ToPtr 

func (c LevelType) ToPtr() *LevelType

ToPtr returns a *LevelType pointing to the current value.

type LocationExtensionTypesClient 

type LocationExtensionTypesClient struct {
	// contains filtered or unexported fields
}

LocationExtensionTypesClient contains the methods for the LocationExtensionTypes group. Don't use this type directly, use NewLocationExtensionTypesClient() instead.

func NewLocationExtensionTypesClient 

func NewLocationExtensionTypesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *LocationExtensionTypesClient

NewLocationExtensionTypesClient creates a new instance of LocationExtensionTypesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LocationExtensionTypesClient) List 

func (client *LocationExtensionTypesClient) List(location string, options *LocationExtensionTypesClientListOptions) *LocationExtensionTypesClientListPager

List - List all Extension Types If the operation fails it returns an *azcore.ResponseError type. location - extension location options - LocationExtensionTypesClientListOptions contains the optional parameters for the LocationExtensionTypesClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/LocationExtensionTypes_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewLocationExtensionTypesClient("<subscription-id>", cred, nil)
	pager := client.List("<location>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type LocationExtensionTypesClientListOptions added in v0.2.0 

type LocationExtensionTypesClientListOptions struct {
}

LocationExtensionTypesClientListOptions contains the optional parameters for the LocationExtensionTypesClient.List method.

type LocationExtensionTypesClientListPager added in v0.2.0 

type LocationExtensionTypesClientListPager struct {
	// contains filtered or unexported fields
}

LocationExtensionTypesClientListPager provides operations for iterating over paged responses.

func (*LocationExtensionTypesClientListPager) Err added in v0.2.0 

func (p *LocationExtensionTypesClientListPager) Err() error

Err returns the last error encountered while paging.

func (*LocationExtensionTypesClientListPager) NextPage added in v0.2.0 

func (p *LocationExtensionTypesClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*LocationExtensionTypesClientListPager) PageResponse added in v0.2.0 

func (p *LocationExtensionTypesClientListPager) PageResponse() LocationExtensionTypesClientListResponse

PageResponse returns the current LocationExtensionTypesClientListResponse page.

type LocationExtensionTypesClientListResponse added in v0.2.0 

type LocationExtensionTypesClientListResponse struct {
	LocationExtensionTypesClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

LocationExtensionTypesClientListResponse contains the response from method LocationExtensionTypesClient.List.

type LocationExtensionTypesClientListResult added in v0.2.0 

type LocationExtensionTypesClientListResult struct {
	ExtensionTypeList
}

LocationExtensionTypesClientListResult contains the result from method LocationExtensionTypesClient.List.

type MessageLevelType 

type MessageLevelType string

MessageLevelType - Level of the message. 

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

func PossibleMessageLevelTypeValues 

func PossibleMessageLevelTypeValues() []MessageLevelType

PossibleMessageLevelTypeValues returns the possible values for the MessageLevelType const type.

func (MessageLevelType) ToPtr 

func (c MessageLevelType) ToPtr() *MessageLevelType

ToPtr returns a *MessageLevelType pointing to the current value.

type ObjectReferenceDefinition 

type ObjectReferenceDefinition struct {
	// Name of the object
	Name *string `json:"name,omitempty"`

	// Namespace of the object
	Namespace *string `json:"namespace,omitempty"`
}

ObjectReferenceDefinition - Object reference to a Kubernetes object on a cluster

type ObjectStatusConditionDefinition 

type ObjectStatusConditionDefinition struct {
	// Last time this status condition has changed
	LastTransitionTime *time.Time `json:"lastTransitionTime,omitempty"`

	// A more verbose description of the object status condition
	Message *string `json:"message,omitempty"`

	// Reason for the specified status condition type status
	Reason *string `json:"reason,omitempty"`

	// Status of the Kubernetes object condition type
	Status *string `json:"status,omitempty"`

	// Object status condition type for this object
	Type *string `json:"type,omitempty"`
}

ObjectStatusConditionDefinition - Status condition of Kubernetes object

func (ObjectStatusConditionDefinition) MarshalJSON 

func (o ObjectStatusConditionDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ObjectStatusConditionDefinition.

func (*ObjectStatusConditionDefinition) UnmarshalJSON 

func (o *ObjectStatusConditionDefinition) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ObjectStatusConditionDefinition.

type ObjectStatusDefinition 

type ObjectStatusDefinition struct {
	// Object reference to the Kustomization that applied this object
	AppliedBy *ObjectReferenceDefinition `json:"appliedBy,omitempty"`

	// Compliance state of the applied object showing whether the applied object has come into a ready state on the cluster.
	ComplianceState *FluxComplianceState `json:"complianceState,omitempty"`

	// Additional properties that are provided from objects of the HelmRelease kind
	HelmReleaseProperties *HelmReleasePropertiesDefinition `json:"helmReleaseProperties,omitempty"`

	// Kind of the applied object
	Kind *string `json:"kind,omitempty"`

	// Name of the applied object
	Name *string `json:"name,omitempty"`

	// Namespace of the applied object
	Namespace *string `json:"namespace,omitempty"`

	// List of Kubernetes object status conditions present on the cluster
	StatusConditions []*ObjectStatusConditionDefinition `json:"statusConditions,omitempty"`
}

ObjectStatusDefinition - Statuses of objects deployed by the user-specified kustomizations from the git repository.

func (ObjectStatusDefinition) MarshalJSON 

func (o ObjectStatusDefinition) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ObjectStatusDefinition.

type OperationStatusClient 

type OperationStatusClient struct {
	// contains filtered or unexported fields
}

OperationStatusClient contains the methods for the OperationStatus group. Don't use this type directly, use NewOperationStatusClient() instead.

func NewOperationStatusClient 

func NewOperationStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OperationStatusClient

NewOperationStatusClient creates a new instance of OperationStatusClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationStatusClient) Get 

func (client *OperationStatusClient) Get(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, extensionName string, operationID string, options *OperationStatusClientGetOptions) (OperationStatusClientGetResponse, error)

Get - Get Async Operation status If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. extensionName - Name of the Extension. operationID - operation Id options - OperationStatusClientGetOptions contains the optional parameters for the OperationStatusClient.Get method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/GetExtensionAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewOperationStatusClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<extension-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.OperationStatusClientGetResult)
}

Output:

func (*OperationStatusClient) List 

func (client *OperationStatusClient) List(resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, options *OperationStatusClientListOptions) *OperationStatusClientListPager

List - List Async Operations, currently in progress, in a cluster If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. options - OperationStatusClientListOptions contains the optional parameters for the OperationStatusClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ListAsyncOperationStatus.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewOperationStatusClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type OperationStatusClientGetOptions added in v0.2.0 

type OperationStatusClientGetOptions struct {
}

OperationStatusClientGetOptions contains the optional parameters for the OperationStatusClient.Get method.

type OperationStatusClientGetResponse added in v0.2.0 

type OperationStatusClientGetResponse struct {
	OperationStatusClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationStatusClientGetResponse contains the response from method OperationStatusClient.Get.

type OperationStatusClientGetResult added in v0.2.0 

type OperationStatusClientGetResult struct {
	OperationStatusResult
}

OperationStatusClientGetResult contains the result from method OperationStatusClient.Get.

type OperationStatusClientListOptions added in v0.2.0 

type OperationStatusClientListOptions struct {
}

OperationStatusClientListOptions contains the optional parameters for the OperationStatusClient.List method.

type OperationStatusClientListPager added in v0.2.0 

type OperationStatusClientListPager struct {
	// contains filtered or unexported fields
}

OperationStatusClientListPager provides operations for iterating over paged responses.

func (*OperationStatusClientListPager) Err added in v0.2.0 

func (p *OperationStatusClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationStatusClientListPager) NextPage added in v0.2.0 

func (p *OperationStatusClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationStatusClientListPager) PageResponse added in v0.2.0 

func (p *OperationStatusClientListPager) PageResponse() OperationStatusClientListResponse

PageResponse returns the current OperationStatusClientListResponse page.

type OperationStatusClientListResponse added in v0.2.0 

type OperationStatusClientListResponse struct {
	OperationStatusClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationStatusClientListResponse contains the response from method OperationStatusClient.List.

type OperationStatusClientListResult added in v0.2.0 

type OperationStatusClientListResult struct {
	OperationStatusList
}

OperationStatusClientListResult contains the result from method OperationStatusClient.List.

type OperationStatusList 

type OperationStatusList struct {
	// READ-ONLY; URL to get the next set of Operation Result objects, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of async operations in progress, in the cluster.
	Value []*OperationStatusResult `json:"value,omitempty" azure:"ro"`
}

OperationStatusList - The async operations in progress, in the cluster.

func (OperationStatusList) MarshalJSON 

func (o OperationStatusList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationStatusList.

type OperationStatusResult 

type OperationStatusResult struct {
	// REQUIRED; Operation status.
	Status *string `json:"status,omitempty"`

	// Fully qualified ID for the async operation.
	ID *string `json:"id,omitempty"`

	// Name of the async operation.
	Name *string `json:"name,omitempty"`

	// Additional information, if available.
	Properties map[string]*string `json:"properties,omitempty"`

	// READ-ONLY; If present, details of the operation error.
	Error *ErrorDetail `json:"error,omitempty" azure:"ro"`
}

OperationStatusResult - The current status of an async operation.

func (OperationStatusResult) MarshalJSON 

func (o OperationStatusResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationStatusResult.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - List all the available operations the KubernetesConfiguration resource provider supports. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/OperationsList.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListPager added in v0.2.0 

type OperationsClientListPager struct {
	// contains filtered or unexported fields
}

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.2.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.2.0 

func (p *OperationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsClientListPager) PageResponse added in v0.2.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.2.0 

type OperationsClientListResult struct {
	ResourceProviderOperationList
}

OperationsClientListResult contains the result from method OperationsClient.List.

type OperatorScopeType 

type OperatorScopeType string

OperatorScopeType - Scope at which the operator will be installed. 

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

func PossibleOperatorScopeTypeValues 

func PossibleOperatorScopeTypeValues() []OperatorScopeType

PossibleOperatorScopeTypeValues returns the possible values for the OperatorScopeType const type.

func (OperatorScopeType) ToPtr 

func (c OperatorScopeType) ToPtr() *OperatorScopeType

ToPtr returns a *OperatorScopeType pointing to the current value.

type OperatorType 

type OperatorType string

OperatorType - Type of the operator 

const (
	OperatorTypeFlux OperatorType = "Flux"
)

func PossibleOperatorTypeValues 

func PossibleOperatorTypeValues() []OperatorType

PossibleOperatorTypeValues returns the possible values for the OperatorType const type.

func (OperatorType) ToPtr 

func (c OperatorType) ToPtr() *OperatorType

ToPtr returns a *OperatorType pointing to the current value.

type PatchExtension 

type PatchExtension struct {
	// Updatable properties of an Extension Patch Request
	Properties *PatchExtensionProperties `json:"properties,omitempty"`
}

PatchExtension - The Extension Patch Request object.

func (PatchExtension) MarshalJSON 

func (p PatchExtension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchExtension.

type PatchExtensionProperties 

type PatchExtensionProperties struct {
	// Flag to note if this extension participates in auto upgrade of minor version, or not.
	AutoUpgradeMinorVersion *bool `json:"autoUpgradeMinorVersion,omitempty"`

	// Configuration settings that are sensitive, as name-value pairs for configuring this extension.
	ConfigurationProtectedSettings map[string]*string `json:"configurationProtectedSettings,omitempty"`

	// Configuration settings, as name-value pairs for configuring this extension.
	ConfigurationSettings map[string]*string `json:"configurationSettings,omitempty"`

	// ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion
	// is 'true'.
	ReleaseTrain *string `json:"releaseTrain,omitempty"`

	// Version of the extension for this extension, if it is 'pinned' to a specific version. autoUpgradeMinorVersion must be 'false'.
	Version *string `json:"version,omitempty"`
}

PatchExtensionProperties - Updatable properties of an Extension Patch Request

func (PatchExtensionProperties) MarshalJSON 

func (p PatchExtensionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchExtensionProperties.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The provisioning state of the resource. 

const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr 

func (c ProvisioningState) ToPtr() *ProvisioningState

ToPtr returns a *ProvisioningState pointing to the current value.

type ProvisioningStateType 

type ProvisioningStateType string

ProvisioningStateType - The provisioning state of the resource provider. 

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

func PossibleProvisioningStateTypeValues 

func PossibleProvisioningStateTypeValues() []ProvisioningStateType

PossibleProvisioningStateTypeValues returns the possible values for the ProvisioningStateType const type.

func (ProvisioningStateType) ToPtr 

func (c ProvisioningStateType) ToPtr() *ProvisioningStateType

ToPtr returns a *ProvisioningStateType pointing to the current value.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type RepositoryRefDefinition 

type RepositoryRefDefinition struct {
	// The git repository branch name to checkout.
	Branch *string `json:"branch,omitempty"`

	// The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver.
	Commit *string `json:"commit,omitempty"`

	// The semver range used to match against git repository tags. This takes precedence over tag.
	Semver *string `json:"semver,omitempty"`

	// The git repository tag name to checkout. This takes precedence over branch.
	Tag *string `json:"tag,omitempty"`
}

RepositoryRefDefinition - The source reference for the GitRepository object.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

type ResourceProviderOperation 

type ResourceProviderOperation struct {
	// Display metadata associated with the operation.
	Display *ResourceProviderOperationDisplay `json:"display,omitempty"`

	// Operation name, in format of {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`

	// READ-ONLY; The flag that indicates whether the operation applies to data plane.
	IsDataAction *bool `json:"isDataAction,omitempty" azure:"ro"`

	// READ-ONLY; Origin of the operation
	Origin *string `json:"origin,omitempty" azure:"ro"`
}

ResourceProviderOperation - Supported operation of this resource provider.

type ResourceProviderOperationDisplay 

type ResourceProviderOperationDisplay struct {
	// Description of this operation.
	Description *string `json:"description,omitempty"`

	// Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Resource provider: Microsoft KubernetesConfiguration.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

ResourceProviderOperationDisplay - Display metadata associated with the operation.

type ResourceProviderOperationList 

type ResourceProviderOperationList struct {
	// List of operations supported by this resource provider.
	Value []*ResourceProviderOperation `json:"value,omitempty"`

	// READ-ONLY; URL to the next set of results, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ResourceProviderOperationList - Result of the request to list operations.

func (ResourceProviderOperationList) MarshalJSON 

func (r ResourceProviderOperationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceProviderOperationList.

type Scope 

type Scope struct {
	// Specifies that the scope of the extension is Cluster
	Cluster *ScopeCluster `json:"cluster,omitempty"`

	// Specifies that the scope of the extension is Namespace
	Namespace *ScopeNamespace `json:"namespace,omitempty"`
}

Scope of the extension. It can be either Cluster or Namespace; but not both.

type ScopeCluster 

type ScopeCluster struct {
	// Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist,
	// it will be created
	ReleaseNamespace *string `json:"releaseNamespace,omitempty"`
}

ScopeCluster - Specifies that the scope of the extension is Cluster

type ScopeNamespace 

type ScopeNamespace struct {
	// Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will
	// be created
	TargetNamespace *string `json:"targetNamespace,omitempty"`
}

ScopeNamespace - Specifies that the scope of the extension is Namespace

type ScopeType 

type ScopeType string

ScopeType - Scope at which the configuration will be installed. 

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

func PossibleScopeTypeValues 

func PossibleScopeTypeValues() []ScopeType

PossibleScopeTypeValues returns the possible values for the ScopeType const type.

func (ScopeType) ToPtr 

func (c ScopeType) ToPtr() *ScopeType

ToPtr returns a *ScopeType pointing to the current value.

type SourceControlConfiguration 

type SourceControlConfiguration struct {
	// Properties to create a Source Control Configuration resource
	Properties *SourceControlConfigurationProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SourceControlConfiguration - The SourceControl Configuration object returned in Get & Put response.

type SourceControlConfigurationList 

type SourceControlConfigurationList struct {
	// READ-ONLY; URL to get the next set of configuration objects, if any.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of Source Control Configurations within a Kubernetes cluster.
	Value []*SourceControlConfiguration `json:"value,omitempty" azure:"ro"`
}

SourceControlConfigurationList - Result of the request to list Source Control Configurations. It contains a list of SourceControlConfiguration objects and a URL link to get the next set of results.

func (SourceControlConfigurationList) MarshalJSON 

func (s SourceControlConfigurationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlConfigurationList.

type SourceControlConfigurationProperties 

type SourceControlConfigurationProperties struct {
	// Name-value pairs of protected configuration settings for the configuration
	ConfigurationProtectedSettings map[string]*string `json:"configurationProtectedSettings,omitempty"`

	// Option to enable Helm Operator for this git configuration.
	EnableHelmOperator *bool `json:"enableHelmOperator,omitempty"`

	// Properties for Helm operator.
	HelmOperatorProperties *HelmOperatorProperties `json:"helmOperatorProperties,omitempty"`

	// Instance name of the operator - identifying the specific configuration.
	OperatorInstanceName *string `json:"operatorInstanceName,omitempty"`

	// The namespace to which this operator is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period
	// only.
	OperatorNamespace *string `json:"operatorNamespace,omitempty"`

	// Any Parameters for the Operator instance in string format.
	OperatorParams *string `json:"operatorParams,omitempty"`

	// Scope at which the operator will be installed.
	OperatorScope *OperatorScopeType `json:"operatorScope,omitempty"`

	// Type of the operator
	OperatorType *OperatorType `json:"operatorType,omitempty"`

	// Url of the SourceControl Repository.
	RepositoryURL *string `json:"repositoryUrl,omitempty"`

	// Base64-encoded known_hosts contents containing public SSH keys required to access private Git instances
	SSHKnownHostsContents *string `json:"sshKnownHostsContents,omitempty"`

	// READ-ONLY; Compliance Status of the Configuration
	ComplianceStatus *ComplianceStatus `json:"complianceStatus,omitempty" azure:"ro"`

	// READ-ONLY; The provisioning state of the resource provider.
	ProvisioningState *ProvisioningStateType `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Public Key associated with this SourceControl configuration (either generated within the cluster or provided
	// by the user).
	RepositoryPublicKey *string `json:"repositoryPublicKey,omitempty" azure:"ro"`
}

SourceControlConfigurationProperties - Properties to create a Source Control Configuration resource

func (SourceControlConfigurationProperties) MarshalJSON 

func (s SourceControlConfigurationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SourceControlConfigurationProperties.

type SourceControlConfigurationsClient 

type SourceControlConfigurationsClient struct {
	// contains filtered or unexported fields
}

SourceControlConfigurationsClient contains the methods for the SourceControlConfigurations group. Don't use this type directly, use NewSourceControlConfigurationsClient() instead.

func NewSourceControlConfigurationsClient 

func NewSourceControlConfigurationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SourceControlConfigurationsClient

NewSourceControlConfigurationsClient creates a new instance of SourceControlConfigurationsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SourceControlConfigurationsClient) BeginDelete 

func (client *SourceControlConfigurationsClient) BeginDelete(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, sourceControlConfigurationName string, options *SourceControlConfigurationsClientBeginDeleteOptions) (SourceControlConfigurationsClientDeletePollerResponse, error)

BeginDelete - This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. sourceControlConfigurationName - Name of the Source Control Configuration. options - SourceControlConfigurationsClientBeginDeleteOptions contains the optional parameters for the SourceControlConfigurationsClient.BeginDelete method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/DeleteSourceControlConfiguration.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewSourceControlConfigurationsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<source-control-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SourceControlConfigurationsClient) CreateOrUpdate 

func (client *SourceControlConfigurationsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, sourceControlConfigurationName string, sourceControlConfiguration SourceControlConfiguration, options *SourceControlConfigurationsClientCreateOrUpdateOptions) (SourceControlConfigurationsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a new Kubernetes Source Control Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. sourceControlConfigurationName - Name of the Source Control Configuration. sourceControlConfiguration - Properties necessary to Create KubernetesConfiguration. options - SourceControlConfigurationsClientCreateOrUpdateOptions contains the optional parameters for the SourceControlConfigurationsClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/CreateSourceControlConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewSourceControlConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<source-control-configuration-name>",
		armkubernetesconfiguration.SourceControlConfiguration{
			Properties: &armkubernetesconfiguration.SourceControlConfigurationProperties{
				ConfigurationProtectedSettings: map[string]*string{
					"protectedSetting1Key": to.StringPtr("protectedSetting1Value"),
				},
				EnableHelmOperator: to.BoolPtr(true),
				HelmOperatorProperties: &armkubernetesconfiguration.HelmOperatorProperties{
					ChartValues:  to.StringPtr("<chart-values>"),
					ChartVersion: to.StringPtr("<chart-version>"),
				},
				OperatorInstanceName:  to.StringPtr("<operator-instance-name>"),
				OperatorNamespace:     to.StringPtr("<operator-namespace>"),
				OperatorParams:        to.StringPtr("<operator-params>"),
				OperatorScope:         armkubernetesconfiguration.OperatorScopeType("namespace").ToPtr(),
				OperatorType:          armkubernetesconfiguration.OperatorType("Flux").ToPtr(),
				RepositoryURL:         to.StringPtr("<repository-url>"),
				SSHKnownHostsContents: to.StringPtr("<sshknown-hosts-contents>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SourceControlConfigurationsClientCreateOrUpdateResult)
}

Output:

func (*SourceControlConfigurationsClient) Get 

func (client *SourceControlConfigurationsClient) Get(ctx context.Context, resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, sourceControlConfigurationName string, options *SourceControlConfigurationsClientGetOptions) (SourceControlConfigurationsClientGetResponse, error)

Get - Gets details of the Source Control Configuration. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. sourceControlConfigurationName - Name of the Source Control Configuration. options - SourceControlConfigurationsClientGetOptions contains the optional parameters for the SourceControlConfigurationsClient.Get method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/GetSourceControlConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewSourceControlConfigurationsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		"<source-control-configuration-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SourceControlConfigurationsClientGetResult)
}

Output:

func (*SourceControlConfigurationsClient) List 

func (client *SourceControlConfigurationsClient) List(resourceGroupName string, clusterRp Enum0, clusterResourceName Enum1, clusterName string, options *SourceControlConfigurationsClientListOptions) *SourceControlConfigurationsClientListPager

List - List all Source Control Configurations. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. clusterRp - The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters). clusterResourceName - The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters). clusterName - The name of the kubernetes cluster. options - SourceControlConfigurationsClientListOptions contains the optional parameters for the SourceControlConfigurationsClient.List method.

Example

x-ms-original-file: specification/kubernetesconfiguration/resource-manager/Microsoft.KubernetesConfiguration/preview/2022-01-01-preview/examples/ListSourceControlConfiguration.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/kubernetesconfiguration/armkubernetesconfiguration"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkubernetesconfiguration.NewSourceControlConfigurationsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		armkubernetesconfiguration.Enum0("Microsoft.Kubernetes"),
		armkubernetesconfiguration.Enum1("connectedClusters"),
		"<cluster-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type SourceControlConfigurationsClientBeginDeleteOptions added in v0.2.0 

type SourceControlConfigurationsClientBeginDeleteOptions struct {
}

SourceControlConfigurationsClientBeginDeleteOptions contains the optional parameters for the SourceControlConfigurationsClient.BeginDelete method.

type SourceControlConfigurationsClientCreateOrUpdateOptions added in v0.2.0 

type SourceControlConfigurationsClientCreateOrUpdateOptions struct {
}

SourceControlConfigurationsClientCreateOrUpdateOptions contains the optional parameters for the SourceControlConfigurationsClient.CreateOrUpdate method.

type SourceControlConfigurationsClientCreateOrUpdateResponse added in v0.2.0 

type SourceControlConfigurationsClientCreateOrUpdateResponse struct {
	SourceControlConfigurationsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SourceControlConfigurationsClientCreateOrUpdateResponse contains the response from method SourceControlConfigurationsClient.CreateOrUpdate.

type SourceControlConfigurationsClientCreateOrUpdateResult added in v0.2.0 

type SourceControlConfigurationsClientCreateOrUpdateResult struct {
	SourceControlConfiguration
}

SourceControlConfigurationsClientCreateOrUpdateResult contains the result from method SourceControlConfigurationsClient.CreateOrUpdate.

type SourceControlConfigurationsClientDeletePoller added in v0.2.0 

type SourceControlConfigurationsClientDeletePoller struct {
	// contains filtered or unexported fields
}

SourceControlConfigurationsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*SourceControlConfigurationsClientDeletePoller) Done added in v0.2.0 

func (p *SourceControlConfigurationsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*SourceControlConfigurationsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *SourceControlConfigurationsClientDeletePoller) FinalResponse(ctx context.Context) (SourceControlConfigurationsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final SourceControlConfigurationsClientDeleteResponse will be returned.

func (*SourceControlConfigurationsClientDeletePoller) Poll added in v0.2.0 

func (p *SourceControlConfigurationsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*SourceControlConfigurationsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *SourceControlConfigurationsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type SourceControlConfigurationsClientDeletePollerResponse added in v0.2.0 

type SourceControlConfigurationsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *SourceControlConfigurationsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SourceControlConfigurationsClientDeletePollerResponse contains the response from method SourceControlConfigurationsClient.Delete.

func (SourceControlConfigurationsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l SourceControlConfigurationsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (SourceControlConfigurationsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*SourceControlConfigurationsClientDeletePollerResponse) Resume added in v0.2.0 

func (l *SourceControlConfigurationsClientDeletePollerResponse) Resume(ctx context.Context, client *SourceControlConfigurationsClient, token string) error

Resume rehydrates a SourceControlConfigurationsClientDeletePollerResponse from the provided client and resume token.

type SourceControlConfigurationsClientDeleteResponse added in v0.2.0 

type SourceControlConfigurationsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SourceControlConfigurationsClientDeleteResponse contains the response from method SourceControlConfigurationsClient.Delete.

type SourceControlConfigurationsClientGetOptions added in v0.2.0 

type SourceControlConfigurationsClientGetOptions struct {
}

SourceControlConfigurationsClientGetOptions contains the optional parameters for the SourceControlConfigurationsClient.Get method.

type SourceControlConfigurationsClientGetResponse added in v0.2.0 

type SourceControlConfigurationsClientGetResponse struct {
	SourceControlConfigurationsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SourceControlConfigurationsClientGetResponse contains the response from method SourceControlConfigurationsClient.Get.

type SourceControlConfigurationsClientGetResult added in v0.2.0 

type SourceControlConfigurationsClientGetResult struct {
	SourceControlConfiguration
}

SourceControlConfigurationsClientGetResult contains the result from method SourceControlConfigurationsClient.Get.

type SourceControlConfigurationsClientListOptions added in v0.2.0 

type SourceControlConfigurationsClientListOptions struct {
}

SourceControlConfigurationsClientListOptions contains the optional parameters for the SourceControlConfigurationsClient.List method.

type SourceControlConfigurationsClientListPager added in v0.2.0 

type SourceControlConfigurationsClientListPager struct {
	// contains filtered or unexported fields
}

SourceControlConfigurationsClientListPager provides operations for iterating over paged responses.

func (*SourceControlConfigurationsClientListPager) Err added in v0.2.0 

func (p *SourceControlConfigurationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*SourceControlConfigurationsClientListPager) NextPage added in v0.2.0 

func (p *SourceControlConfigurationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SourceControlConfigurationsClientListPager) PageResponse added in v0.2.0 

func (p *SourceControlConfigurationsClientListPager) PageResponse() SourceControlConfigurationsClientListResponse

PageResponse returns the current SourceControlConfigurationsClientListResponse page.

type SourceControlConfigurationsClientListResponse added in v0.2.0 

type SourceControlConfigurationsClientListResponse struct {
	SourceControlConfigurationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SourceControlConfigurationsClientListResponse contains the response from method SourceControlConfigurationsClient.List.

type SourceControlConfigurationsClientListResult added in v0.2.0 

type SourceControlConfigurationsClientListResult struct {
	SourceControlConfigurationList
}

SourceControlConfigurationsClientListResult contains the result from method SourceControlConfigurationsClient.List.

type SourceKindType 

type SourceKindType string

SourceKindType - Source Kind to pull the configuration data from. 

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

func PossibleSourceKindTypeValues 

func PossibleSourceKindTypeValues() []SourceKindType

PossibleSourceKindTypeValues returns the possible values for the SourceKindType const type.

func (SourceKindType) ToPtr 

func (c SourceKindType) ToPtr() *SourceKindType

ToPtr returns a *SourceKindType pointing to the current value.

type SupportedScopes 

type SupportedScopes struct {
	// Scope settings
	ClusterScopeSettings *ClusterScopeSettings `json:"clusterScopeSettings,omitempty"`

	// Default extension scopes: cluster or namespace
	DefaultScope *string `json:"defaultScope,omitempty"`
}

SupportedScopes - Extension scopes

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

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.