managedclustersnapshots

package
v0.20240424.1114424 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerservice/2023-06-02-preview/managedclustersnapshots Documentation

The managedclustersnapshots SDK allows for interaction with the Azure Resource Manager Service containerservice (API Version 2023-06-02-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/containerservice/2023-06-02-preview/managedclustersnapshots"

Client Initialization

client := managedclustersnapshots.NewManagedClusterSnapshotsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedClusterSnapshotsClient.CreateOrUpdate

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

payload := managedclustersnapshots.ManagedClusterSnapshot{
	// ...
}


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

Example Usage: ManagedClusterSnapshotsClient.Delete

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

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

Example Usage: ManagedClusterSnapshotsClient.Get

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

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

Example Usage: ManagedClusterSnapshotsClient.List

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

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

Example Usage: ManagedClusterSnapshotsClient.ListByResourceGroup

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

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

Example Usage: ManagedClusterSnapshotsClient.UpdateTags

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

payload := managedclustersnapshots.TagsObject{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForLoadBalancerSku

func PossibleValuesForLoadBalancerSku() []string

func PossibleValuesForManagedClusterSKUName

func PossibleValuesForManagedClusterSKUName() []string

func PossibleValuesForManagedClusterSKUTier

func PossibleValuesForManagedClusterSKUTier() []string

func PossibleValuesForNetworkMode

func PossibleValuesForNetworkMode() []string

func PossibleValuesForNetworkPlugin

func PossibleValuesForNetworkPlugin() []string

func PossibleValuesForNetworkPluginMode

func PossibleValuesForNetworkPluginMode() []string

func PossibleValuesForNetworkPolicy

func PossibleValuesForNetworkPolicy() []string

func PossibleValuesForSnapshotType

func PossibleValuesForSnapshotType() []string

func ValidateManagedClusterSnapshotID

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

ValidateManagedClusterSnapshotID checks that 'input' can be parsed as a Managed Cluster Snapshot ID

Types

type CreateOrUpdateOperationResponse

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

type CreationData

type CreationData struct {
	SourceResourceId *string `json:"sourceResourceId,omitempty"`
}

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type LoadBalancerSku

type LoadBalancerSku string
const (
	LoadBalancerSkuBasic    LoadBalancerSku = "basic"
	LoadBalancerSkuStandard LoadBalancerSku = "standard"
)

func (*LoadBalancerSku) UnmarshalJSON added in v0.20240213.1120950

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

type ManagedClusterPropertiesForSnapshot

type ManagedClusterPropertiesForSnapshot struct {
	EnableRbac        *bool                      `json:"enableRbac,omitempty"`
	KubernetesVersion *string                    `json:"kubernetesVersion,omitempty"`
	NetworkProfile    *NetworkProfileForSnapshot `json:"networkProfile,omitempty"`
	Sku               *ManagedClusterSKU         `json:"sku,omitempty"`
}

type ManagedClusterSKU

type ManagedClusterSKU struct {
	Name *ManagedClusterSKUName `json:"name,omitempty"`
	Tier *ManagedClusterSKUTier `json:"tier,omitempty"`
}

type ManagedClusterSKUName

type ManagedClusterSKUName string
const (
	ManagedClusterSKUNameBase ManagedClusterSKUName = "Base"
)

func (*ManagedClusterSKUName) UnmarshalJSON added in v0.20240213.1120950

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

type ManagedClusterSKUTier

type ManagedClusterSKUTier string
const (
	ManagedClusterSKUTierFree     ManagedClusterSKUTier = "Free"
	ManagedClusterSKUTierPremium  ManagedClusterSKUTier = "Premium"
	ManagedClusterSKUTierStandard ManagedClusterSKUTier = "Standard"
)

func (*ManagedClusterSKUTier) UnmarshalJSON added in v0.20240213.1120950

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

type ManagedClusterSnapshot

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

type ManagedClusterSnapshotId

type ManagedClusterSnapshotId struct {
	SubscriptionId             string
	ResourceGroupName          string
	ManagedClusterSnapshotName string
}

ManagedClusterSnapshotId is a struct representing the Resource ID for a Managed Cluster Snapshot

func NewManagedClusterSnapshotID

func NewManagedClusterSnapshotID(subscriptionId string, resourceGroupName string, managedClusterSnapshotName string) ManagedClusterSnapshotId

NewManagedClusterSnapshotID returns a new ManagedClusterSnapshotId struct

func ParseManagedClusterSnapshotID

func ParseManagedClusterSnapshotID(input string) (*ManagedClusterSnapshotId, error)

ParseManagedClusterSnapshotID parses 'input' into a ManagedClusterSnapshotId

func ParseManagedClusterSnapshotIDInsensitively

func ParseManagedClusterSnapshotIDInsensitively(input string) (*ManagedClusterSnapshotId, error)

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

func (*ManagedClusterSnapshotId) FromParseResult

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

func (ManagedClusterSnapshotId) ID

ID returns the formatted Managed Cluster Snapshot ID

func (ManagedClusterSnapshotId) Segments

Segments returns a slice of Resource ID Segments which comprise this Managed Cluster Snapshot ID

func (ManagedClusterSnapshotId) String

func (id ManagedClusterSnapshotId) String() string

String returns a human-readable description of this Managed Cluster Snapshot ID

type ManagedClusterSnapshotOperationPredicate

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

func (ManagedClusterSnapshotOperationPredicate) Matches

type ManagedClusterSnapshotProperties

type ManagedClusterSnapshotProperties struct {
	CreationData                     *CreationData                        `json:"creationData,omitempty"`
	ManagedClusterPropertiesReadOnly *ManagedClusterPropertiesForSnapshot `json:"managedClusterPropertiesReadOnly,omitempty"`
	SnapshotType                     *SnapshotType                        `json:"snapshotType,omitempty"`
}

type ManagedClusterSnapshotsClient

type ManagedClusterSnapshotsClient struct {
	Client *resourcemanager.Client
}

func NewManagedClusterSnapshotsClientWithBaseURI

func NewManagedClusterSnapshotsClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedClusterSnapshotsClient, error)

func (ManagedClusterSnapshotsClient) CreateOrUpdate

CreateOrUpdate ...

func (ManagedClusterSnapshotsClient) Delete

Delete ...

func (ManagedClusterSnapshotsClient) Get

Get ...

func (ManagedClusterSnapshotsClient) List

List ...

func (ManagedClusterSnapshotsClient) ListByResourceGroup

ListByResourceGroup ...

func (ManagedClusterSnapshotsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ManagedClusterSnapshotsClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedClusterSnapshotsClient) ListComplete

ListComplete retrieves all the results into a single object

func (ManagedClusterSnapshotsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ManagedClusterSnapshotsClient) UpdateTags

UpdateTags ...

type NetworkMode

type NetworkMode string
const (
	NetworkModeBridge      NetworkMode = "bridge"
	NetworkModeTransparent NetworkMode = "transparent"
)

func (*NetworkMode) UnmarshalJSON added in v0.20240213.1120950

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

type NetworkPlugin

type NetworkPlugin string
const (
	NetworkPluginAzure   NetworkPlugin = "azure"
	NetworkPluginKubenet NetworkPlugin = "kubenet"
	NetworkPluginNone    NetworkPlugin = "none"
)

func (*NetworkPlugin) UnmarshalJSON added in v0.20240213.1120950

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

type NetworkPluginMode

type NetworkPluginMode string
const (
	NetworkPluginModeOverlay NetworkPluginMode = "overlay"
)

func (*NetworkPluginMode) UnmarshalJSON added in v0.20240213.1120950

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

type NetworkPolicy

type NetworkPolicy string
const (
	NetworkPolicyAzure  NetworkPolicy = "azure"
	NetworkPolicyCalico NetworkPolicy = "calico"
	NetworkPolicyCilium NetworkPolicy = "cilium"
)

func (*NetworkPolicy) UnmarshalJSON added in v0.20240213.1120950

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

type NetworkProfileForSnapshot

type NetworkProfileForSnapshot struct {
	LoadBalancerSku   *LoadBalancerSku   `json:"loadBalancerSku,omitempty"`
	NetworkMode       *NetworkMode       `json:"networkMode,omitempty"`
	NetworkPlugin     *NetworkPlugin     `json:"networkPlugin,omitempty"`
	NetworkPluginMode *NetworkPluginMode `json:"networkPluginMode,omitempty"`
	NetworkPolicy     *NetworkPolicy     `json:"networkPolicy,omitempty"`
}

type SnapshotType

type SnapshotType string
const (
	SnapshotTypeManagedCluster SnapshotType = "ManagedCluster"
	SnapshotTypeNodePool       SnapshotType = "NodePool"
)

func (*SnapshotType) UnmarshalJSON added in v0.20240213.1120950

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

type TagsObject

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedClusterSnapshot
}

Jump to

Keyboard shortcuts

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