communitygalleryimages

package
v0.20240624.1135538 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 24, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-07-03/communitygalleryimages Documentation

The communitygalleryimages SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2023-07-03).

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/2023-07-03/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", "locationValue", "communityGalleryValue", "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
}

Example Usage: CommunityGalleryImagesClient.List

ctx := context.TODO()
id := communitygalleryimages.NewCommunityGalleryID("12345678-1234-9876-4563-123456789012", "locationValue", "communityGalleryValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForArchitecture 

func PossibleValuesForArchitecture() []string

func PossibleValuesForHyperVGeneration 

func PossibleValuesForHyperVGeneration() []string

func PossibleValuesForOperatingSystemStateTypes 

func PossibleValuesForOperatingSystemStateTypes() []string

func PossibleValuesForOperatingSystemTypes 

func PossibleValuesForOperatingSystemTypes() []string

func ValidateCommunityGalleryID 

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

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

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 Architecture 

type Architecture string
const (
	ArchitectureArmSixFour Architecture = "Arm64"
	ArchitectureXSixFour   Architecture = "x64"
)

func (*Architecture) UnmarshalJSON 

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

type CommunityGalleryDisclaimer 

type CommunityGalleryDisclaimer struct {
	Disclaimer *string `json:"disclaimer,omitempty"`
}

type CommunityGalleryId 

type CommunityGalleryId struct {
	SubscriptionId       string
	LocationName         string
	CommunityGalleryName string
}

CommunityGalleryId is a struct representing the Resource ID for a Community Gallery

func NewCommunityGalleryID 

func NewCommunityGalleryID(subscriptionId string, locationName string, communityGalleryName string) CommunityGalleryId

NewCommunityGalleryID returns a new CommunityGalleryId struct

func ParseCommunityGalleryID 

func ParseCommunityGalleryID(input string) (*CommunityGalleryId, error)

ParseCommunityGalleryID parses 'input' into a CommunityGalleryId

func ParseCommunityGalleryIDInsensitively 

func ParseCommunityGalleryIDInsensitively(input string) (*CommunityGalleryId, error)

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

func (*CommunityGalleryId) FromParseResult 

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

func (CommunityGalleryId) ID 

func (id CommunityGalleryId) ID() string

ID returns the formatted Community Gallery ID

func (CommunityGalleryId) Segments 

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

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

func (CommunityGalleryId) String 

func (id CommunityGalleryId) String() string

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

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 CommunityGalleryImageIdentifier 

type CommunityGalleryImageIdentifier struct {
	Offer     *string `json:"offer,omitempty"`
	Publisher *string `json:"publisher,omitempty"`
	Sku       *string `json:"sku,omitempty"`
}

type CommunityGalleryImageOperationPredicate 

type CommunityGalleryImageOperationPredicate struct {
	Location *string
	Name     *string
	Type     *string
}

func (CommunityGalleryImageOperationPredicate) Matches 

func (p CommunityGalleryImageOperationPredicate) Matches(input CommunityGalleryImage) bool

type CommunityGalleryImageProperties 

type CommunityGalleryImageProperties struct {
	Architecture        *Architecture                    `json:"architecture,omitempty"`
	ArtifactTags        *map[string]string               `json:"artifactTags,omitempty"`
	Disallowed          *Disallowed                      `json:"disallowed,omitempty"`
	Disclaimer          *CommunityGalleryDisclaimer      `json:"disclaimer,omitempty"`
	EndOfLifeDate       *string                          `json:"endOfLifeDate,omitempty"`
	Eula                *string                          `json:"eula,omitempty"`
	Features            *[]GalleryImageFeature           `json:"features,omitempty"`
	HyperVGeneration    *HyperVGeneration                `json:"hyperVGeneration,omitempty"`
	Identifier          CommunityGalleryImageIdentifier  `json:"identifier"`
	OsState             OperatingSystemStateTypes        `json:"osState"`
	OsType              OperatingSystemTypes             `json:"osType"`
	PrivacyStatementUri *string                          `json:"privacyStatementUri,omitempty"`
	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 ...

func (CommunityGalleryImagesClient) List 

func (c CommunityGalleryImagesClient) List(ctx context.Context, id CommunityGalleryId) (result ListOperationResponse, err error)

List ...

func (CommunityGalleryImagesClient) ListComplete 

func (c CommunityGalleryImagesClient) ListComplete(ctx context.Context, id CommunityGalleryId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (CommunityGalleryImagesClient) ListCompleteMatchingPredicate 

func (c CommunityGalleryImagesClient) ListCompleteMatchingPredicate(ctx context.Context, id CommunityGalleryId, predicate CommunityGalleryImageOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 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 ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CommunityGalleryImage
}

type ListOperationResponse 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.