galleryimages

README

github.com/hashicorp/go-azure-sdk/resource-manager/devtestlab/2018-09-15/galleryimages Documentation

The galleryimages SDK allows for interaction with the Azure Resource Manager Service devtestlab (API Version 2018-09-15).

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/devtestlab/2018-09-15/galleryimages"

Client Initialization

client := galleryimages.NewGalleryImagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GalleryImagesClient.List

ctx := context.TODO()
id := galleryimages.NewLabID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue")

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

Documentation

Index

• func ValidateLabID(input interface{}, key string) (warnings []string, errors []error)
• type GalleryImage
• type GalleryImageOperationPredicate
  • func (p GalleryImageOperationPredicate) Matches(input GalleryImage) bool
• type GalleryImageProperties
  • func (o *GalleryImageProperties) GetCreatedDateAsTime() (*time.Time, error)
  • func (o *GalleryImageProperties) SetCreatedDateAsTime(input time.Time)
• type GalleryImageReference
• type GalleryImagesClient
  • func NewGalleryImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*GalleryImagesClient, error)
  • func (c GalleryImagesClient) List(ctx context.Context, id LabId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c GalleryImagesClient) ListComplete(ctx context.Context, id LabId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c GalleryImagesClient) ListCompleteMatchingPredicate(ctx context.Context, id LabId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• type LabId
  • func NewLabID(subscriptionId string, resourceGroupName string, labName string) LabId
  • func ParseLabID(input string) (*LabId, error)
  • func ParseLabIDInsensitively(input string) (*LabId, error)
  • func (id LabId) ID() string
  • func (id LabId) Segments() []resourceids.Segment
  • func (id LabId) String() string
• type ListCompleteResult
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse

Functions

func ValidateLabID

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

ValidateLabID checks that 'input' can be parsed as a Lab ID

Types

type GalleryImage

type GalleryImage struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties GalleryImageProperties `json:"properties"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type GalleryImageOperationPredicate

type GalleryImageOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (GalleryImageOperationPredicate) Matches

func (p GalleryImageOperationPredicate) Matches(input GalleryImage) bool

type GalleryImageProperties

type GalleryImageProperties struct {
	Author           *string                `json:"author,omitempty"`
	CreatedDate      *string                `json:"createdDate,omitempty"`
	Description      *string                `json:"description,omitempty"`
	Enabled          *bool                  `json:"enabled,omitempty"`
	Icon             *string                `json:"icon,omitempty"`
	ImageReference   *GalleryImageReference `json:"imageReference,omitempty"`
	IsPlanAuthorized *bool                  `json:"isPlanAuthorized,omitempty"`
	PlanId           *string                `json:"planId,omitempty"`
}

func (*GalleryImageProperties) GetCreatedDateAsTime

func (o *GalleryImageProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*GalleryImageProperties) SetCreatedDateAsTime

func (o *GalleryImageProperties) SetCreatedDateAsTime(input time.Time)

type GalleryImageReference

type GalleryImageReference struct {
	Offer     *string `json:"offer,omitempty"`
	OsType    *string `json:"osType,omitempty"`
	Publisher *string `json:"publisher,omitempty"`
	Sku       *string `json:"sku,omitempty"`
	Version   *string `json:"version,omitempty"`
}

type GalleryImagesClient

type GalleryImagesClient struct {
	Client *resourcemanager.Client
}

func NewGalleryImagesClientWithBaseURI

func NewGalleryImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*GalleryImagesClient, error)

func (GalleryImagesClient) List

func (c GalleryImagesClient) List(ctx context.Context, id LabId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (GalleryImagesClient) ListComplete

func (c GalleryImagesClient) ListComplete(ctx context.Context, id LabId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (GalleryImagesClient) ListCompleteMatchingPredicate

func (c GalleryImagesClient) ListCompleteMatchingPredicate(ctx context.Context, id LabId, options ListOperationOptions, predicate GalleryImageOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type LabId

type LabId struct {
	SubscriptionId    string
	ResourceGroupName string
	LabName           string
}

LabId is a struct representing the Resource ID for a Lab

func NewLabID

func NewLabID(subscriptionId string, resourceGroupName string, labName string) LabId

NewLabID returns a new LabId struct

func ParseLabID

func ParseLabID(input string) (*LabId, error)

ParseLabID parses 'input' into a LabId

func ParseLabIDInsensitively

func ParseLabIDInsensitively(input string) (*LabId, error)

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

func (LabId) ID

func (id LabId) ID() string

ID returns the formatted Lab ID

func (LabId) Segments

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

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

func (LabId) String

func (id LabId) String() string

String returns a human-readable description of this Lab ID

type ListCompleteResult

type ListCompleteResult struct {
	Items []GalleryImage
}

type ListOperationOptions

type ListOperationOptions struct {
	Expand  *string
	Filter  *string
	Orderby *string
	Top     *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GalleryImage
}