containerappsbuilds

package
v0.20241111.1164443 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-02-02-preview/containerappsbuilds Documentation

The containerappsbuilds SDK allows for interaction with Azure Resource Manager containerapps (API Version 2024-02-02-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-sdk/resource-manager/containerapps/2024-02-02-preview/containerappsbuilds"

Client Initialization

client := containerappsbuilds.NewContainerAppsBuildsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerAppsBuildsClient.ByContainerAppList

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

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

Example Usage: ContainerAppsBuildsClient.Delete

ctx := context.TODO()
id := containerappsbuilds.NewContainerAppBuildID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "buildName")

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

Example Usage: ContainerAppsBuildsClient.Get

ctx := context.TODO()
id := containerappsbuilds.NewContainerAppBuildID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerAppName", "buildName")

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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForBuildProvisioningState 

func PossibleValuesForBuildProvisioningState() []string

func PossibleValuesForBuildStatus 

func PossibleValuesForBuildStatus() []string

func ValidateContainerAppBuildID 

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

ValidateContainerAppBuildID checks that 'input' can be parsed as a Container App Build ID

func ValidateContainerAppID 

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

ValidateContainerAppID checks that 'input' can be parsed as a Container App ID

Types

type BuildProvisioningState 

type BuildProvisioningState string
const (
	BuildProvisioningStateCanceled  BuildProvisioningState = "Canceled"
	BuildProvisioningStateCreating  BuildProvisioningState = "Creating"
	BuildProvisioningStateDeleting  BuildProvisioningState = "Deleting"
	BuildProvisioningStateFailed    BuildProvisioningState = "Failed"
	BuildProvisioningStateSucceeded BuildProvisioningState = "Succeeded"
	BuildProvisioningStateUpdating  BuildProvisioningState = "Updating"
)

func (*BuildProvisioningState) UnmarshalJSON 

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

type BuildStatus 

type BuildStatus string
const (
	BuildStatusCanceled   BuildStatus = "Canceled"
	BuildStatusFailed     BuildStatus = "Failed"
	BuildStatusInProgress BuildStatus = "InProgress"
	BuildStatusNotStarted BuildStatus = "NotStarted"
	BuildStatusSucceeded  BuildStatus = "Succeeded"
)

func (*BuildStatus) UnmarshalJSON 

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

type ByContainerAppListCompleteResult 

type ByContainerAppListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ContainerAppsBuildResource
}

type ByContainerAppListCustomPager 

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

type ByContainerAppListOperationResponse 

type ByContainerAppListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContainerAppsBuildResource
}

type ContainerAppBuildId 

type ContainerAppBuildId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
	BuildName         string
}

ContainerAppBuildId is a struct representing the Resource ID for a Container App Build

func NewContainerAppBuildID 

func NewContainerAppBuildID(subscriptionId string, resourceGroupName string, containerAppName string, buildName string) ContainerAppBuildId

NewContainerAppBuildID returns a new ContainerAppBuildId struct

func ParseContainerAppBuildID 

func ParseContainerAppBuildID(input string) (*ContainerAppBuildId, error)

ParseContainerAppBuildID parses 'input' into a ContainerAppBuildId

func ParseContainerAppBuildIDInsensitively 

func ParseContainerAppBuildIDInsensitively(input string) (*ContainerAppBuildId, error)

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

func (*ContainerAppBuildId) FromParseResult 

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

func (ContainerAppBuildId) ID 

func (id ContainerAppBuildId) ID() string

ID returns the formatted Container App Build ID

