marketplacegalleryimages

package
v0.20240227.1165506 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-09-01-preview/marketplacegalleryimages Documentation

The marketplacegalleryimages SDK allows for interaction with the Azure Resource Manager Service azurestackhci (API Version 2023-09-01-preview).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/azurestackhci/2023-09-01-preview/marketplacegalleryimages"

Client Initialization

client := marketplacegalleryimages.NewMarketplaceGalleryImagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MarketplaceGalleryImagesClient.CreateOrUpdate

ctx := context.TODO()
id := marketplacegalleryimages.NewMarketplaceGalleryImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "marketplaceGalleryImageValue")

payload := marketplacegalleryimages.MarketplaceGalleryImages{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: MarketplaceGalleryImagesClient.Delete

ctx := context.TODO()
id := marketplacegalleryimages.NewMarketplaceGalleryImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "marketplaceGalleryImageValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: MarketplaceGalleryImagesClient.Get

ctx := context.TODO()
id := marketplacegalleryimages.NewMarketplaceGalleryImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "marketplaceGalleryImageValue")

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

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// 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
}

Example Usage: MarketplaceGalleryImagesClient.ListAll

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: MarketplaceGalleryImagesClient.Update

ctx := context.TODO()
id := marketplacegalleryimages.NewMarketplaceGalleryImageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "marketplaceGalleryImageValue")

payload := marketplacegalleryimages.MarketplaceGalleryImagesUpdateRequest{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCloudInitDataSource 

func PossibleValuesForCloudInitDataSource() []string

func PossibleValuesForExtendedLocationTypes 

func PossibleValuesForExtendedLocationTypes() []string

func PossibleValuesForHyperVGeneration 

func PossibleValuesForHyperVGeneration() []string

func PossibleValuesForOperatingSystemTypes 

func PossibleValuesForOperatingSystemTypes() []string

func PossibleValuesForProvisioningStateEnum 

func PossibleValuesForProvisioningStateEnum() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func ValidateMarketplaceGalleryImageID 

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

ValidateMarketplaceGalleryImageID checks that 'input' can be parsed as a Marketplace Gallery Image ID

Types

type CloudInitDataSource 

type CloudInitDataSource string
const (
	CloudInitDataSourceAzure   CloudInitDataSource = "Azure"
	CloudInitDataSourceNoCloud CloudInitDataSource = "NoCloud"
)

func (*CloudInitDataSource) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MarketplaceGalleryImages
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ExtendedLocation 

type ExtendedLocation struct {
	Name *string                `json:"name,omitempty"`
	Type *ExtendedLocationTypes `json:"type,omitempty"`
}

type ExtendedLocationTypes 

type ExtendedLocationTypes string
const (
	ExtendedLocationTypesCustomLocation ExtendedLocationTypes = "CustomLocation"
)

func (*ExtendedLocationTypes) UnmarshalJSON 

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

type GalleryDiskImage 

type GalleryDiskImage struct {
	SizeInMB *int64 `json:"sizeInMB,omitempty"`
}

type GalleryImageIdentifier 

type GalleryImageIdentifier struct {
	Offer     string `json:"offer"`
	Publisher string `json:"publisher"`
	Sku       string `json:"sku"`
}

type GalleryImageVersion 

type GalleryImageVersion struct {
	Name       *string                        `json:"name,omitempty"`
	Properties *GalleryImageVersionProperties `json:"properties,omitempty"`
}

type GalleryImageVersionProperties 

type GalleryImageVersionProperties struct {
	StorageProfile GalleryImageVersionStorageProfile `json:"storageProfile"`
}

type GalleryImageVersionStorageProfile 

type GalleryImageVersionStorageProfile struct {
	OsDiskImage *GalleryDiskImage `json:"osDiskImage,omitempty"`
}

type GetOperationResponse 

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

type HyperVGeneration 

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

func (*HyperVGeneration) UnmarshalJSON 

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

type ListAllCompleteResult 

type ListAllCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MarketplaceGalleryImages
}

type ListAllOperationResponse 

type ListAllOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MarketplaceGalleryImages
}

type ListCompleteResult 

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

type ListOperationResponse 

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

type MarketplaceGalleryImageId 

type MarketplaceGalleryImageId struct {
	SubscriptionId              string
	ResourceGroupName           string
	MarketplaceGalleryImageName string
}

