managedcluster

package
v0.20230202.1112019 Latest Latest
Warning

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

Go to latest
Published: Feb 2, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicefabricmanagedcluster/2022-01-01/managedcluster Documentation

The managedcluster SDK allows for interaction with the Azure Resource Manager Service servicefabricmanagedcluster (API Version 2022-01-01).

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

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/servicefabricmanagedcluster/2022-01-01/managedcluster"

Client Initialization

client := managedcluster.NewManagedClusterClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedClusterClient.CreateOrUpdate

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

payload := managedcluster.ManagedCluster{
	// ...
}


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

Example Usage: ManagedClusterClient.Delete

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

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

Example Usage: ManagedClusterClient.Get

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

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

ctx := context.TODO()
id := managedcluster.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: ManagedClusterClient.ListBySubscription

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

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

Example Usage: ManagedClusterClient.Update

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

payload := managedcluster.ManagedClusterUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccess

func PossibleValuesForAccess() []string

func PossibleValuesForAddonFeatures

func PossibleValuesForAddonFeatures() []string

func PossibleValuesForClusterState

func PossibleValuesForClusterState() []string

func PossibleValuesForClusterUpgradeCadence

func PossibleValuesForClusterUpgradeCadence() []string

func PossibleValuesForClusterUpgradeMode

func PossibleValuesForClusterUpgradeMode() []string

func PossibleValuesForDirection

func PossibleValuesForDirection() []string

func PossibleValuesForManagedResourceProvisioningState

func PossibleValuesForManagedResourceProvisioningState() []string

func PossibleValuesForNsgProtocol

func PossibleValuesForNsgProtocol() []string

func PossibleValuesForPrivateEndpointNetworkPolicies

func PossibleValuesForPrivateEndpointNetworkPolicies() []string

func PossibleValuesForPrivateLinkServiceNetworkPolicies

func PossibleValuesForPrivateLinkServiceNetworkPolicies() []string

func PossibleValuesForProbeProtocol

func PossibleValuesForProbeProtocol() []string

func PossibleValuesForProtocol

func PossibleValuesForProtocol() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func ValidateManagedClusterID

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

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

Types

type Access

type Access string
const (
	AccessAllow Access = "allow"
	AccessDeny  Access = "deny"
)

type AddonFeatures

type AddonFeatures string
const (
	AddonFeaturesBackupRestoreService   AddonFeatures = "BackupRestoreService"
	AddonFeaturesDnsService             AddonFeatures = "DnsService"
	AddonFeaturesResourceMonitorService AddonFeatures = "ResourceMonitorService"
)

type ApplicationTypeVersionsCleanupPolicy

type ApplicationTypeVersionsCleanupPolicy struct {
	MaxUnusedVersionsToKeep int64 `json:"maxUnusedVersionsToKeep"`
}

type AzureActiveDirectory

type AzureActiveDirectory struct {
	ClientApplication  *string `json:"clientApplication,omitempty"`
	ClusterApplication *string `json:"clusterApplication,omitempty"`
	TenantId           *string `json:"tenantId,omitempty"`
}

type ClientCertificate

type ClientCertificate struct {
	CommonName       *string `json:"commonName,omitempty"`
	IsAdmin          bool    `json:"isAdmin"`
	IssuerThumbprint *string `json:"issuerThumbprint,omitempty"`
	Thumbprint       *string `json:"thumbprint,omitempty"`
}

type ClusterState

type ClusterState string
const (
	ClusterStateBaselineUpgrade ClusterState = "BaselineUpgrade"
	ClusterStateDeploying       ClusterState = "Deploying"
	ClusterStateReady           ClusterState = "Ready"
	ClusterStateUpgradeFailed   ClusterState = "UpgradeFailed"
	ClusterStateUpgrading       ClusterState = "Upgrading"
	ClusterStateWaitingForNodes ClusterState = "WaitingForNodes"
)

type ClusterUpgradeCadence

type ClusterUpgradeCadence string
const (
	ClusterUpgradeCadenceWaveOne  ClusterUpgradeCadence = "Wave1"
	ClusterUpgradeCadenceWaveTwo  ClusterUpgradeCadence = "Wave2"
	ClusterUpgradeCadenceWaveZero ClusterUpgradeCadence = "Wave0"
)

type ClusterUpgradeMode