func (ContainerAppBuildId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Container App Build ID

func (ContainerAppBuildId) String 

func (id ContainerAppBuildId) String() string

String returns a human-readable description of this Container App Build ID

type ContainerAppId 

type ContainerAppId struct {
	SubscriptionId    string
	ResourceGroupName string
	ContainerAppName  string
}

ContainerAppId is a struct representing the Resource ID for a Container App

func NewContainerAppID 

func NewContainerAppID(subscriptionId string, resourceGroupName string, containerAppName string) ContainerAppId

NewContainerAppID returns a new ContainerAppId struct

func ParseContainerAppID 

func ParseContainerAppID(input string) (*ContainerAppId, error)

ParseContainerAppID parses 'input' into a ContainerAppId

func ParseContainerAppIDInsensitively 

func ParseContainerAppIDInsensitively(input string) (*ContainerAppId, error)

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

func (*ContainerAppId) FromParseResult 

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

func (ContainerAppId) ID 

func (id ContainerAppId) ID() string

ID returns the formatted Container App ID

func (ContainerAppId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Container App ID

func (ContainerAppId) String 

func (id ContainerAppId) String() string

String returns a human-readable description of this Container App ID

type ContainerAppsBuildConfiguration 

type ContainerAppsBuildConfiguration struct {
	BaseOs               *string                `json:"baseOs,omitempty"`
	EnvironmentVariables *[]EnvironmentVariable `json:"environmentVariables,omitempty"`
	Platform             *string                `json:"platform,omitempty"`
	PlatformVersion      *string                `json:"platformVersion,omitempty"`
	PreBuildSteps        *[]PreBuildStep        `json:"preBuildSteps,omitempty"`
}

type ContainerAppsBuildProperties 

type ContainerAppsBuildProperties struct {
	BuildStatus                  *BuildStatus                      `json:"buildStatus,omitempty"`
	Configuration                *ContainerAppsBuildConfiguration  `json:"configuration,omitempty"`
	DestinationContainerRegistry *ContainerRegistryWithCustomImage `json:"destinationContainerRegistry,omitempty"`
	LogStreamEndpoint            *string                           `json:"logStreamEndpoint,omitempty"`
	ProvisioningState            *BuildProvisioningState           `json:"provisioningState,omitempty"`
}

type ContainerAppsBuildResource 

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

type ContainerAppsBuildResourceOperationPredicate 

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

func (ContainerAppsBuildResourceOperationPredicate) Matches 

func (p ContainerAppsBuildResourceOperationPredicate) Matches(input ContainerAppsBuildResource) bool

type ContainerAppsBuildsClient 

type ContainerAppsBuildsClient struct {
	Client *resourcemanager.Client
}

func NewContainerAppsBuildsClientWithBaseURI 

func NewContainerAppsBuildsClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerAppsBuildsClient, error)

func (ContainerAppsBuildsClient) ByContainerAppList 

func (c ContainerAppsBuildsClient) ByContainerAppList(ctx context.Context, id ContainerAppId) (result ByContainerAppListOperationResponse, err error)

ByContainerAppList ...

func (ContainerAppsBuildsClient) ByContainerAppListComplete 

func (c ContainerAppsBuildsClient) ByContainerAppListComplete(ctx context.Context, id ContainerAppId) (ByContainerAppListCompleteResult, error)

ByContainerAppListComplete retrieves all the results into a single object

func (ContainerAppsBuildsClient) ByContainerAppListCompleteMatchingPredicate 

func (c ContainerAppsBuildsClient) ByContainerAppListCompleteMatchingPredicate(ctx context.Context, id ContainerAppId, predicate ContainerAppsBuildResourceOperationPredicate) (result ByContainerAppListCompleteResult, err error)

ByContainerAppListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerAppsBuildsClient) Delete 

func (c ContainerAppsBuildsClient) Delete(ctx context.Context, id ContainerAppBuildId) (result DeleteOperationResponse, err error)

Delete ...

func (ContainerAppsBuildsClient) DeleteThenPoll 

func (c ContainerAppsBuildsClient) DeleteThenPoll(ctx context.Context, id ContainerAppBuildId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContainerAppsBuildsClient) Get 

func (c ContainerAppsBuildsClient) Get(ctx context.Context, id ContainerAppBuildId) (result GetOperationResponse, err error)

Get ...

type ContainerRegistryWithCustomImage 

type ContainerRegistryWithCustomImage struct {
	Image  *string `json:"image,omitempty"`
	Server string  `json:"server"`
}

type DeleteOperationResponse 

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

type EnvironmentVariable 

type EnvironmentVariable struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type GetOperationResponse 

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

type HTTPGet 

type HTTPGet struct {
	FileName *string   `json:"fileName,omitempty"`
	Headers  *[]string `json:"headers,omitempty"`
	Url      string    `json:"url"`
}

type PreBuildStep 

type PreBuildStep struct {
	Description *string   `json:"description,omitempty"`
	HTTPGet     *HTTPGet  `json:"httpGet,omitempty"`
	Scripts     *[]string `json:"scripts,omitempty"`
}

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.