sharedgalleryimages

package
v0.20230810.1112551 Latest Latest
Warning

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

 Go to latest Published: Aug 10, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2022-03-03/sharedgalleryimages Documentation

The sharedgalleryimages SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2022-03-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/2022-03-03/sharedgalleryimages"

Client Initialization

client := sharedgalleryimages.NewSharedGalleryImagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SharedGalleryImagesClient.Get

ctx := context.TODO()
id := sharedgalleryimages.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
}

Example Usage: SharedGalleryImagesClient.List

ctx := context.TODO()
id := sharedgalleryimages.NewSharedGalleryID("12345678-1234-9876-4563-123456789012", "locationValue", "sharedGalleryValue")

// alternatively `client.List(ctx, id, sharedgalleryimages.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, sharedgalleryimages.DefaultListOperationOptions())
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 PossibleValuesForSharedToValues 

func PossibleValuesForSharedToValues() []string

func ValidateImageID 

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

ValidateImageID checks that 'input' can be parsed as a Image ID

func ValidateSharedGalleryID 

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

ValidateSharedGalleryID checks that 'input' can be parsed as a Shared Gallery ID

Types

type Architecture 

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

func (*Architecture) UnmarshalJSON added in v0.20230808.1103829 

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

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        *SharedGalleryImage
}

type HyperVGeneration 

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

func (*HyperVGeneration) UnmarshalJSON added in v0.20230808.1103829 

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

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 ListCompleteResult 

type ListCompleteResult struct {
	Items []SharedGalleryImage
}

type ListOperationOptions 

type ListOperationOptions struct {
	SharedTo *SharedToValues
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230808.1103829 

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

func (ListOperationOptions) ToOData added in v0.20230808.1103829 

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

func (ListOperationOptions) ToQuery added in v0.20230808.1103829 

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

type ListOperationResponse 

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

type OperatingSystemStateTypes 

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

func (*OperatingSystemStateTypes) UnmarshalJSON added in v0.20230808.1103829 

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

type OperatingSystemTypes 

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

func (*OperatingSystemTypes) UnmarshalJSON added in v0.20230808.1103829 

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

type SharedGalleryId 

type SharedGalleryId struct {
	SubscriptionId    string
	LocationName      string
	SharedGalleryName string
}

SharedGalleryId is a struct representing the Resource ID for a Shared Gallery

func NewSharedGalleryID 

func NewSharedGalleryID(subscriptionId string, locationName string, sharedGalleryName string) SharedGalleryId

NewSharedGalleryID returns a new SharedGalleryId struct

func ParseSharedGalleryID 

func ParseSharedGalleryID(input string) (*SharedGalleryId, error)

ParseSharedGalleryID parses 'input' into a SharedGalleryId

func ParseSharedGalleryIDInsensitively 

func ParseSharedGalleryIDInsensitively(input string) (*SharedGalleryId, error)

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

func (SharedGalleryId) ID 

func (id SharedGalleryId) ID() string

ID returns the formatted Shared Gallery ID

func (SharedGalleryId) Segments 

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

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

func (SharedGalleryId) String 

func (id SharedGalleryId) String() string

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

type SharedGalleryIdentifier 

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

type SharedGalleryImage 

type SharedGalleryImage struct {
	Identifier *SharedGalleryIdentifier      `json:"identifier,omitempty"`
	Location   *string                       `json:"location,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *SharedGalleryImageProperties `json:"properties,omitempty"`
}

type SharedGalleryImageOperationPredicate 

type SharedGalleryImageOperationPredicate struct {
	Location *string
	Name     *string
}

func (SharedGalleryImageOperationPredicate) Matches 

func (p SharedGalleryImageOperationPredicate) Matches(input SharedGalleryImage) bool

type SharedGalleryImageProperties 

type SharedGalleryImageProperties struct {
	Architecture        *Architecture                    `json:"architecture,omitempty"`
	Disallowed          *Disallowed                      `json:"disallowed,omitempty"`
	EndOfLifeDate       *string                          `json:"endOfLifeDate,omitempty"`
	Eula                *string                          `json:"eula,omitempty"`
	Features            *[]GalleryImageFeature           `json:"features,omitempty"`
	HyperVGeneration    *HyperVGeneration                `json:"hyperVGeneration,omitempty"`
	Identifier          GalleryImageIdentifier           `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 (*SharedGalleryImageProperties) GetEndOfLifeDateAsTime 

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

func (*SharedGalleryImageProperties) SetEndOfLifeDateAsTime 

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

type SharedGalleryImagesClient 

type SharedGalleryImagesClient struct {
	Client *resourcemanager.Client
}

func NewSharedGalleryImagesClientWithBaseURI 

func NewSharedGalleryImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*SharedGalleryImagesClient, error)

func (SharedGalleryImagesClient) Get 

func (c SharedGalleryImagesClient) Get(ctx context.Context, id ImageId) (result GetOperationResponse, err error)

Get ...

func (SharedGalleryImagesClient) List 

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

List ...

func (SharedGalleryImagesClient) ListComplete 

func (c SharedGalleryImagesClient) ListComplete(ctx context.Context, id SharedGalleryId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SharedGalleryImagesClient) ListCompleteMatchingPredicate 

func (c SharedGalleryImagesClient) ListCompleteMatchingPredicate(ctx context.Context, id SharedGalleryId, options ListOperationOptions, predicate SharedGalleryImageOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SharedToValues 

type SharedToValues string
const (
	SharedToValuesTenant SharedToValues = "tenant"
)

func (*SharedToValues) UnmarshalJSON added in v0.20230808.1103829 

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

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.