MarketplaceGalleryImageId is a struct representing the Resource ID for a Marketplace Gallery Image

func NewMarketplaceGalleryImageID 

func NewMarketplaceGalleryImageID(subscriptionId string, resourceGroupName string, marketplaceGalleryImageName string) MarketplaceGalleryImageId

NewMarketplaceGalleryImageID returns a new MarketplaceGalleryImageId struct

func ParseMarketplaceGalleryImageID 

func ParseMarketplaceGalleryImageID(input string) (*MarketplaceGalleryImageId, error)

ParseMarketplaceGalleryImageID parses 'input' into a MarketplaceGalleryImageId

func ParseMarketplaceGalleryImageIDInsensitively 

func ParseMarketplaceGalleryImageIDInsensitively(input string) (*MarketplaceGalleryImageId, error)

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

func (*MarketplaceGalleryImageId) FromParseResult 

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

func (MarketplaceGalleryImageId) ID 

func (id MarketplaceGalleryImageId) ID() string

ID returns the formatted Marketplace Gallery Image ID

func (MarketplaceGalleryImageId) Segments 

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

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

func (MarketplaceGalleryImageId) String 

func (id MarketplaceGalleryImageId) String() string

String returns a human-readable description of this Marketplace Gallery Image ID

type MarketplaceGalleryImageProperties 

type MarketplaceGalleryImageProperties struct {
	CloudInitDataSource *CloudInitDataSource           `json:"cloudInitDataSource,omitempty"`
	ContainerId         *string                        `json:"containerId,omitempty"`
	HyperVGeneration    *HyperVGeneration              `json:"hyperVGeneration,omitempty"`
	Identifier          *GalleryImageIdentifier        `json:"identifier,omitempty"`
	OsType              OperatingSystemTypes           `json:"osType"`
	ProvisioningState   *ProvisioningStateEnum         `json:"provisioningState,omitempty"`
	Status              *MarketplaceGalleryImageStatus `json:"status,omitempty"`
	Version             *GalleryImageVersion           `json:"version,omitempty"`
}

type MarketplaceGalleryImageStatus 

type MarketplaceGalleryImageStatus struct {
	DownloadStatus     *MarketplaceGalleryImageStatusDownloadStatus     `json:"downloadStatus,omitempty"`
	ErrorCode          *string                                          `json:"errorCode,omitempty"`
	ErrorMessage       *string                                          `json:"errorMessage,omitempty"`
	ProgressPercentage *int64                                           `json:"progressPercentage,omitempty"`
	ProvisioningStatus *MarketplaceGalleryImageStatusProvisioningStatus `json:"provisioningStatus,omitempty"`
}

type MarketplaceGalleryImageStatusDownloadStatus 

type MarketplaceGalleryImageStatusDownloadStatus struct {
	DownloadSizeInMB *int64 `json:"downloadSizeInMB,omitempty"`
}

type MarketplaceGalleryImageStatusProvisioningStatus 

type MarketplaceGalleryImageStatusProvisioningStatus struct {
	OperationId *string `json:"operationId,omitempty"`
	Status      *Status `json:"status,omitempty"`
}

type MarketplaceGalleryImages 

type MarketplaceGalleryImages struct {
	ExtendedLocation *ExtendedLocation                  `json:"extendedLocation,omitempty"`
	Id               *string                            `json:"id,omitempty"`
	Location         string                             `json:"location"`
	Name             *string                            `json:"name,omitempty"`
	Properties       *MarketplaceGalleryImageProperties `json:"properties,omitempty"`
	SystemData       *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags             *map[string]string                 `json:"tags,omitempty"`
	Type             *string                            `json:"type,omitempty"`
}

type MarketplaceGalleryImagesClient 

type MarketplaceGalleryImagesClient struct {
	Client *resourcemanager.Client
}

func NewMarketplaceGalleryImagesClientWithBaseURI 

func NewMarketplaceGalleryImagesClientWithBaseURI(sdkApi sdkEnv.Api) (*MarketplaceGalleryImagesClient, error)

func (MarketplaceGalleryImagesClient) CreateOrUpdate 

func (c MarketplaceGalleryImagesClient) CreateOrUpdate(ctx context.Context, id MarketplaceGalleryImageId, input MarketplaceGalleryImages) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MarketplaceGalleryImagesClient) CreateOrUpdateThenPoll 

