virtualmachines

README

github.com/hashicorp/go-azure-sdk/resource-manager/hdinsight/2018-06-01-preview/virtualmachines Documentation

The virtualmachines SDK allows for interaction with the Azure Resource Manager Service hdinsight (API Version 2018-06-01-preview).

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/hdinsight/2018-06-01-preview/virtualmachines"

Client Initialization

client := virtualmachines.NewVirtualMachinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VirtualMachinesClient.ListHosts

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

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

Example Usage: VirtualMachinesClient.RestartHosts

ctx := context.TODO()
id := virtualmachines.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")
var payload []string

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

Documentation

Index

• func ValidateClusterID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterId
  • func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId
  • func ParseClusterID(input string) (*ClusterId, error)
  • func ParseClusterIDInsensitively(input string) (*ClusterId, error)
  • func (id *ClusterId) FromParseResult(input resourceids.ParseResult) error
  • func (id ClusterId) ID() string
  • func (id ClusterId) Segments() []resourceids.Segment
  • func (id ClusterId) String() string
• type HostInfo
• type ListHostsOperationResponse
• type RestartHostsOperationResponse
• type VirtualMachinesClient
  • func NewVirtualMachinesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualMachinesClient, error)
  • func (c VirtualMachinesClient) ListHosts(ctx context.Context, id ClusterId) (result ListHostsOperationResponse, err error)
  • func (c VirtualMachinesClient) RestartHosts(ctx context.Context, id ClusterId, input []string) (result RestartHostsOperationResponse, err error)
  • func (c VirtualMachinesClient) RestartHostsThenPoll(ctx context.Context, id ClusterId, input []string) 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
	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 HostInfo

type HostInfo struct {
	EffectiveDiskEncryptionKeyUrl *string `json:"effectiveDiskEncryptionKeyUrl,omitempty"`
	Fqdn                          *string `json:"fqdn,omitempty"`
	Name                          *string `json:"name,omitempty"`
}

type ListHostsOperationResponse

type ListHostsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]HostInfo
}

type RestartHostsOperationResponse

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

type VirtualMachinesClient

type VirtualMachinesClient struct {
	Client *resourcemanager.Client
}

func NewVirtualMachinesClientWithBaseURI

func NewVirtualMachinesClientWithBaseURI(sdkApi sdkEnv.Api) (*VirtualMachinesClient, error)

func (VirtualMachinesClient) ListHosts

func (c VirtualMachinesClient) ListHosts(ctx context.Context, id ClusterId) (result ListHostsOperationResponse, err error)

ListHosts ...

func (VirtualMachinesClient) RestartHosts

func (c VirtualMachinesClient) RestartHosts(ctx context.Context, id ClusterId, input []string) (result RestartHostsOperationResponse, err error)

RestartHosts ...

func (VirtualMachinesClient) RestartHostsThenPoll

func (c VirtualMachinesClient) RestartHostsThenPoll(ctx context.Context, id ClusterId, input []string) error

RestartHostsThenPoll performs RestartHosts then polls until it's completed