sharedgalleryimageversions

package
v0.20240927.1005214 Latest Latest
Warning

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

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

README

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

The sharedgalleryimageversions SDK allows for interaction with Azure Resource Manager 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/sharedgalleryimageversions"

Client Initialization

client := sharedgalleryimageversions.NewSharedGalleryImageVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SharedGalleryImageVersionsClient.Get

ctx := context.TODO()
id := sharedgalleryimageversions.NewVersionID("12345678-1234-9876-4563-123456789012", "location", "galleryUniqueName", "galleryImageName", "galleryImageVersionName")

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: SharedGalleryImageVersionsClient.List

ctx := context.TODO()
id := sharedgalleryimageversions.NewImageID("12345678-1234-9876-4563-123456789012", "location", "galleryUniqueName", "galleryImageName")

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

func PossibleValuesForSharedGalleryHostCaching() []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 ValidateVersionID

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

ValidateVersionID checks that 'input' can be parsed as a Version ID

Types

type GetOperationResponse

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

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

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

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 ListCompleteResult

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

type ListCustomPager added in v0.20240628.1153531

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions

type ListOperationOptions struct {
	SharedTo *SharedToValues
}

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

type ListOperationResponse

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

type SharedGalleryDataDiskImage

type SharedGalleryDataDiskImage struct {
	DiskSizeGB  *int64                    `json:"diskSizeGB,omitempty"`
	HostCaching *SharedGalleryHostCaching `json:"hostCaching,omitempty"`
	Lun         int64                     `json:"lun"`
}

type SharedGalleryDiskImage

type SharedGalleryDiskImage struct {
	DiskSizeGB  *int64                    `json:"diskSizeGB,omitempty"`
	HostCaching *SharedGalleryHostCaching `json:"hostCaching,omitempty"`
}

type SharedGalleryHostCaching

type SharedGalleryHostCaching string
const (
	SharedGalleryHostCachingNone      SharedGalleryHostCaching = "None"
	SharedGalleryHostCachingReadOnly  SharedGalleryHostCaching = "ReadOnly"
	SharedGalleryHostCachingReadWrite SharedGalleryHostCaching = "ReadWrite"
)

func (*SharedGalleryHostCaching) UnmarshalJSON

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

type SharedGalleryIdentifier

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

type SharedGalleryImageVersion

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

type SharedGalleryImageVersionOperationPredicate

type SharedGalleryImageVersionOperationPredicate struct {
	Location *string
	Name     *string
}

func (SharedGalleryImageVersionOperationPredicate) Matches

type SharedGalleryImageVersionProperties

type SharedGalleryImageVersionProperties struct {
	ArtifactTags      *map[string]string                       `json:"artifactTags,omitempty"`
	EndOfLifeDate     *string                                  `json:"endOfLifeDate,omitempty"`
	ExcludeFromLatest *bool                                    `json:"excludeFromLatest,omitempty"`
	PublishedDate     *string                                  `json:"publishedDate,omitempty"`
	StorageProfile    *SharedGalleryImageVersionStorageProfile `json:"storageProfile,omitempty"`
}

func (*SharedGalleryImageVersionProperties) GetEndOfLifeDateAsTime

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

func (*SharedGalleryImageVersionProperties) GetPublishedDateAsTime

func (o *SharedGalleryImageVersionProperties) GetPublishedDateAsTime() (*time.Time, error)

func (*SharedGalleryImageVersionProperties) SetEndOfLifeDateAsTime

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

func (*SharedGalleryImageVersionProperties) SetPublishedDateAsTime

func (o *SharedGalleryImageVersionProperties) SetPublishedDateAsTime(input time.Time)

type SharedGalleryImageVersionStorageProfile

type SharedGalleryImageVersionStorageProfile struct {
	DataDiskImages *[]SharedGalleryDataDiskImage `json:"dataDiskImages,omitempty"`
	OsDiskImage    *SharedGalleryDiskImage       `json:"osDiskImage,omitempty"`
}

type SharedGalleryImageVersionsClient

type SharedGalleryImageVersionsClient struct {
	Client *resourcemanager.Client
}

func NewSharedGalleryImageVersionsClientWithBaseURI

func NewSharedGalleryImageVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*SharedGalleryImageVersionsClient, error)

func (SharedGalleryImageVersionsClient) Get

Get ...

func (SharedGalleryImageVersionsClient) List

List ...

func (SharedGalleryImageVersionsClient) ListComplete

ListComplete retrieves all the results into a single object

func (SharedGalleryImageVersionsClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SharedToValues

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

func (*SharedToValues) UnmarshalJSON

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

type VersionId

type VersionId struct {
	SubscriptionId    string
	LocationName      string
	SharedGalleryName string
	ImageName         string
	VersionName       string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID

func NewVersionID(subscriptionId string, locationName string, sharedGalleryName string, imageName string, versionName string) VersionId

NewVersionID returns a new VersionId struct

func ParseVersionID

func ParseVersionID(input string) (*VersionId, error)

ParseVersionID parses 'input' into a VersionId

func ParseVersionIDInsensitively

func ParseVersionIDInsensitively(input string) (*VersionId, error)

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

func (*VersionId) FromParseResult

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

func (VersionId) ID

func (id VersionId) ID() string

ID returns the formatted Version ID

func (VersionId) Segments

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

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

func (VersionId) String

func (id VersionId) String() string

String returns a human-readable description of this Version ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL