communitygalleryimages

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2021-07-01/communitygalleryimages Documentation

The communitygalleryimages SDK allows for interaction with Azure Resource Manager compute (API Version 2021-07-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/compute/2021-07-01/communitygalleryimages"

Client Initialization

client := communitygalleryimages.NewCommunityGalleryImagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CommunityGalleryImagesClient.Get

ctx := context.TODO()
id := communitygalleryimages.NewCommunityGalleryImageID("12345678-1234-9876-4563-123456789012", "locationName", "communityGalleryName", "imageName")

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

Documentation

Index

• func PossibleValuesForHyperVGeneration() []string
• func PossibleValuesForOperatingSystemStateTypes() []string
• func PossibleValuesForOperatingSystemTypes() []string
• func ValidateCommunityGalleryImageID(input interface{}, key string) (warnings []string, errors []error)
• type CommunityGalleryIdentifier
• type CommunityGalleryImage
• type CommunityGalleryImageId
  • func NewCommunityGalleryImageID(subscriptionId string, locationName string, communityGalleryName string, ...) CommunityGalleryImageId
  • func ParseCommunityGalleryImageID(input string) (*CommunityGalleryImageId, error)
  • func ParseCommunityGalleryImageIDInsensitively(input string) (*CommunityGalleryImageId, error)
  • func (id *CommunityGalleryImageId) FromParseResult(input resourceids.ParseResult) error
  • func (id CommunityGalleryImageId) ID() string
  • func (id CommunityGalleryImageId) Segments() []resourceids.Segment
  • func (id CommunityGalleryImageId) String() string
• type CommunityGalleryImageProperties
  • func (o *CommunityGalleryImageProperties) GetEndOfLifeDateAsTime() (*time.Time, error)
  • func (o *CommunityGalleryImageProperties) SetEndOfLifeDateAsTime(input time.Time)
• type CommunityGalleryImagesClient
  • func NewCommunityGalleryImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*CommunityGalleryImagesClient, error)
  • func (c CommunityGalleryImagesClient) Get(ctx context.Context, id CommunityGalleryImageId) (result GetOperationResponse, err error)
• type Disallowed
• type GalleryImageFeature
• type GalleryImageIdentifier
• type GetOperationResponse
• type HyperVGeneration
  • func (s *HyperVGeneration) UnmarshalJSON(bytes []byte) error
• type ImagePurchasePlan
• type OperatingSystemStateTypes
  • func (s *OperatingSystemStateTypes) UnmarshalJSON(bytes []byte) error
• type OperatingSystemTypes
  • func (s *OperatingSystemTypes) UnmarshalJSON(bytes []byte) error
• type RecommendedMachineConfiguration
• type ResourceRange

Functions

func PossibleValuesForHyperVGeneration

func PossibleValuesForHyperVGeneration() []string

func PossibleValuesForOperatingSystemStateTypes

func PossibleValuesForOperatingSystemStateTypes() []string

func PossibleValuesForOperatingSystemTypes

func PossibleValuesForOperatingSystemTypes() []string

func ValidateCommunityGalleryImageID

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

ValidateCommunityGalleryImageID checks that 'input' can be parsed as a Community Gallery Image ID

Types

type CommunityGalleryIdentifier

type CommunityGalleryIdentifier struct {
	UniqueId *string `json:"uniqueId,omitempty"`
}

type CommunityGalleryImage