func (c MarketplaceGalleryImagesClient) CreateOrUpdateThenPoll(ctx context.Context, id MarketplaceGalleryImageId, input MarketplaceGalleryImages) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (MarketplaceGalleryImagesClient) Delete 

func (c MarketplaceGalleryImagesClient) Delete(ctx context.Context, id MarketplaceGalleryImageId) (result DeleteOperationResponse, err error)

Delete ...

func (MarketplaceGalleryImagesClient) DeleteThenPoll 

func (c MarketplaceGalleryImagesClient) DeleteThenPoll(ctx context.Context, id MarketplaceGalleryImageId) error

DeleteThenPoll performs Delete then polls until it's completed

func (MarketplaceGalleryImagesClient) Get 

func (c MarketplaceGalleryImagesClient) Get(ctx context.Context, id MarketplaceGalleryImageId) (result GetOperationResponse, err error)

Get ...

func (MarketplaceGalleryImagesClient) List 

func (c MarketplaceGalleryImagesClient) List(ctx context.Context, id commonids.ResourceGroupId) (result ListOperationResponse, err error)

List ...

func (MarketplaceGalleryImagesClient) ListAll 

func (c MarketplaceGalleryImagesClient) ListAll(ctx context.Context, id commonids.SubscriptionId) (result ListAllOperationResponse, err error)

ListAll ...

func (MarketplaceGalleryImagesClient) ListAllComplete 

func (c MarketplaceGalleryImagesClient) ListAllComplete(ctx context.Context, id commonids.SubscriptionId) (ListAllCompleteResult, error)

ListAllComplete retrieves all the results into a single object

func (MarketplaceGalleryImagesClient) ListAllCompleteMatchingPredicate 

func (c MarketplaceGalleryImagesClient) ListAllCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate MarketplaceGalleryImagesOperationPredicate) (result ListAllCompleteResult, err error)

ListAllCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MarketplaceGalleryImagesClient) ListComplete 

func (c MarketplaceGalleryImagesClient) ListComplete(ctx context.Context, id commonids.ResourceGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (MarketplaceGalleryImagesClient) ListCompleteMatchingPredicate 

func (c MarketplaceGalleryImagesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate MarketplaceGalleryImagesOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (MarketplaceGalleryImagesClient) Update 

func (c MarketplaceGalleryImagesClient) Update(ctx context.Context, id MarketplaceGalleryImageId, input MarketplaceGalleryImagesUpdateRequest) (result UpdateOperationResponse, err error)

Update ...

func (MarketplaceGalleryImagesClient) UpdateThenPoll 

func (c MarketplaceGalleryImagesClient) UpdateThenPoll(ctx context.Context, id MarketplaceGalleryImageId, input MarketplaceGalleryImagesUpdateRequest) error

UpdateThenPoll performs Update then polls until it's completed

type MarketplaceGalleryImagesOperationPredicate 

type MarketplaceGalleryImagesOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (MarketplaceGalleryImagesOperationPredicate) Matches 

func (p MarketplaceGalleryImagesOperationPredicate) Matches(input MarketplaceGalleryImages) bool

type MarketplaceGalleryImagesUpdateRequest 

type MarketplaceGalleryImagesUpdateRequest struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type OperatingSystemTypes 

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

func (*OperatingSystemTypes) UnmarshalJSON 

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

type ProvisioningStateEnum 

type ProvisioningStateEnum string
const (
	ProvisioningStateEnumAccepted   ProvisioningStateEnum = "Accepted"
	ProvisioningStateEnumCanceled   ProvisioningStateEnum = "Canceled"
	ProvisioningStateEnumDeleting   ProvisioningStateEnum = "Deleting"
	ProvisioningStateEnumFailed     ProvisioningStateEnum = "Failed"
	ProvisioningStateEnumInProgress ProvisioningStateEnum = "InProgress"
	ProvisioningStateEnumSucceeded  ProvisioningStateEnum = "Succeeded"
)

func (*ProvisioningStateEnum) UnmarshalJSON 

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

type Status 

type Status string
const (
	StatusFailed     Status = "Failed"
	StatusInProgress Status = "InProgress"
	StatusSucceeded  Status = "Succeeded"
)

func (*Status) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MarketplaceGalleryImages
}

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.