README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2020-03-20/clusters
Documentation
The clusters
SDK allows for interaction with the Azure Resource Manager Service vmware
(API Version 2020-03-20
).
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/vmware/2020-03-20/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", "privateCloudValue", "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", "privateCloudValue", "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", "privateCloudValue", "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 := clusters.NewPrivateCloudID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue")
// 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.Update
ctx := context.TODO()
id := clusters.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateCloudValue", "clusterValue")
payload := clusters.ClusterUpdate{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForClusterProvisioningState() []string
- func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePrivateCloudID(input interface{}, key string) (warnings []string, errors []error)
- type Cluster
- type ClusterId
- type ClusterOperationPredicate
- type ClusterProperties
- type ClusterProvisioningState
- type ClusterUpdate
- type ClusterUpdateProperties
- type ClustersClient
- func (c ClustersClient) CreateOrUpdate(ctx context.Context, id ClusterId, input Cluster) (result CreateOrUpdateOperationResponse, err error)
- func (c ClustersClient) CreateOrUpdateThenPoll(ctx context.Context, id ClusterId, input Cluster) error
- func (c ClustersClient) Delete(ctx context.Context, id ClusterId) (result DeleteOperationResponse, err error)
- func (c ClustersClient) DeleteThenPoll(ctx context.Context, id ClusterId) error
- func (c ClustersClient) Get(ctx context.Context, id ClusterId) (result GetOperationResponse, err error)
- func (c ClustersClient) List(ctx context.Context, id PrivateCloudId) (resp ListOperationResponse, err error)
- func (c ClustersClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)
- func (c ClustersClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate ClusterOperationPredicate) (resp ListCompleteResult, err error)
- func (c ClustersClient) Update(ctx context.Context, id ClusterId, input ClusterUpdate) (result UpdateOperationResponse, err error)
- func (c ClustersClient) UpdateThenPoll(ctx context.Context, id ClusterId, input ClusterUpdate) error
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type PrivateCloudId
- type Sku
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForClusterProvisioningState ¶
func PossibleValuesForClusterProvisioningState() []string
func ValidateClusterID ¶
ValidateClusterID checks that 'input' can be parsed as a Cluster ID
func ValidatePrivateCloudID ¶
ValidatePrivateCloudID checks that 'input' can be parsed as a Private Cloud ID
Types ¶
type Cluster ¶
type Cluster struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties ClusterProperties `json:"properties"` Sku Sku `json:"sku"` Type *string `json:"type,omitempty"` }
type ClusterId ¶
type ClusterId struct { SubscriptionId string ResourceGroupName string PrivateCloudName string ClusterName string }
ClusterId is a struct representing the Resource ID for a Cluster
func NewClusterID ¶
func NewClusterID(subscriptionId string, resourceGroupName string, privateCloudName string, clusterName string) ClusterId
NewClusterID returns a new ClusterId struct
func ParseClusterID ¶
ParseClusterID parses 'input' into a ClusterId
func ParseClusterIDInsensitively ¶
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) Segments ¶
func (id ClusterId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Cluster ID
type ClusterOperationPredicate ¶
func (ClusterOperationPredicate) Matches ¶
func (p ClusterOperationPredicate) Matches(input Cluster) bool
type ClusterProperties ¶
type ClusterProperties struct { ClusterId *int64 `json:"clusterId,omitempty"` ClusterSize int64 `json:"clusterSize"` Hosts *[]string `json:"hosts,omitempty"` ProvisioningState *ClusterProvisioningState `json:"provisioningState,omitempty"` }
type ClusterProvisioningState ¶
type ClusterProvisioningState string
const ( ClusterProvisioningStateCancelled ClusterProvisioningState = "Cancelled" ClusterProvisioningStateDeleting ClusterProvisioningState = "Deleting" ClusterProvisioningStateFailed ClusterProvisioningState = "Failed" ClusterProvisioningStateSucceeded ClusterProvisioningState = "Succeeded" ClusterProvisioningStateUpdating ClusterProvisioningState = "Updating" )
type ClusterUpdate ¶
type ClusterUpdate struct {
Properties *ClusterUpdateProperties `json:"properties,omitempty"`
}
type ClusterUpdateProperties ¶
type ClusterUpdateProperties struct {
ClusterSize *int64 `json:"clusterSize,omitempty"`
}
type ClustersClient ¶
func NewClustersClientWithBaseURI ¶
func NewClustersClientWithBaseURI(endpoint string) ClustersClient
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 ¶
func (c ClustersClient) List(ctx context.Context, id PrivateCloudId) (resp ListOperationResponse, err error)
List ...
func (ClustersClient) ListComplete ¶
func (c ClustersClient) ListComplete(ctx context.Context, id PrivateCloudId) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (ClustersClient) ListCompleteMatchingPredicate ¶
func (c ClustersClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateCloudId, predicate ClusterOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (ClustersClient) Update ¶
func (c ClustersClient) Update(ctx context.Context, id ClusterId, input ClusterUpdate) (result UpdateOperationResponse, err error)
Update ...
func (ClustersClient) UpdateThenPoll ¶
func (c ClustersClient) UpdateThenPoll(ctx context.Context, id ClusterId, input ClusterUpdate) error
UpdateThenPoll performs Update then polls until it's completed
type CreateOrUpdateOperationResponse ¶
type CreateOrUpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetOperationResponse ¶
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []Cluster
}
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]Cluster // contains filtered or unexported fields }
func (ListOperationResponse) HasMore ¶
func (r ListOperationResponse) HasMore() bool
func (ListOperationResponse) LoadMore ¶
func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
type PrivateCloudId ¶
type PrivateCloudId struct { SubscriptionId string ResourceGroupName string PrivateCloudName string }
PrivateCloudId is a struct representing the Resource ID for a Private Cloud
func NewPrivateCloudID ¶
func NewPrivateCloudID(subscriptionId string, resourceGroupName string, privateCloudName string) PrivateCloudId
NewPrivateCloudID returns a new PrivateCloudId struct
func ParsePrivateCloudID ¶
func ParsePrivateCloudID(input string) (*PrivateCloudId, error)
ParsePrivateCloudID parses 'input' into a PrivateCloudId
func ParsePrivateCloudIDInsensitively ¶
func ParsePrivateCloudIDInsensitively(input string) (*PrivateCloudId, error)
ParsePrivateCloudIDInsensitively parses 'input' case-insensitively into a PrivateCloudId note: this method should only be used for API response data and not user input
func (PrivateCloudId) ID ¶
func (id PrivateCloudId) ID() string
ID returns the formatted Private Cloud ID
func (PrivateCloudId) Segments ¶
func (id PrivateCloudId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Private Cloud ID
func (PrivateCloudId) String ¶
func (id PrivateCloudId) String() string
String returns a human-readable description of this Private Cloud ID
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
Source Files ¶
- client.go
- constants.go
- id_cluster.go
- id_privatecloud.go
- method_createorupdate_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_list_autorest.go
- method_update_autorest.go
- model_cluster.go
- model_clusterproperties.go
- model_clusterupdate.go
- model_clusterupdateproperties.go
- model_sku.go
- predicates.go
- version.go