cluster

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2022-05-01/cluster Documentation

The cluster SDK allows for interaction with the Azure Resource Manager Service vmware (API Version 2022-05-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/vmware/2022-05-01/cluster"

Client Initialization

client := cluster.NewClusterClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClusterClient.ListZones

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

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

Documentation

Index

• func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterClient
  • func NewClusterClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterClient, error)
  • func (c ClusterClient) ListZones(ctx context.Context, id ClusterId) (result ListZonesOperationResponse, err error)
• type ClusterId
  • func NewClusterID(subscriptionId string, resourceGroupName string, privateCloudName string, ...) ClusterId
  • func ParseClusterID(input string) (*ClusterId, error)
  • func ParseClusterIDInsensitively(input string) (*ClusterId, error)
  • func (id ClusterId) ID() string
  • func (id ClusterId) Segments() []resourceids.Segment
  • func (id ClusterId) String() string
• type ClusterZone
• type ClusterZoneList
• type ListZonesOperationResponse

Functions

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 ClusterClient

type ClusterClient struct {
	Client *resourcemanager.Client
}

func NewClusterClientWithBaseURI

func NewClusterClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterClient, error)

func (ClusterClient) ListZones

func (c ClusterClient) ListZones(ctx context.Context, id ClusterId) (result ListZonesOperationResponse, err error)

ListZones ...

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

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

type ClusterZone struct {
	Hosts *[]string `json:"hosts,omitempty"`
	Zone  *string   `json:"zone,omitempty"`
}

type ClusterZoneList

type ClusterZoneList struct {
	Zones *[]ClusterZone `json:"zones,omitempty"`
}

type ListZonesOperationResponse

type ListZonesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterZoneList
}