communitygalleryimages

README

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

The communitygalleryimages SDK allows for interaction with the Azure Resource Manager Service 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.NewImageID("12345678-1234-9876-4563-123456789012", "locationValue", "sharedGalleryValue", "imageValue")

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 ValidateImageID(input interface{}, key string) (warnings []string, errors []error)
• type CommunityGalleryIdentifier
• type CommunityGalleryImage
• type CommunityGalleryImageProperties
  • func (o *CommunityGalleryImageProperties) GetEndOfLifeDateAsTime() (*time.Time, error)
  • func (o *CommunityGalleryImageProperties) SetEndOfLifeDateAsTime(input time.Time)
• type CommunityGalleryImagesClient
  • func NewCommunityGalleryImagesClientWithBaseURI(endpoint string) CommunityGalleryImagesClient
  • func (c CommunityGalleryImagesClient) Get(ctx context.Context, id ImageId) (result GetOperationResponse, err error)
• type Disallowed
• type GalleryImageFeature
• type GalleryImageIdentifier
• type GetOperationResponse
• type HyperVGeneration
• type ImageId
  • func NewImageID(subscriptionId string, locationName string, sharedGalleryName string, ...) ImageId
  • func ParseImageID(input string) (*ImageId, error)
  • func ParseImageIDInsensitively(input string) (*ImageId, error)
  • func (id ImageId) ID() string
  • func (id ImageId) Segments() []resourceids.Segment
  • func (id ImageId) String() string
• type ImagePurchasePlan
• type OperatingSystemStateTypes
• type OperatingSystemTypes
• type RecommendedMachineConfiguration
• type ResourceRange

Functions

func PossibleValuesForHyperVGeneration

func PossibleValuesForHyperVGeneration() []string

func PossibleValuesForOperatingSystemStateTypes

func PossibleValuesForOperatingSystemStateTypes() []string

func PossibleValuesForOperatingSystemTypes

func PossibleValuesForOperatingSystemTypes() []string

func ValidateImageID

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

ValidateImageID checks that 'input' can be parsed as a 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 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 autorest.Client
	// contains filtered or unexported fields
}

func NewCommunityGalleryImagesClientWithBaseURI

func NewCommunityGalleryImagesClientWithBaseURI(endpoint string) CommunityGalleryImagesClient

func (CommunityGalleryImagesClient) Get

func (c CommunityGalleryImagesClient) Get(ctx context.Context, id ImageId) (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
	Model        *CommunityGalleryImage
}

type HyperVGeneration

type HyperVGeneration string

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

type ImageId

type ImageId struct {
	SubscriptionId    string
	LocationName      string
	SharedGalleryName string
	ImageName         string
}

ImageId is a struct representing the Resource ID for a Image

func NewImageID

func NewImageID(subscriptionId string, locationName string, sharedGalleryName string, imageName string) ImageId

NewImageID returns a new ImageId struct

func ParseImageID

func ParseImageID(input string) (*ImageId, error)

ParseImageID parses 'input' into a ImageId

func ParseImageIDInsensitively

func ParseImageIDInsensitively(input string) (*ImageId, error)

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

func (ImageId) ID

func (id ImageId) ID() string

ID returns the formatted Image ID

func (ImageId) Segments

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

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

func (ImageId) String

func (id ImageId) String() string

String returns a human-readable description of this Image ID

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"
)

type OperatingSystemTypes

type OperatingSystemTypes string

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

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"`
}