clusters

package
v0.20240425.1122754 Latest Latest
Warning

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

Go to latest
Published: Apr 25, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2022-10-01/clusters Documentation

The clusters SDK allows for interaction with the Azure Resource Manager Service operationalinsights (API Version 2022-10-01).

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

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2022-10-01/clusters"

Client Initialization

client := clusters.NewClustersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClustersClient.CreateOrUpdate

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

payload := clusters.Cluster{
	// ...
}


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

Example Usage: ClustersClient.Delete

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

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

Example Usage: ClustersClient.Get

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

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: ClustersClient.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: ClustersClient.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: ClustersClient.Update

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

payload := clusters.ClusterPatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForBillingType

func PossibleValuesForBillingType() []string

func PossibleValuesForCapacity

func PossibleValuesForCapacity() []int64

func PossibleValuesForClusterEntityStatus

func PossibleValuesForClusterEntityStatus() []string

func PossibleValuesForClusterSkuNameEnum

func PossibleValuesForClusterSkuNameEnum() []string

func ValidateClusterID

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

Types

type AssociatedWorkspace

type AssociatedWorkspace struct {
	AssociateDate *string `json:"associateDate,omitempty"`
	ResourceId    *string `json:"resourceId,omitempty"`
	WorkspaceId   *string `json:"workspaceId,omitempty"`
	WorkspaceName *string `json:"workspaceName,omitempty"`
}

type BillingType

type BillingType string
const (
	BillingTypeCluster    BillingType = "Cluster"
	BillingTypeWorkspaces BillingType = "Workspaces"
)

func (*BillingType) UnmarshalJSON

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

type Capacity

type Capacity int64
const (
	CapacityFiveHundred      Capacity = 500
	CapacityFiveThousand     Capacity = 5000
	CapacityFiveZeroThousand Capacity = 50000
	CapacityFourHundred      Capacity = 400
	CapacityOneHundred       Capacity = 100
	CapacityOneThousand      Capacity = 1000
	CapacityOneZeroThousand  Capacity = 10000
	CapacityThreeHundred     Capacity = 300
	CapacityTwoFiveThousand  Capacity = 25000
	CapacityTwoHundred       Capacity = 200
	CapacityTwoThousand      Capacity = 2000
)

type CapacityReservationProperties

type CapacityReservationProperties struct {
	LastSkuUpdate *string `json:"lastSkuUpdate,omitempty"`
	MinCapacity   *int64  `json:"minCapacity,omitempty"`
}

type Cluster

type Cluster struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *ClusterProperties                       `json:"properties,omitempty"`
	Sku        *ClusterSku                              `json:"sku,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type ClusterEntityStatus

type ClusterEntityStatus string
const (
	ClusterEntityStatusCanceled            ClusterEntityStatus = "Canceled"
	ClusterEntityStatusCreating            ClusterEntityStatus = "Creating"
	ClusterEntityStatusDeleting            ClusterEntityStatus = "Deleting"
	ClusterEntityStatusFailed              ClusterEntityStatus = "Failed"
	ClusterEntityStatusProvisioningAccount ClusterEntityStatus = "ProvisioningAccount"
	ClusterEntityStatusSucceeded           ClusterEntityStatus = "Succeeded"
	ClusterEntityStatusUpdating            ClusterEntityStatus = "Updating"
)

func (*ClusterEntityStatus) UnmarshalJSON

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

type ClusterId

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult

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

func (ClusterId) ID

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments

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

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

func (ClusterId) String

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type ClusterOperationPredicate

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

func (ClusterOperationPredicate) Matches

func (p ClusterOperationPredicate) Matches(input Cluster) bool

type ClusterPatch

type ClusterPatch struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *ClusterPatchProperties                  `json:"properties,omitempty"`
	Sku        *ClusterSku                              `json:"sku,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type ClusterPatchProperties

type ClusterPatchProperties struct {
	BillingType        *BillingType        `json:"billingType,omitempty"`
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

type ClusterProperties

type ClusterProperties struct {
	AssociatedWorkspaces          *[]AssociatedWorkspace         `json:"associatedWorkspaces,omitempty"`
	BillingType                   *BillingType                   `json:"billingType,omitempty"`
	CapacityReservationProperties *CapacityReservationProperties `json:"capacityReservationProperties,omitempty"`
	ClusterId                     *string                        `json:"clusterId,omitempty"`
	CreatedDate                   *string                        `json:"createdDate,omitempty"`
	IsAvailabilityZonesEnabled    *bool                          `json:"isAvailabilityZonesEnabled,omitempty"`
	IsDoubleEncryptionEnabled     *bool                          `json:"isDoubleEncryptionEnabled,omitempty"`
	KeyVaultProperties            *KeyVaultProperties            `json:"keyVaultProperties,omitempty"`
	LastModifiedDate              *string                        `json:"lastModifiedDate,omitempty"`
	ProvisioningState             *ClusterEntityStatus           `json:"provisioningState,omitempty"`
}

type ClusterSku

type ClusterSku struct {
	Capacity *Capacity           `json:"capacity,omitempty"`
	Name     *ClusterSkuNameEnum `json:"name,omitempty"`
}

type ClusterSkuNameEnum

type ClusterSkuNameEnum string
const (
	ClusterSkuNameEnumCapacityReservation ClusterSkuNameEnum = "CapacityReservation"
)

func (*ClusterSkuNameEnum) UnmarshalJSON

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

type ClustersClient

type ClustersClient struct {
	Client *resourcemanager.Client
}

func NewClustersClientWithBaseURI

func NewClustersClientWithBaseURI(sdkApi sdkEnv.Api) (*ClustersClient, error)

func (ClustersClient) CreateOrUpdate

func (c ClustersClient) CreateOrUpdate(ctx context.Context, id ClusterId, input Cluster) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ClustersClient) CreateOrUpdateThenPoll

func (c ClustersClient) CreateOrUpdateThenPoll(ctx context.Context, id ClusterId, input Cluster) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ClustersClient) Delete

func (c ClustersClient) Delete(ctx context.Context, id ClusterId) (result DeleteOperationResponse, err error)

Delete ...

func (ClustersClient) DeleteThenPoll

func (c ClustersClient) DeleteThenPoll(ctx context.Context, id ClusterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ClustersClient) Get

func (c ClustersClient) Get(ctx context.Context, id ClusterId) (result GetOperationResponse, err error)

Get ...

func (ClustersClient) List

List ...

func (ClustersClient) ListByResourceGroup

ListByResourceGroup ...

func (ClustersClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (ClustersClient) ListByResourceGroupCompleteMatchingPredicate

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ClustersClient) ListComplete

ListComplete retrieves all the results into a single object

func (ClustersClient) ListCompleteMatchingPredicate

func (c ClustersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ClusterOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ClustersClient) Update

func (c ClustersClient) Update(ctx context.Context, id ClusterId, input ClusterPatch) (result UpdateOperationResponse, err error)

Update ...

func (ClustersClient) UpdateThenPoll

func (c ClustersClient) UpdateThenPoll(ctx context.Context, id ClusterId, input ClusterPatch) error

UpdateThenPoll performs Update then polls until it's completed

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type KeyVaultProperties

type KeyVaultProperties struct {
	KeyName     *string `json:"keyName,omitempty"`
	KeyRsaSize  *int64  `json:"keyRsaSize,omitempty"`
	KeyVaultUri *string `json:"keyVaultUri,omitempty"`
	KeyVersion  *string `json:"keyVersion,omitempty"`
}

type ListByResourceGroupCompleteResult

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

type ListByResourceGroupOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

Jump to

Keyboard shortcuts

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