resourcedetails

README

github.com/hashicorp/go-azure-sdk/resource-manager/devopsinfrastructure/2024-04-04-preview/resourcedetails Documentation

The resourcedetails SDK allows for interaction with Azure Resource Manager devopsinfrastructure (API Version 2024-04-04-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/devopsinfrastructure/2024-04-04-preview/resourcedetails"

Client Initialization

client := resourcedetails.NewResourceDetailsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceDetailsClient.ListByPool

ctx := context.TODO()
id := resourcedetails.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "poolName")

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

Documentation

Index

• func PossibleValuesForResourceStatus() []string
• func ValidatePoolID(input interface{}, key string) (warnings []string, errors []error)
• type ListByPoolCompleteResult
• type ListByPoolCustomPager
  • func (p *ListByPoolCustomPager) NextPageLink() *odata.Link
• type ListByPoolOperationResponse
• type PoolId
  • func NewPoolID(subscriptionId string, resourceGroupName string, poolName string) PoolId
  • func ParsePoolID(input string) (*PoolId, error)
  • func ParsePoolIDInsensitively(input string) (*PoolId, error)
  • func (id *PoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id PoolId) ID() string
  • func (id PoolId) Segments() []resourceids.Segment
  • func (id PoolId) String() string
• type ResourceDetailsClient
  • func NewResourceDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceDetailsClient, error)
  • func (c ResourceDetailsClient) ListByPool(ctx context.Context, id PoolId) (result ListByPoolOperationResponse, err error)
  • func (c ResourceDetailsClient) ListByPoolComplete(ctx context.Context, id PoolId) (ListByPoolCompleteResult, error)
  • func (c ResourceDetailsClient) ListByPoolCompleteMatchingPredicate(ctx context.Context, id PoolId, ...) (result ListByPoolCompleteResult, err error)
• type ResourceDetailsObject
• type ResourceDetailsObjectOperationPredicate
  • func (p ResourceDetailsObjectOperationPredicate) Matches(input ResourceDetailsObject) bool
• type ResourceDetailsObjectProperties
• type ResourceStatus
  • func (s *ResourceStatus) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForResourceStatus

func PossibleValuesForResourceStatus() []string

func ValidatePoolID

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

ValidatePoolID checks that 'input' can be parsed as a Pool ID

Types

type ListByPoolCompleteResult

type ListByPoolCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceDetailsObject
}

type ListByPoolCustomPager

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

func (*ListByPoolCustomPager) NextPageLink

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

type ListByPoolOperationResponse

type ListByPoolOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceDetailsObject
}

type PoolId

type PoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	PoolName          string
}

PoolId is a struct representing the Resource ID for a Pool

func NewPoolID

func NewPoolID(subscriptionId string, resourceGroupName string, poolName string) PoolId

NewPoolID returns a new PoolId struct

func ParsePoolID

func ParsePoolID(input string) (*PoolId, error)

ParsePoolID parses 'input' into a PoolId

func ParsePoolIDInsensitively

func ParsePoolIDInsensitively(input string) (*PoolId, error)

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

func (*PoolId) FromParseResult

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

func (PoolId) ID

func (id PoolId) ID() string

ID returns the formatted Pool ID

func (PoolId) Segments

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

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

func (PoolId) String

func (id PoolId) String() string

String returns a human-readable description of this Pool ID

type ResourceDetailsClient

type ResourceDetailsClient struct {
	Client *resourcemanager.Client
}

func NewResourceDetailsClientWithBaseURI

func NewResourceDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceDetailsClient, error)

func (ResourceDetailsClient) ListByPool

func (c ResourceDetailsClient) ListByPool(ctx context.Context, id PoolId) (result ListByPoolOperationResponse, err error)

ListByPool ...

func (ResourceDetailsClient) ListByPoolComplete

func (c ResourceDetailsClient) ListByPoolComplete(ctx context.Context, id PoolId) (ListByPoolCompleteResult, error)

ListByPoolComplete retrieves all the results into a single object

func (ResourceDetailsClient) ListByPoolCompleteMatchingPredicate

func (c ResourceDetailsClient) ListByPoolCompleteMatchingPredicate(ctx context.Context, id PoolId, predicate ResourceDetailsObjectOperationPredicate) (result ListByPoolCompleteResult, err error)

ListByPoolCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ResourceDetailsObject

type ResourceDetailsObject struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *ResourceDetailsObjectProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData           `json:"systemData,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type ResourceDetailsObjectOperationPredicate

type ResourceDetailsObjectOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ResourceDetailsObjectOperationPredicate) Matches

func (p ResourceDetailsObjectOperationPredicate) Matches(input ResourceDetailsObject) bool

type ResourceDetailsObjectProperties

type ResourceDetailsObjectProperties struct {
	Image        string         `json:"image"`
	ImageVersion string         `json:"imageVersion"`
	Status       ResourceStatus `json:"status"`
}

type ResourceStatus

type ResourceStatus string

const (
	ResourceStatusAllocated      ResourceStatus = "Allocated"
	ResourceStatusLeased         ResourceStatus = "Leased"
	ResourceStatusNotReady       ResourceStatus = "NotReady"
	ResourceStatusPendingReimage ResourceStatus = "PendingReimage"
	ResourceStatusPendingReturn  ResourceStatus = "PendingReturn"
	ResourceStatusProvisioning   ResourceStatus = "Provisioning"
	ResourceStatusReady          ResourceStatus = "Ready"
	ResourceStatusReimaging      ResourceStatus = "Reimaging"
	ResourceStatusReturned       ResourceStatus = "Returned"
	ResourceStatusStarting       ResourceStatus = "Starting"
	ResourceStatusUpdating       ResourceStatus = "Updating"
)

func (*ResourceStatus) UnmarshalJSON

func (s *ResourceStatus) UnmarshalJSON(bytes []byte) error