type ClusterUpgradeMode string
const (
	ClusterUpgradeModeAutomatic ClusterUpgradeMode = "Automatic"
	ClusterUpgradeModeManual    ClusterUpgradeMode = "Manual"
)

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type Direction

type Direction string
const (
	DirectionInbound  Direction = "inbound"
	DirectionOutbound Direction = "outbound"
)

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *ManagedCluster
}

type IPTag

type IPTag struct {
	IPTagType string `json:"ipTagType"`
	Tag       string `json:"tag"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []ManagedCluster
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ManagedCluster
	// contains filtered or unexported fields
}

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []ManagedCluster
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]ManagedCluster
	// contains filtered or unexported fields
}

func (ListBySubscriptionOperationResponse) HasMore

func (ListBySubscriptionOperationResponse) LoadMore

type LoadBalancingRule

type LoadBalancingRule struct {
	BackendPort      int64         `json:"backendPort"`
	FrontendPort     int64         `json:"frontendPort"`
	LoadDistribution *string       `json:"loadDistribution,omitempty"`
	ProbePort        *int64        `json:"probePort,omitempty"`
	ProbeProtocol    ProbeProtocol `json:"probeProtocol"`
	ProbeRequestPath *string       `json:"probeRequestPath,omitempty"`
	Protocol         Protocol      `json:"protocol"`
}

type ManagedCluster

type ManagedCluster struct {
	Etag       *string                   `json:"etag,omitempty"`
	Id         *string                   `json:"id,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties *ManagedClusterProperties `json:"properties,omitempty"`
	Sku        *Sku                      `json:"sku,omitempty"`
	SystemData *SystemData               `json:"systemData,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type ManagedClusterClient

type ManagedClusterClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewManagedClusterClientWithBaseURI

func NewManagedClusterClientWithBaseURI(endpoint string) ManagedClusterClient

func (ManagedClusterClient) CreateOrUpdate

CreateOrUpdate ...

func (ManagedClusterClient) CreateOrUpdateThenPoll

func (c ManagedClusterClient) CreateOrUpdateThenPoll(ctx context.Context, id ManagedClusterId, input ManagedCluster) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedClusterClient) Delete

Delete ...

func (ManagedClusterClient) DeleteThenPoll

func (c ManagedClusterClient) DeleteThenPoll(ctx context.Context, id ManagedClusterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedClusterClient) Get

Get ...

func (ManagedClusterClient) ListByResourceGroup

ListByResourceGroup ...

func (ManagedClusterClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (ManagedClusterClient) ListByResourceGroupCompleteMatchingPredicate

func (c ManagedClusterClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ManagedClusterOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedClusterClient) ListBySubscription

ListBySubscription ...

func (ManagedClusterClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all of the results into a single object

func (ManagedClusterClient) ListBySubscriptionCompleteMatchingPredicate

func (c ManagedClusterClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ManagedClusterOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ManagedClusterClient) Update

Update ...

type ManagedClusterId

type ManagedClusterId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ManagedClusterName string
}

ManagedClusterId is a struct representing the Resource ID for a Managed Cluster

func NewManagedClusterID

func NewManagedClusterID(subscriptionId string, resourceGroupName string, managedClusterName string) ManagedClusterId

NewManagedClusterID returns a new ManagedClusterId struct

func ParseManagedClusterID

func ParseManagedClusterID(input string) (*ManagedClusterId, error)

ParseManagedClusterID parses 'input' into a ManagedClusterId

func ParseManagedClusterIDInsensitively

func ParseManagedClusterIDInsensitively(input string) (*ManagedClusterId, error)

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

func (ManagedClusterId) ID

func (id ManagedClusterId) ID() string

ID returns the formatted Managed Cluster ID

func (ManagedClusterId) Segments

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

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

func (ManagedClusterId) String

func (id ManagedClusterId) String() string

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

type ManagedClusterOperationPredicate

type ManagedClusterOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ManagedClusterOperationPredicate) Matches

type ManagedClusterProperties

type ManagedClusterProperties struct {
	AddonFeatures                        *[]AddonFeatures                      `json:"addonFeatures,omitempty"`
	AdminPassword                        *string                               `json:"adminPassword,omitempty"`
	AdminUserName                        string                                `json:"adminUserName"`
	AllowRdpAccess                       *bool                                 `json:"allowRdpAccess,omitempty"`
	ApplicationTypeVersionsCleanupPolicy *ApplicationTypeVersionsCleanupPolicy `json:"applicationTypeVersionsCleanupPolicy,omitempty"`
	AuxiliarySubnets                     *[]Subnet                             `json:"auxiliarySubnets,omitempty"`
	AzureActiveDirectory                 *AzureActiveDirectory                 `json:"azureActiveDirectory,omitempty"`
	ClientConnectionPort                 *int64                                `json:"clientConnectionPort,omitempty"`
	Clients                              *[]ClientCertificate                  `json:"clients,omitempty"`
	ClusterCertificateThumbprints        *[]string                             `json:"clusterCertificateThumbprints,omitempty"`
	ClusterCodeVersion                   *string                               `json:"clusterCodeVersion,omitempty"`
	ClusterId                            *string                               `json:"clusterId,omitempty"`
	ClusterState                         *ClusterState                         `json:"clusterState,omitempty"`
	ClusterUpgradeCadence                *ClusterUpgradeCadence                `json:"clusterUpgradeCadence,omitempty"`
	ClusterUpgradeMode                   *ClusterUpgradeMode                   `json:"clusterUpgradeMode,omitempty"`
	DnsName                              string                                `json:"dnsName"`
	EnableAutoOSUpgrade                  *bool                                 `json:"enableAutoOSUpgrade,omitempty"`
	EnableIPv6                           *bool                                 `json:"enableIpv6,omitempty"`
	EnableServicePublicIP                *bool                                 `json:"enableServicePublicIP,omitempty"`
	FabricSettings                       *[]SettingsSectionDescription         `json:"fabricSettings,omitempty"`
	Fqdn                                 *string                               `json:"fqdn,omitempty"`
	HTTPGatewayConnectionPort            *int64                                `json:"httpGatewayConnectionPort,omitempty"`
	IPTags                               *[]IPTag                              `json:"ipTags,omitempty"`
	IPv4Address                          *string                               `json:"ipv4Address,omitempty"`
	IPv6Address                          *string                               `json:"ipv6Address,omitempty"`
	LoadBalancingRules                   *[]LoadBalancingRule                  `json:"loadBalancingRules,omitempty"`
	NetworkSecurityRules                 *[]NetworkSecurityRule                `json:"networkSecurityRules,omitempty"`
	ProvisioningState                    *ManagedResourceProvisioningState     `json:"provisioningState,omitempty"`
	ServiceEndpoints                     *[]ServiceEndpoint                    `json:"serviceEndpoints,omitempty"`
	SubnetId                             *string                               `json:"subnetId,omitempty"`
	ZonalResiliency                      *bool                                 `json:"zonalResiliency,omitempty"`
}

type ManagedClusterUpdateParameters

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

type ManagedResourceProvisioningState

type ManagedResourceProvisioningState string
const (
	ManagedResourceProvisioningStateCanceled  ManagedResourceProvisioningState = "Canceled"
	ManagedResourceProvisioningStateCreated   ManagedResourceProvisioningState = "Created"
	ManagedResourceProvisioningStateCreating  ManagedResourceProvisioningState = "Creating"
	ManagedResourceProvisioningStateDeleted   ManagedResourceProvisioningState = "Deleted"
	ManagedResourceProvisioningStateDeleting  ManagedResourceProvisioningState = "Deleting"
	ManagedResourceProvisioningStateFailed    ManagedResourceProvisioningState = "Failed"
	ManagedResourceProvisioningStateNone      ManagedResourceProvisioningState = "None"
	ManagedResourceProvisioningStateOther     ManagedResourceProvisioningState = "Other"
	ManagedResourceProvisioningStateSucceeded ManagedResourceProvisioningState = "Succeeded"
	ManagedResourceProvisioningStateUpdating  ManagedResourceProvisioningState = "Updating"
)

type NetworkSecurityRule

type NetworkSecurityRule struct {
	Access                     Access      `json:"access"`
	Description                *string     `json:"description,omitempty"`
	DestinationAddressPrefix   *string     `json:"destinationAddressPrefix,omitempty"`
	DestinationAddressPrefixes *[]string   `json:"destinationAddressPrefixes,omitempty"`
	DestinationPortRange       *string     `json:"destinationPortRange,omitempty"`
	DestinationPortRanges      *[]string   `json:"destinationPortRanges,omitempty"`
	Direction                  Direction   `json:"direction"`
	Name                       string      `json:"name"`
	Priority                   int64       `json:"priority"`
	Protocol                   NsgProtocol `json:"protocol"`
	SourceAddressPrefix        *string     `json:"sourceAddressPrefix,omitempty"`
	SourceAddressPrefixes      *[]string   `json:"sourceAddressPrefixes,omitempty"`
	SourcePortRange            *string     `json:"sourcePortRange,omitempty"`
	SourcePortRanges           *[]string   `json:"sourcePortRanges,omitempty"`
}

type NsgProtocol

type NsgProtocol string
const (
	NsgProtocolAh    NsgProtocol = "ah"
	NsgProtocolEsp   NsgProtocol = "esp"
	NsgProtocolHTTP  NsgProtocol = "http"
	NsgProtocolHTTPS NsgProtocol = "https"
	NsgProtocolIcmp  NsgProtocol = "icmp"
	NsgProtocolTcp   NsgProtocol = "tcp"
	NsgProtocolUdp   NsgProtocol = "udp"
)

type PrivateEndpointNetworkPolicies

type PrivateEndpointNetworkPolicies string
const (
	PrivateEndpointNetworkPoliciesDisabled PrivateEndpointNetworkPolicies = "disabled"
	PrivateEndpointNetworkPoliciesEnabled  PrivateEndpointNetworkPolicies = "enabled"
)

type PrivateLinkServiceNetworkPolicies

type PrivateLinkServiceNetworkPolicies string
const (
	PrivateLinkServiceNetworkPoliciesDisabled PrivateLinkServiceNetworkPolicies = "disabled"
	PrivateLinkServiceNetworkPoliciesEnabled  PrivateLinkServiceNetworkPolicies = "enabled"
)

type ProbeProtocol

type ProbeProtocol string
const (
	ProbeProtocolHTTP  ProbeProtocol = "http"
	ProbeProtocolHTTPS ProbeProtocol = "https"
	ProbeProtocolTcp   ProbeProtocol = "tcp"
)

type Protocol

type Protocol string
const (
	ProtocolTcp Protocol = "tcp"
	ProtocolUdp Protocol = "udp"
)

type ServiceEndpoint

type ServiceEndpoint struct {
	Locations *[]string `json:"locations,omitempty"`
	Service   string    `json:"service"`
}

type SettingsParameterDescription

type SettingsParameterDescription struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type SettingsSectionDescription

type SettingsSectionDescription struct {
	Name       string                         `json:"name"`
	Parameters []SettingsParameterDescription `json:"parameters"`
}

type Sku

type Sku struct {
	Name SkuName `json:"name"`
}

type SkuName

type SkuName string
const (
	SkuNameBasic    SkuName = "Basic"
	SkuNameStandard SkuName = "Standard"
)

type Subnet

type Subnet struct {
	EnableIPv6                        *bool                              `json:"enableIpv6,omitempty"`
	Name                              string                             `json:"name"`
	NetworkSecurityGroupId            *string                            `json:"networkSecurityGroupId,omitempty"`
	PrivateEndpointNetworkPolicies    *PrivateEndpointNetworkPolicies    `json:"privateEndpointNetworkPolicies,omitempty"`
	PrivateLinkServiceNetworkPolicies *PrivateLinkServiceNetworkPolicies `json:"privateLinkServiceNetworkPolicies,omitempty"`
}

type SystemData

type SystemData struct {
	CreatedAt          *string `json:"createdAt,omitempty"`
	CreatedBy          *string `json:"createdBy,omitempty"`
	CreatedByType      *string `json:"createdByType,omitempty"`
	LastModifiedAt     *string `json:"lastModifiedAt,omitempty"`
	LastModifiedBy     *string `json:"lastModifiedBy,omitempty"`
	LastModifiedByType *string `json:"lastModifiedByType,omitempty"`
}

func (*SystemData) GetCreatedAtAsTime

func (o *SystemData) GetCreatedAtAsTime() (*time.Time, error)

func (*SystemData) GetLastModifiedAtAsTime

func (o *SystemData) GetLastModifiedAtAsTime() (*time.Time, error)

func (*SystemData) SetCreatedAtAsTime

func (o *SystemData) SetCreatedAtAsTime(input time.Time)

func (*SystemData) SetLastModifiedAtAsTime

func (o *SystemData) SetLastModifiedAtAsTime(input time.Time)

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *ManagedCluster
}

Jump to

Keyboard shortcuts

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