zone

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-03-01/zone Documentation

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

Client Initialization

client := zone.NewZoneClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ZoneClient.ClustersListZones

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

read, err := client.ClustersListZones(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 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 ClustersListZonesOperationResponse
• type ZoneClient
  • func NewZoneClientWithBaseURI(sdkApi sdkEnv.Api) (*ZoneClient, error)
  • func (c ZoneClient) ClustersListZones(ctx context.Context, id ClusterId) (result ClustersListZonesOperationResponse, err error)

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 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 ClustersListZonesOperationResponse

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

type ZoneClient

type ZoneClient struct {
	Client *resourcemanager.Client
}

func NewZoneClientWithBaseURI

func NewZoneClientWithBaseURI(sdkApi sdkEnv.Api) (*ZoneClient, error)

func (ZoneClient) ClustersListZones

func (c ZoneClient) ClustersListZones(ctx context.Context, id ClusterId) (result ClustersListZonesOperationResponse, err error)

ClustersListZones ...