galleryapplications

package
v0.20240617.1095803 Latest Latest
Warning

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

Go to latest
Published: Jun 17, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

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

The galleryapplications 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/compute/2022-03-03/galleryapplications"

Client Initialization

client := galleryapplications.NewGalleryApplicationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GalleryApplicationsClient.CreateOrUpdate

ctx := context.TODO()
id := galleryapplications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue", "applicationValue")

payload := galleryapplications.GalleryApplication{
	// ...
}


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

Example Usage: GalleryApplicationsClient.Delete

ctx := context.TODO()
id := galleryapplications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue", "applicationValue")

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

Example Usage: GalleryApplicationsClient.Get

ctx := context.TODO()
id := galleryapplications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue", "applicationValue")

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: GalleryApplicationsClient.ListByGallery

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

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

Example Usage: GalleryApplicationsClient.Update

ctx := context.TODO()
id := galleryapplications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "galleryValue", "applicationValue")

payload := galleryapplications.GalleryApplicationUpdate{
	// ...
}


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 PossibleValuesForGalleryApplicationCustomActionParameterType

func PossibleValuesForGalleryApplicationCustomActionParameterType() []string

func PossibleValuesForOperatingSystemTypes

func PossibleValuesForOperatingSystemTypes() []string

func ValidateApplicationID

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

ValidateApplicationID checks that 'input' can be parsed as a Application ID

Types

type ApplicationId

type ApplicationId struct {
	SubscriptionId    string
	ResourceGroupName string
	GalleryName       string
	ApplicationName   string
}

ApplicationId is a struct representing the Resource ID for a Application

func NewApplicationID

func NewApplicationID(subscriptionId string, resourceGroupName string, galleryName string, applicationName string) ApplicationId

NewApplicationID returns a new ApplicationId struct

func ParseApplicationID

func ParseApplicationID(input string) (*ApplicationId, error)

ParseApplicationID parses 'input' into a ApplicationId

func ParseApplicationIDInsensitively

func ParseApplicationIDInsensitively(input string) (*ApplicationId, error)

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

func (*ApplicationId) FromParseResult

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

func (ApplicationId) ID

func (id ApplicationId) ID() string

ID returns the formatted Application ID

func (ApplicationId) Segments

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

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

func (ApplicationId) String

func (id ApplicationId) String() string

String returns a human-readable description of this Application ID

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GalleryApplication

type GalleryApplication struct {
	Id         *string                       `json:"id,omitempty"`
	Location   string                        `json:"location"`
	Name       *string                       `json:"name,omitempty"`
	Properties *GalleryApplicationProperties `json:"properties,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type GalleryApplicationCustomAction

type GalleryApplicationCustomAction struct {
	Description *string                                    `json:"description,omitempty"`
	Name        string                                     `json:"name"`
	Parameters  *[]GalleryApplicationCustomActionParameter `json:"parameters,omitempty"`
	Script      string                                     `json:"script"`
}

type GalleryApplicationCustomActionParameter

type GalleryApplicationCustomActionParameter struct {
	DefaultValue *string                                      `json:"defaultValue,omitempty"`
	Description  *string                                      `json:"description,omitempty"`
	Name         string                                       `json:"name"`
	Required     *bool                                        `json:"required,omitempty"`
	Type         *GalleryApplicationCustomActionParameterType `json:"type,omitempty"`
}

type GalleryApplicationCustomActionParameterType

type GalleryApplicationCustomActionParameterType string
const (
	GalleryApplicationCustomActionParameterTypeConfigurationDataBlob GalleryApplicationCustomActionParameterType = "ConfigurationDataBlob"
	GalleryApplicationCustomActionParameterTypeLogOutputBlob         GalleryApplicationCustomActionParameterType = "LogOutputBlob"
	GalleryApplicationCustomActionParameterTypeString                GalleryApplicationCustomActionParameterType = "String"
)

func (*GalleryApplicationCustomActionParameterType) UnmarshalJSON

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

type GalleryApplicationOperationPredicate

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

func (GalleryApplicationOperationPredicate) Matches

type GalleryApplicationProperties

type GalleryApplicationProperties struct {
	CustomActions       *[]GalleryApplicationCustomAction `json:"customActions,omitempty"`
	Description         *string                           `json:"description,omitempty"`
	EndOfLifeDate       *string                           `json:"endOfLifeDate,omitempty"`
	Eula                *string                           `json:"eula,omitempty"`
	PrivacyStatementUri *string                           `json:"privacyStatementUri,omitempty"`
	ReleaseNoteUri      *string                           `json:"releaseNoteUri,omitempty"`
	SupportedOSType     OperatingSystemTypes              `json:"supportedOSType"`
}

func (*GalleryApplicationProperties) GetEndOfLifeDateAsTime

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

func (*GalleryApplicationProperties) SetEndOfLifeDateAsTime

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

type GalleryApplicationUpdate

type GalleryApplicationUpdate struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *GalleryApplicationProperties `json:"properties,omitempty"`
	Tags       *map[string]string            `json:"tags,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type GalleryApplicationsClient

type GalleryApplicationsClient struct {
	Client *resourcemanager.Client
}

func NewGalleryApplicationsClientWithBaseURI

func NewGalleryApplicationsClientWithBaseURI(sdkApi sdkEnv.Api) (*GalleryApplicationsClient, error)

func (GalleryApplicationsClient) CreateOrUpdate

CreateOrUpdate ...

func (GalleryApplicationsClient) CreateOrUpdateThenPoll

func (c GalleryApplicationsClient) CreateOrUpdateThenPoll(ctx context.Context, id ApplicationId, input GalleryApplication) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (GalleryApplicationsClient) Delete

Delete ...

func (GalleryApplicationsClient) DeleteThenPoll

func (c GalleryApplicationsClient) DeleteThenPoll(ctx context.Context, id ApplicationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (GalleryApplicationsClient) Get

Get ...

func (GalleryApplicationsClient) ListByGallery

ListByGallery ...

func (GalleryApplicationsClient) ListByGalleryComplete

ListByGalleryComplete retrieves all the results into a single object

func (GalleryApplicationsClient) ListByGalleryCompleteMatchingPredicate

func (c GalleryApplicationsClient) ListByGalleryCompleteMatchingPredicate(ctx context.Context, id commonids.SharedImageGalleryId, predicate GalleryApplicationOperationPredicate) (result ListByGalleryCompleteResult, err error)

ListByGalleryCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GalleryApplicationsClient) Update

Update ...

func (GalleryApplicationsClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse

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

type ListByGalleryCompleteResult

type ListByGalleryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GalleryApplication
}

type ListByGalleryOperationResponse

type ListByGalleryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GalleryApplication
}

type OperatingSystemTypes

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

func (*OperatingSystemTypes) UnmarshalJSON

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

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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