imageversions

package
v0.20231127.1195240 Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2023-04-01/imageversions Documentation

The imageversions SDK allows for interaction with the Azure Resource Manager Service devcenter (API Version 2023-04-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/devcenter/2023-04-01/imageversions"

Client Initialization

client := imageversions.NewImageVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ImageVersionsClient.Get

ctx := context.TODO()
id := imageversions.NewVersionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "galleryValue", "imageValue", "versionValue")

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: ImageVersionsClient.ListByImage

ctx := context.TODO()
id := imageversions.NewImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "devCenterValue", "galleryValue", "imageValue")

// alternatively `client.ListByImage(ctx, id)` can be used to do batched pagination
items, err := client.ListByImageComplete(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 PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []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        *ImageVersion
}

type ImageId 

type ImageId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
	GalleryName       string
	ImageName         string
}

ImageId is a struct representing the Resource ID for a Image

func NewImageID 

func NewImageID(subscriptionId string, resourceGroupName string, devCenterName string, galleryName 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 added in v0.20231127.1171502 

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 ImageVersion 

type ImageVersion struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *ImageVersionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type ImageVersionOperationPredicate 

type ImageVersionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ImageVersionOperationPredicate) Matches 

func (p ImageVersionOperationPredicate) Matches(input ImageVersion) bool

type ImageVersionProperties 

type ImageVersionProperties struct {
	ExcludeFromLatest   *bool              `json:"excludeFromLatest,omitempty"`
	Name                *string            `json:"name,omitempty"`
	OsDiskImageSizeInGb *int64             `json:"osDiskImageSizeInGb,omitempty"`
	ProvisioningState   *ProvisioningState `json:"provisioningState,omitempty"`
	PublishedDate       *string            `json:"publishedDate,omitempty"`
}

func (*ImageVersionProperties) GetPublishedDateAsTime 

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

func (*ImageVersionProperties) SetPublishedDateAsTime 

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

type ImageVersionsClient 

type ImageVersionsClient struct {
	Client *resourcemanager.Client
}

func NewImageVersionsClientWithBaseURI 

func NewImageVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ImageVersionsClient, error)

func (ImageVersionsClient) Get 

func (c ImageVersionsClient) Get(ctx context.Context, id VersionId) (result GetOperationResponse, err error)

Get ...

func (ImageVersionsClient) ListByImage 

func (c ImageVersionsClient) ListByImage(ctx context.Context, id ImageId) (result ListByImageOperationResponse, err error)

ListByImage ...

func (ImageVersionsClient) ListByImageComplete 

func (c ImageVersionsClient) ListByImageComplete(ctx context.Context, id ImageId) (ListByImageCompleteResult, error)

ListByImageComplete retrieves all the results into a single object

func (ImageVersionsClient) ListByImageCompleteMatchingPredicate 

func (c ImageVersionsClient) ListByImageCompleteMatchingPredicate(ctx context.Context, id ImageId, predicate ImageVersionOperationPredicate) (result ListByImageCompleteResult, err error)

ListByImageCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByImageCompleteResult 

type ListByImageCompleteResult struct {
	Items []ImageVersion
}

type ListByImageOperationResponse 

type ListByImageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ImageVersion
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted                  ProvisioningState = "Accepted"
	ProvisioningStateCanceled                  ProvisioningState = "Canceled"
	ProvisioningStateCreated                   ProvisioningState = "Created"
	ProvisioningStateCreating                  ProvisioningState = "Creating"
	ProvisioningStateDeleted                   ProvisioningState = "Deleted"
	ProvisioningStateDeleting                  ProvisioningState = "Deleting"
	ProvisioningStateFailed                    ProvisioningState = "Failed"
	ProvisioningStateMovingResources           ProvisioningState = "MovingResources"
	ProvisioningStateNotSpecified              ProvisioningState = "NotSpecified"
	ProvisioningStateRolloutInProgress         ProvisioningState = "RolloutInProgress"
	ProvisioningStateRunning                   ProvisioningState = "Running"
	ProvisioningStateStorageProvisioningFailed ProvisioningState = "StorageProvisioningFailed"
	ProvisioningStateSucceeded                 ProvisioningState = "Succeeded"
	ProvisioningStateTransientFailure          ProvisioningState = "TransientFailure"
	ProvisioningStateUpdated                   ProvisioningState = "Updated"
	ProvisioningStateUpdating                  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type VersionId 

type VersionId struct {
	SubscriptionId    string
	ResourceGroupName string
	DevCenterName     string
	GalleryName       string
	ImageName         string
	VersionName       string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID 

func NewVersionID(subscriptionId string, resourceGroupName string, devCenterName string, galleryName 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 added in v0.20231127.1171502 

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

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.