clusters

package
v0.20240227.1165506 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2024 License: MPL-2.0 Imports: 16 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-08-01/clusters Documentation

The clusters SDK allows for interaction with the Azure Resource Manager Service azurestackhci (API Version 2023-08-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/azurestackhci/2023-08-01/clusters"

Client Initialization

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

Example Usage: ClustersClient.Create

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

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


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

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.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.ListBySubscription

ctx := context.TODO()
id := commonids.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: ClustersClient.Update

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

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


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 PossibleValuesForClusterNodeType 

func PossibleValuesForClusterNodeType() []string

func PossibleValuesForConnectivityStatus 

func PossibleValuesForConnectivityStatus() []string

func PossibleValuesForDiagnosticLevel 

func PossibleValuesForDiagnosticLevel() []string

func PossibleValuesForImdsAttestation 

func PossibleValuesForImdsAttestation() []string

func PossibleValuesForOemActivation 

func PossibleValuesForOemActivation() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSoftwareAssuranceIntent 

func PossibleValuesForSoftwareAssuranceIntent() []string

func PossibleValuesForSoftwareAssuranceStatus 

func PossibleValuesForSoftwareAssuranceStatus() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func PossibleValuesForWindowsServerSubscription 

func PossibleValuesForWindowsServerSubscription() []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 Cluster 

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

type ClusterDesiredProperties 

type ClusterDesiredProperties struct {
	DiagnosticLevel           *DiagnosticLevel           `json:"diagnosticLevel,omitempty"`
	WindowsServerSubscription *WindowsServerSubscription `json:"windowsServerSubscription,omitempty"`
}

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 ClusterNode 

type ClusterNode struct {
	CoreCount                 *float64                   `json:"coreCount,omitempty"`
	EhcResourceId             *string                    `json:"ehcResourceId,omitempty"`
	Id                        *float64                   `json:"id,omitempty"`
	LastLicensingTimestamp    *string                    `json:"lastLicensingTimestamp,omitempty"`
	Manufacturer              *string                    `json:"manufacturer,omitempty"`
	MemoryInGiB               *float64                   `json:"memoryInGiB,omitempty"`
	Model                     *string                    `json:"model,omitempty"`
	Name                      *string                    `json:"name,omitempty"`
	NodeType                  *ClusterNodeType           `json:"nodeType,omitempty"`
	OemActivation             *OemActivation             `json:"oemActivation,omitempty"`
	OsDisplayVersion          *string                    `json:"osDisplayVersion,omitempty"`
	OsName                    *string                    `json:"osName,omitempty"`
	OsVersion                 *string                    `json:"osVersion,omitempty"`
	SerialNumber              *string                    `json:"serialNumber,omitempty"`
	WindowsServerSubscription *WindowsServerSubscription `json:"windowsServerSubscription,omitempty"`
}

func (*ClusterNode) GetLastLicensingTimestampAsTime 

func (o *ClusterNode) GetLastLicensingTimestampAsTime() (*time.Time, error)

type ClusterNodeType 

type ClusterNodeType string
const (
	ClusterNodeTypeFirstParty ClusterNodeType = "FirstParty"
	ClusterNodeTypeThirdParty ClusterNodeType = "ThirdParty"
)

func (*ClusterNodeType) UnmarshalJSON 

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

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.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *ClusterPatchProperties            `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type ClusterPatchProperties 

type ClusterPatchProperties struct {
	AadClientId             *string                   `json:"aadClientId,omitempty"`
	AadTenantId             *string                   `json:"aadTenantId,omitempty"`
	CloudManagementEndpoint *string                   `json:"cloudManagementEndpoint,omitempty"`
	DesiredProperties       *ClusterDesiredProperties `json:"desiredProperties,omitempty"`
}

type ClusterProperties 

type ClusterProperties struct {
	AadApplicationObjectId             *string                             `json:"aadApplicationObjectId,omitempty"`
	AadClientId                        *string                             `json:"aadClientId,omitempty"`
	AadServicePrincipalObjectId        *string                             `json:"aadServicePrincipalObjectId,omitempty"`
	AadTenantId                        *string                             `json:"aadTenantId,omitempty"`
	BillingModel                       *string                             `json:"billingModel,omitempty"`
	CloudId                            *string                             `json:"cloudId,omitempty"`
	CloudManagementEndpoint            *string                             `json:"cloudManagementEndpoint,omitempty"`
	ConnectivityStatus                 *ConnectivityStatus                 `json:"connectivityStatus,omitempty"`
	DesiredProperties                  *ClusterDesiredProperties           `json:"desiredProperties,omitempty"`
	IsolatedVMAttestationConfiguration *IsolatedVMAttestationConfiguration `json:"isolatedVmAttestationConfiguration,omitempty"`
	LastBillingTimestamp               *string                             `json:"lastBillingTimestamp,omitempty"`
	LastSyncTimestamp                  *string                             `json:"lastSyncTimestamp,omitempty"`
	ProvisioningState                  *ProvisioningState                  `json:"provisioningState,omitempty"`
	RegistrationTimestamp              *string                             `json:"registrationTimestamp,omitempty"`
	ReportedProperties                 *ClusterReportedProperties          `json:"reportedProperties,omitempty"`
	ResourceProviderObjectId           *string                             `json:"resourceProviderObjectId,omitempty"`
	ServiceEndpoint                    *string                             `json:"serviceEndpoint,omitempty"`
	SoftwareAssuranceProperties        *SoftwareAssuranceProperties        `json:"softwareAssuranceProperties,omitempty"`
	Status                             *Status                             `json:"status,omitempty"`
	TrialDaysRemaining                 *float64                            `json:"trialDaysRemaining,omitempty"`
}

func (*ClusterProperties) GetLastBillingTimestampAsTime 

func (o *ClusterProperties) GetLastBillingTimestampAsTime() (*time.Time, error)

func (*ClusterProperties) GetLastSyncTimestampAsTime 

func (o *ClusterProperties) GetLastSyncTimestampAsTime() (*time.Time, error)

func (*ClusterProperties) GetRegistrationTimestampAsTime 

func (o *ClusterProperties) GetRegistrationTimestampAsTime() (*time.Time, error)

type ClusterReportedProperties 

type ClusterReportedProperties struct {
	ClusterId             *string          `json:"clusterId,omitempty"`
	ClusterName           *string          `json:"clusterName,omitempty"`
	ClusterType           *ClusterNodeType `json:"clusterType,omitempty"`
	ClusterVersion        *string          `json:"clusterVersion,omitempty"`
	DiagnosticLevel       *DiagnosticLevel `json:"diagnosticLevel,omitempty"`
	ImdsAttestation       *ImdsAttestation `json:"imdsAttestation,omitempty"`
	LastUpdated           *string          `json:"lastUpdated,omitempty"`
	Manufacturer          *string          `json:"manufacturer,omitempty"`
	Nodes                 *[]ClusterNode   `json:"nodes,omitempty"`
	OemActivation         *OemActivation   `json:"oemActivation,omitempty"`
	SupportedCapabilities *[]string        `json:"supportedCapabilities,omitempty"`
}

func (*ClusterReportedProperties) GetLastUpdatedAsTime 

func (o *ClusterReportedProperties) GetLastUpdatedAsTime() (*time.Time, error)

type ClustersClient 

type ClustersClient struct {
	Client *resourcemanager.Client
}

func NewClustersClientWithBaseURI 

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

func (ClustersClient) Create 

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

Create ...

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) ListByResourceGroup 

func (c ClustersClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ClustersClient) ListByResourceGroupComplete 

func (c ClustersClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

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) ListBySubscription 

func (c ClustersClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (ClustersClient) ListBySubscriptionComplete 

func (c ClustersClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (ClustersClient) ListBySubscriptionCompleteMatchingPredicate 

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

ListBySubscriptionCompleteMatchingPredicate 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 ...

type ConnectivityStatus 

type ConnectivityStatus string
const (
	ConnectivityStatusConnected            ConnectivityStatus = "Connected"
	ConnectivityStatusDisconnected         ConnectivityStatus = "Disconnected"
	ConnectivityStatusNotConnectedRecently ConnectivityStatus = "NotConnectedRecently"
	ConnectivityStatusNotSpecified         ConnectivityStatus = "NotSpecified"
	ConnectivityStatusNotYetRegistered     ConnectivityStatus = "NotYetRegistered"
	ConnectivityStatusPartiallyConnected   ConnectivityStatus = "PartiallyConnected"
)

func (*ConnectivityStatus) UnmarshalJSON 

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

type CreateOperationResponse 

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

type DeleteOperationResponse 

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

type DiagnosticLevel 

type DiagnosticLevel string
const (
	DiagnosticLevelBasic    DiagnosticLevel = "Basic"
	DiagnosticLevelEnhanced DiagnosticLevel = "Enhanced"
	DiagnosticLevelOff      DiagnosticLevel = "Off"
)

func (*DiagnosticLevel) UnmarshalJSON 

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

type GetOperationResponse 

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

type ImdsAttestation 

type ImdsAttestation string
const (
	ImdsAttestationDisabled ImdsAttestation = "Disabled"
	ImdsAttestationEnabled  ImdsAttestation = "Enabled"
)

func (*ImdsAttestation) UnmarshalJSON 

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

type IsolatedVMAttestationConfiguration 

type IsolatedVMAttestationConfiguration struct {
	AttestationResourceId       *string `json:"attestationResourceId,omitempty"`
	AttestationServiceEndpoint  *string `json:"attestationServiceEndpoint,omitempty"`
	RelyingPartyServiceEndpoint *string `json:"relyingPartyServiceEndpoint,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 ListBySubscriptionCompleteResult 

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

type ListBySubscriptionOperationResponse 

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

type OemActivation 

type OemActivation string
const (
	OemActivationDisabled OemActivation = "Disabled"
	OemActivationEnabled  OemActivation = "Enabled"
)

func (*OemActivation) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted           ProvisioningState = "Accepted"
	ProvisioningStateCanceled           ProvisioningState = "Canceled"
	ProvisioningStateConnected          ProvisioningState = "Connected"
	ProvisioningStateCreating           ProvisioningState = "Creating"
	ProvisioningStateDeleted            ProvisioningState = "Deleted"
	ProvisioningStateDeleting           ProvisioningState = "Deleting"
	ProvisioningStateDisableInProgress  ProvisioningState = "DisableInProgress"
	ProvisioningStateDisconnected       ProvisioningState = "Disconnected"
	ProvisioningStateFailed             ProvisioningState = "Failed"
	ProvisioningStateInProgress         ProvisioningState = "InProgress"
	ProvisioningStateMoving             ProvisioningState = "Moving"
	ProvisioningStateNotSpecified       ProvisioningState = "NotSpecified"
	ProvisioningStatePartiallyConnected ProvisioningState = "PartiallyConnected"
	ProvisioningStatePartiallySucceeded ProvisioningState = "PartiallySucceeded"
	ProvisioningStateProvisioning       ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded          ProvisioningState = "Succeeded"
	ProvisioningStateUpdating           ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type SoftwareAssuranceIntent 

type SoftwareAssuranceIntent string
const (
	SoftwareAssuranceIntentDisable SoftwareAssuranceIntent = "Disable"
	SoftwareAssuranceIntentEnable  SoftwareAssuranceIntent = "Enable"
)

func (*SoftwareAssuranceIntent) UnmarshalJSON 

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

type SoftwareAssuranceProperties 

type SoftwareAssuranceProperties struct {
	LastUpdated             *string                  `json:"lastUpdated,omitempty"`
	SoftwareAssuranceIntent *SoftwareAssuranceIntent `json:"softwareAssuranceIntent,omitempty"`
	SoftwareAssuranceStatus *SoftwareAssuranceStatus `json:"softwareAssuranceStatus,omitempty"`
}

func (*SoftwareAssuranceProperties) GetLastUpdatedAsTime 

func (o *SoftwareAssuranceProperties) GetLastUpdatedAsTime() (*time.Time, error)

type SoftwareAssuranceStatus 

type SoftwareAssuranceStatus string
const (
	SoftwareAssuranceStatusDisabled SoftwareAssuranceStatus = "Disabled"
	SoftwareAssuranceStatusEnabled  SoftwareAssuranceStatus = "Enabled"
)

func (*SoftwareAssuranceStatus) UnmarshalJSON 

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

type Status 

type Status string
const (
	StatusConnectedRecently    Status = "ConnectedRecently"
	StatusDisconnected         Status = "Disconnected"
	StatusError                Status = "Error"
	StatusNotConnectedRecently Status = "NotConnectedRecently"
	StatusNotSpecified         Status = "NotSpecified"
	StatusNotYetRegistered     Status = "NotYetRegistered"
)

func (*Status) UnmarshalJSON 

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

type UpdateOperationResponse 

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

type WindowsServerSubscription 

type WindowsServerSubscription string
const (
	WindowsServerSubscriptionDisabled WindowsServerSubscription = "Disabled"
	WindowsServerSubscriptionEnabled  WindowsServerSubscription = "Enabled"
)

func (*WindowsServerSubscription) UnmarshalJSON 

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

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.