vmhhostlist

README

github.com/hashicorp/go-azure-sdk/resource-manager/elastic/2024-03-01/vmhhostlist Documentation

The vmhhostlist SDK allows for interaction with Azure Resource Manager elastic (API Version 2024-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/elastic/2024-03-01/vmhhostlist"

Client Initialization

client := vmhhostlist.NewVMHHostListClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VMHHostListClient.VMHostList

ctx := context.TODO()
id := vmhhostlist.NewMonitorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorName")

// alternatively `client.VMHostList(ctx, id)` can be used to do batched pagination
items, err := client.VMHostListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func ValidateMonitorID(input interface{}, key string) (warnings []string, errors []error)
• type MonitorId
  • func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId
  • func ParseMonitorID(input string) (*MonitorId, error)
  • func ParseMonitorIDInsensitively(input string) (*MonitorId, error)
  • func (id *MonitorId) FromParseResult(input resourceids.ParseResult) error
  • func (id MonitorId) ID() string
  • func (id MonitorId) Segments() []resourceids.Segment
  • func (id MonitorId) String() string
• type VMHHostListClient
  • func NewVMHHostListClientWithBaseURI(sdkApi sdkEnv.Api) (*VMHHostListClient, error)
  • func (c VMHHostListClient) VMHostList(ctx context.Context, id MonitorId) (result VMHostListOperationResponse, err error)
  • func (c VMHHostListClient) VMHostListComplete(ctx context.Context, id MonitorId) (VMHostListCompleteResult, error)
  • func (c VMHHostListClient) VMHostListCompleteMatchingPredicate(ctx context.Context, id MonitorId, predicate VMResourcesOperationPredicate) (result VMHostListCompleteResult, err error)
• type VMHostListCompleteResult
• type VMHostListCustomPager
  • func (p *VMHostListCustomPager) NextPageLink() *odata.Link
• type VMHostListOperationResponse
• type VMResources
• type VMResourcesOperationPredicate
  • func (p VMResourcesOperationPredicate) Matches(input VMResources) bool

Functions

func ValidateMonitorID

func ValidateMonitorID(input interface{}, key string) (warnings []string, errors []error)

ValidateMonitorID checks that 'input' can be parsed as a Monitor ID

Types

type MonitorId

type MonitorId struct {
	SubscriptionId    string
	ResourceGroupName string
	MonitorName       string
}

MonitorId is a struct representing the Resource ID for a Monitor

func NewMonitorID

func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId

NewMonitorID returns a new MonitorId struct

func ParseMonitorID

func ParseMonitorID(input string) (*MonitorId, error)

ParseMonitorID parses 'input' into a MonitorId

func ParseMonitorIDInsensitively

func ParseMonitorIDInsensitively(input string) (*MonitorId, error)

ParseMonitorIDInsensitively parses 'input' case-insensitively into a MonitorId note: this method should only be used for API response data and not user input

func (*MonitorId) FromParseResult

func (id *MonitorId) FromParseResult(input resourceids.ParseResult) error

func (MonitorId) ID

func (id MonitorId) ID() string

ID returns the formatted Monitor ID

func (MonitorId) Segments

func (id MonitorId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Monitor ID

func (MonitorId) String

func (id MonitorId) String() string

String returns a human-readable description of this Monitor ID

type VMHHostListClient

type VMHHostListClient struct {
	Client *resourcemanager.Client
}

func NewVMHHostListClientWithBaseURI

func NewVMHHostListClientWithBaseURI(sdkApi sdkEnv.Api) (*VMHHostListClient, error)

func (VMHHostListClient) VMHostList

func (c VMHHostListClient) VMHostList(ctx context.Context, id MonitorId) (result VMHostListOperationResponse, err error)

VMHostList ...

func (VMHHostListClient) VMHostListComplete

func (c VMHHostListClient) VMHostListComplete(ctx context.Context, id MonitorId) (VMHostListCompleteResult, error)

VMHostListComplete retrieves all the results into a single object

func (VMHHostListClient) VMHostListCompleteMatchingPredicate

func (c VMHHostListClient) VMHostListCompleteMatchingPredicate(ctx context.Context, id MonitorId, predicate VMResourcesOperationPredicate) (result VMHostListCompleteResult, err error)

VMHostListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type VMHostListCompleteResult

type VMHostListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []VMResources
}

type VMHostListCustomPager

type VMHostListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*VMHostListCustomPager) NextPageLink

func (p *VMHostListCustomPager) NextPageLink() *odata.Link

type VMHostListOperationResponse

type VMHostListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]VMResources
}

type VMResources

type VMResources struct {
	VMResourceId *string `json:"vmResourceId,omitempty"`
}

type VMResourcesOperationPredicate

type VMResourcesOperationPredicate struct {
	VMResourceId *string
}

func (VMResourcesOperationPredicate) Matches

func (p VMResourcesOperationPredicate) Matches(input VMResources) bool