agentversions

README

github.com/hashicorp/go-azure-sdk/resource-manager/hybridcompute/2024-05-20-preview/agentversions Documentation

The agentversions SDK allows for interaction with Azure Resource Manager hybridcompute (API Version 2024-05-20-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/hybridcompute/2024-05-20-preview/agentversions"

Client Initialization

client := agentversions.NewAgentVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AgentVersionsClient.AgentVersionGet

ctx := context.TODO()
id := agentversions.NewAgentVersionID("osTypeName", "agentVersionName")

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

Example Usage: AgentVersionsClient.AgentVersionList

ctx := context.TODO()
id := agentversions.NewOsTypeID("osTypeName")

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

Documentation

Index

• func ValidateAgentVersionID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateOsTypeID(input interface{}, key string) (warnings []string, errors []error)
• type AgentVersion
• type AgentVersionGetOperationResponse
• type AgentVersionId
  • func NewAgentVersionID(osTypeName string, agentVersionName string) AgentVersionId
  • func ParseAgentVersionID(input string) (*AgentVersionId, error)
  • func ParseAgentVersionIDInsensitively(input string) (*AgentVersionId, error)
  • func (id *AgentVersionId) FromParseResult(input resourceids.ParseResult) error
  • func (id AgentVersionId) ID() string
  • func (id AgentVersionId) Segments() []resourceids.Segment
  • func (id AgentVersionId) String() string
• type AgentVersionListCompleteResult
• type AgentVersionListCustomPager
  • func (p *AgentVersionListCustomPager) NextPageLink() *odata.Link
• type AgentVersionListOperationResponse
• type AgentVersionOperationPredicate
  • func (p AgentVersionOperationPredicate) Matches(input AgentVersion) bool
• type AgentVersionsClient
  • func NewAgentVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*AgentVersionsClient, error)
  • func (c AgentVersionsClient) AgentVersionGet(ctx context.Context, id AgentVersionId) (result AgentVersionGetOperationResponse, err error)
  • func (c AgentVersionsClient) AgentVersionList(ctx context.Context, id OsTypeId) (result AgentVersionListOperationResponse, err error)
  • func (c AgentVersionsClient) AgentVersionListComplete(ctx context.Context, id OsTypeId) (AgentVersionListCompleteResult, error)
  • func (c AgentVersionsClient) AgentVersionListCompleteMatchingPredicate(ctx context.Context, id OsTypeId, predicate AgentVersionOperationPredicate) (result AgentVersionListCompleteResult, err error)
• type OsTypeId
  • func NewOsTypeID(osTypeName string) OsTypeId
  • func ParseOsTypeID(input string) (*OsTypeId, error)
  • func ParseOsTypeIDInsensitively(input string) (*OsTypeId, error)
  • func (id *OsTypeId) FromParseResult(input resourceids.ParseResult) error
  • func (id OsTypeId) ID() string
  • func (id OsTypeId) Segments() []resourceids.Segment
  • func (id OsTypeId) String() string

Functions

func ValidateAgentVersionID

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

ValidateAgentVersionID checks that 'input' can be parsed as a Agent Version ID

func ValidateOsTypeID

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

ValidateOsTypeID checks that 'input' can be parsed as a Os Type ID

Types

type AgentVersion

type AgentVersion struct {
	AgentVersion *string `json:"agentVersion,omitempty"`
	DownloadLink *string `json:"downloadLink,omitempty"`
	OsType       *string `json:"osType,omitempty"`
}

type AgentVersionGetOperationResponse

type AgentVersionGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AgentVersion
}

type AgentVersionId

type AgentVersionId struct {
	OsTypeName       string
	AgentVersionName string
}

AgentVersionId is a struct representing the Resource ID for a Agent Version

func NewAgentVersionID

func NewAgentVersionID(osTypeName string, agentVersionName string) AgentVersionId

NewAgentVersionID returns a new AgentVersionId struct

func ParseAgentVersionID

func ParseAgentVersionID(input string) (*AgentVersionId, error)

ParseAgentVersionID parses 'input' into a AgentVersionId

func ParseAgentVersionIDInsensitively

func ParseAgentVersionIDInsensitively(input string) (*AgentVersionId, error)

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

func (*AgentVersionId) FromParseResult

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

func (AgentVersionId) ID

func (id AgentVersionId) ID() string

ID returns the formatted Agent Version ID

func (AgentVersionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Agent Version ID

func (AgentVersionId) String

func (id AgentVersionId) String() string

String returns a human-readable description of this Agent Version ID

type AgentVersionListCompleteResult

type AgentVersionListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AgentVersion
}

type AgentVersionListCustomPager

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

func (*AgentVersionListCustomPager) NextPageLink

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

type AgentVersionListOperationResponse

type AgentVersionListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AgentVersion
}

type AgentVersionOperationPredicate

type AgentVersionOperationPredicate struct {
	AgentVersion *string
	DownloadLink *string
	OsType       *string
}

func (AgentVersionOperationPredicate) Matches

func (p AgentVersionOperationPredicate) Matches(input AgentVersion) bool

type AgentVersionsClient

type AgentVersionsClient struct {
	Client *resourcemanager.Client
}

func NewAgentVersionsClientWithBaseURI

func NewAgentVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*AgentVersionsClient, error)

func (AgentVersionsClient) AgentVersionGet

func (c AgentVersionsClient) AgentVersionGet(ctx context.Context, id AgentVersionId) (result AgentVersionGetOperationResponse, err error)

AgentVersionGet ...

func (AgentVersionsClient) AgentVersionList

func (c AgentVersionsClient) AgentVersionList(ctx context.Context, id OsTypeId) (result AgentVersionListOperationResponse, err error)

AgentVersionList ...

func (AgentVersionsClient) AgentVersionListComplete

func (c AgentVersionsClient) AgentVersionListComplete(ctx context.Context, id OsTypeId) (AgentVersionListCompleteResult, error)

AgentVersionListComplete retrieves all the results into a single object

func (AgentVersionsClient) AgentVersionListCompleteMatchingPredicate

func (c AgentVersionsClient) AgentVersionListCompleteMatchingPredicate(ctx context.Context, id OsTypeId, predicate AgentVersionOperationPredicate) (result AgentVersionListCompleteResult, err error)

AgentVersionListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type OsTypeId

type OsTypeId struct {
	OsTypeName string
}

OsTypeId is a struct representing the Resource ID for a Os Type

func NewOsTypeID

func NewOsTypeID(osTypeName string) OsTypeId

NewOsTypeID returns a new OsTypeId struct

func ParseOsTypeID

func ParseOsTypeID(input string) (*OsTypeId, error)

ParseOsTypeID parses 'input' into a OsTypeId

func ParseOsTypeIDInsensitively

func ParseOsTypeIDInsensitively(input string) (*OsTypeId, error)

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

func (*OsTypeId) FromParseResult

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

func (OsTypeId) ID

func (id OsTypeId) ID() string

ID returns the formatted Os Type ID

func (OsTypeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Os Type ID

func (OsTypeId) String

func (id OsTypeId) String() string

String returns a human-readable description of this Os Type ID