type CommunityGalleryImage struct {
	Identifier *CommunityGalleryIdentifier      `json:"identifier,omitempty"`
	Location   *string                          `json:"location,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *CommunityGalleryImageProperties `json:"properties,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type CommunityGalleryImageId

type CommunityGalleryImageId struct {
	SubscriptionId       string
	LocationName         string
	CommunityGalleryName string
	ImageName            string
}

CommunityGalleryImageId is a struct representing the Resource ID for a Community Gallery Image

func NewCommunityGalleryImageID

func NewCommunityGalleryImageID(subscriptionId string, locationName string, communityGalleryName string, imageName string) CommunityGalleryImageId

NewCommunityGalleryImageID returns a new CommunityGalleryImageId struct

func ParseCommunityGalleryImageID

func ParseCommunityGalleryImageID(input string) (*CommunityGalleryImageId, error)

ParseCommunityGalleryImageID parses 'input' into a CommunityGalleryImageId

func ParseCommunityGalleryImageIDInsensitively

func ParseCommunityGalleryImageIDInsensitively(input string) (*CommunityGalleryImageId, error)

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

func (*CommunityGalleryImageId) FromParseResult

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

func (CommunityGalleryImageId) ID

func (id CommunityGalleryImageId) ID() string

ID returns the formatted Community Gallery Image ID

func (CommunityGalleryImageId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Community Gallery Image ID

func (CommunityGalleryImageId) String

func (id CommunityGalleryImageId) String() string

String returns a human-readable description of this Community Gallery Image ID

type CommunityGalleryImageProperties

type CommunityGalleryImageProperties struct {
	Disallowed       *Disallowed                      `json:"disallowed,omitempty"`
	EndOfLifeDate    *string                          `json:"endOfLifeDate,omitempty"`
	Features         *[]GalleryImageFeature           `json:"features,omitempty"`
	HyperVGeneration *HyperVGeneration                `json:"hyperVGeneration,omitempty"`
	Identifier       GalleryImageIdentifier           `json:"identifier"`
	OsState          OperatingSystemStateTypes        `json:"osState"`
	OsType           OperatingSystemTypes             `json:"osType"`
	PurchasePlan     *ImagePurchasePlan               `json:"purchasePlan,omitempty"`
	Recommended      *RecommendedMachineConfiguration `json:"recommended,omitempty"`
}

func (*CommunityGalleryImageProperties) GetEndOfLifeDateAsTime

func (o *CommunityGalleryImageProperties) GetEndOfLifeDateAsTime() (*time.Time, error)

func (*CommunityGalleryImageProperties) SetEndOfLifeDateAsTime

func (o *CommunityGalleryImageProperties) SetEndOfLifeDateAsTime(input time.Time)

type CommunityGalleryImagesClient

type CommunityGalleryImagesClient struct {
	Client *resourcemanager.Client
}

func NewCommunityGalleryImagesClientWithBaseURI

func NewCommunityGalleryImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*CommunityGalleryImagesClient, error)

func (CommunityGalleryImagesClient) Get

func (c CommunityGalleryImagesClient) Get(ctx context.Context, id CommunityGalleryImageId) (result GetOperationResponse, err error)

Get ...

type Disallowed

type Disallowed struct {
	DiskTypes *[]string `json:"diskTypes,omitempty"`
}

type GalleryImageFeature

type GalleryImageFeature struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type GalleryImageIdentifier

type GalleryImageIdentifier struct {
	Offer     string `json:"offer"`
	Publisher string `json:"publisher"`
	Sku       string `json:"sku"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CommunityGalleryImage
}

type HyperVGeneration

type HyperVGeneration string

const (
	HyperVGenerationVOne HyperVGeneration = "V1"
	HyperVGenerationVTwo HyperVGeneration = "V2"
)

func (*HyperVGeneration) UnmarshalJSON

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

type ImagePurchasePlan

type ImagePurchasePlan struct {
	Name      *string `json:"name,omitempty"`
	Product   *string `json:"product,omitempty"`
	Publisher *string `json:"publisher,omitempty"`
}

type OperatingSystemStateTypes

type OperatingSystemStateTypes string

const (
	OperatingSystemStateTypesGeneralized OperatingSystemStateTypes = "Generalized"
	OperatingSystemStateTypesSpecialized OperatingSystemStateTypes = "Specialized"
)

func (*OperatingSystemStateTypes) UnmarshalJSON

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

type OperatingSystemTypes

type OperatingSystemTypes string

const (
	OperatingSystemTypesLinux   OperatingSystemTypes = "Linux"
	OperatingSystemTypesWindows OperatingSystemTypes = "Windows"
)

func (*OperatingSystemTypes) UnmarshalJSON

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

type RecommendedMachineConfiguration

type RecommendedMachineConfiguration struct {
	Memory *ResourceRange `json:"memory,omitempty"`
	VCPUs  *ResourceRange `json:"vCPUs,omitempty"`
}

type ResourceRange

type ResourceRange struct {
	Max *int64 `json:"max,omitempty"`
	Min *int64 `json:"min,omitempty"`
}